solarwindsapmsettingsextension

README

Solarwinds APM Settings extension

Status
Stability	development
Distributions	[]
Issues
Code Owners	@jerrytfleung, @cheempz

Overview

The Solarwinds APM Settings extension gets Solarwinds APM specific settings from Solarwinds APM collector and /tmp/solarwinds-apm-settings.json periodically.

Configuration

Example:

extensions:
  solarwindsapmsettings:
    endpoint: "<endpoint>"
    key: "<token>:<name>"
    interval: 10s

endpoint (Required)

The APM collector endpoint which this extension calls getSettings. See here for our APM collector endpoints. The endpoint is in format <host>:<port>.

key (Required)

The service key in format <token>:<name> for getSettings from Solarwinds APM collector. See here for configuring a service key.

interval (Optional)

Periodic interval to get Solarwinds APM specific settings from Solarwinds APM collector.

Minimum value: 5s

Maximum value: 60s

Value that is outside the boundary will be bounded to either the minimum or maximum value.

Default: 10s

Documentation

Overview

Package solarwindsapmsettingsextension

Index

• Constants
• func NewFactory() extension.Factory
• type Config
  • func (cfg *Config) Validate() error

Constants

const (
	DefaultEndpoint = "apm.collector.na-01.cloud.solarwinds.com:443"
	DefaultInterval = time.Duration(10) * time.Second
	MinimumInterval = time.Duration(5) * time.Second
	MaximumInterval = time.Duration(60) * time.Second
)

Functions

func NewFactory

func NewFactory() extension.Factory

Types

type Config

type Config struct {
	ClientConfig configgrpc.ClientConfig `mapstructure:",squash"`
	Key          string                  `mapstructure:"key"`
	Interval     time.Duration           `mapstructure:"interval"`
}

func (*Config) Validate

func (cfg *Config) Validate() error