config

Documentation

Index

• type Agent
  • func (a Agent) Validate() error
• type AgentDescription
• type Capabilities
  • func (c Capabilities) SupportedCapabilities() protobufs.AgentCapabilities
• type Logs
• type OpAMPServer
  • func (o OpAMPServer) Validate() error
• type Storage
• type Supervisor
  • func DefaultSupervisor() Supervisor
  • func Load(configFile string) (Supervisor, error)
  • func (s Supervisor) Validate() error
• type Telemetry

Types

type Agent

type Agent struct {
	Executable              string
	OrphanDetectionInterval time.Duration    `mapstructure:"orphan_detection_interval"`
	Description             AgentDescription `mapstructure:"description"`
	BootstrapTimeout        time.Duration    `mapstructure:"bootstrap_timeout"`
	HealthCheckPort         int              `mapstructure:"health_check_port"`
}

func (Agent) Validate

func (a Agent) Validate() error

type AgentDescription

type AgentDescription struct {
	IdentifyingAttributes    map[string]string `mapstructure:"identifying_attributes"`
	NonIdentifyingAttributes map[string]string `mapstructure:"non_identifying_attributes"`
}

type Capabilities

type Capabilities struct {
	AcceptsRemoteConfig            bool `mapstructure:"accepts_remote_config"`
	AcceptsRestartCommand          bool `mapstructure:"accepts_restart_command"`
	AcceptsOpAMPConnectionSettings bool `mapstructure:"accepts_opamp_connection_settings"`
	ReportsEffectiveConfig         bool `mapstructure:"reports_effective_config"`
	ReportsOwnMetrics              bool `mapstructure:"reports_own_metrics"`
	ReportsHealth                  bool `mapstructure:"reports_health"`
	ReportsRemoteConfig            bool `mapstructure:"reports_remote_config"`
}

Capabilities is the set of capabilities that the Supervisor supports.

func (Capabilities) SupportedCapabilities

func (c Capabilities) SupportedCapabilities() protobufs.AgentCapabilities

type Logs

type Logs struct {
	Level       zapcore.Level `mapstructure:"level"`
	OutputPaths []string      `mapstructure:"output_paths"`
}

type OpAMPServer

type OpAMPServer struct {
	Endpoint   string
	Headers    http.Header
	TLSSetting configtls.ClientConfig `mapstructure:"tls,omitempty"`
}

func (OpAMPServer) Validate

func (o OpAMPServer) Validate() error

type Storage

type Storage struct {
	// Directory is the directory where the Supervisor will store its data.
	Directory string `mapstructure:"directory"`
}

type Supervisor

type Supervisor struct {
	Server       OpAMPServer
	Agent        Agent
	Capabilities Capabilities `mapstructure:"capabilities"`
	Storage      Storage      `mapstructure:"storage"`
	Telemetry    Telemetry    `mapstructure:"telemetry"`
}

Supervisor is the Supervisor config file format.

func DefaultSupervisor

func DefaultSupervisor() Supervisor

DefaultSupervisor returns the default supervisor config

func Load

func Load(configFile string) (Supervisor, error)

Load loads the Supervisor config from a file.

func (Supervisor) Validate

func (s Supervisor) Validate() error

type Telemetry

type Telemetry struct {
	// TODO: Add more telemetry options
	// Issue here: https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/35582
	Logs Logs `mapstructure:"logs"`
}