Skip to content

Latest commit

 

History

History

opampextension

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
internal/metadata
internal/metadata
 
 
testdata
testdata
 
 
Makefile
Makefile
 
 
README.md
README.md
 
 
config.go
config.go
 
 
config_test.go
config_test.go
 
 
doc.go
doc.go
 
 
factory.go
factory.go
 
 
factory_test.go
factory_test.go
 
 
generated_component_test.go
generated_component_test.go
 
 
generated_package_test.go
generated_package_test.go
 
 
go.mod
go.mod
 
 
go.sum
go.sum
 
 
logger.go
logger.go
 
 
metadata.yaml
metadata.yaml
 
 
monitor_ppid.go
monitor_ppid.go
 
 
monitor_ppid_test.go
monitor_ppid_test.go
 
 
opamp_agent.go
opamp_agent.go
 
 
opamp_agent_test.go
opamp_agent_test.go
 
 
registry.go
registry.go
 
 
registry_test.go
registry_test.go
 
 

README.md

OpAMP Agent Extension

Status
Stability alpha
Distributions contrib
Issues Open issues Closed issues
Code Owners @portertech, @evan-bradley, @tigrannajaryan

Configuration

The following settings are required:

  • server: The OpAMP server connection settings.
    • ws: The OpAMP websocket transport settings.
      • endpoint (no default): The OpAMP server websocket endpoint (URL).

The following settings are optional:

  • server: The OpAMP server connection settings.
    • ws: The OpAMP websocket transport settings.
      • tls: TLS settings.
      • headers: HTTP headers to set.
  • instance_uid: A ULID formatted as a 26 character string in canonical representation. Auto-generated on start if missing. Setting this ensures the instance UID remains constant across process restarts.
  • capabilities: Keys with boolean true/false values that enable a particular OpAMP capability.
    • reports_effective_config: Whether to enable the OpAMP ReportsEffectiveConfig capability. Default is true.
  • agent_description: Setting that modifies the agent description reported to the OpAMP server.
    • non_identifying_attributes: A map of key value pairs that will be added to the non-identifying attributes reported to the OpAMP server. If an attribute collides with the default non-identifying attributes that are automatically added, the ones specified here take precedence.
  • ppid: An optional process ID to monitor. When this process is no longer running, the extension will emit a fatal error, causing the collector to exit. This is meant to be set by the Supervisor or some other parent process, and should not be configured manually.
  • ppid_poll_interval: The poll interval between check for whether ppid is still alive or not. Defaults to 5 seconds.

Example

extensions:
  opamp:
    server:
      ws:
        endpoint: wss:https://127.0.0.1:4320/v1/opamp

Custom Messages

Other components may use a configured OpAMP extension to send and receive custom messages to and from an OpAMP server.

See the opampcustommessages module for more information on the custom message API.

Status

This OpenTelemetry OpAMP agent extension is intended to support the OpAMP Supervisor.