metadata

Documentation

Index

• type Config
  • func (c *Config) Validate() error
• type Monitor
  • func (m *Monitor) Configure(conf *Config) error

Types

type Config

type Config struct {
	config.MonitorConfig `singleInstance:"true"`
	WriteServerURL       string `yaml:"writeServerURL"`
	// (Deprecated) Please set the agent configuration `procPath` instead of
	// this monitor configuration option.
	// The path to the proc filesystem. Useful to override in containerized
	// environments.
	ProcFSPath string `yaml:"procFSPath" default:""`
	// (Deprecated) Please set the agent configuration `etcPath` instead of this
	// monitor configuration option.
	// The path to the main host config dir. Useful to override in
	// containerized environments.
	EtcPath string `yaml:"etcPath" default:""`
	// Collect the cpu utilization per core, reported as `cpu.utilization_per_core`.
	PerCoreCPUUtil bool `yaml:"perCoreCPUUtil"`
	// A directory where the metadata plugin can persist the history of
	// successful host metadata syncs so that host metadata is not sent
	// redundantly.
	PersistencePath string `yaml:"persistencePath" default:"/var/run/signalfx-agent"`
	// If true, process "top" information will not be sent.  This can be useful
	// if you have an extremely high number of processes and performance of the
	// plugin is poor.
	OmitProcessInfo bool `yaml:"omitProcessInfo"`
	// Set this to a non-zero value to enable the DogStatsD listener as part of
	// this monitor.  The listener will accept metrics on the DogStatsD format,
	// and sends them as SignalFx datapoints to our backend.  Setting to a value
	// setting the `DogStatsDPort` to `0` will result in a random port assignment.
	// **Note: The listener emits directly to SignalFx and will not be subject to
	// filters configured with the SignalFx Smart Agent.  Internal stats about the
	// SignalFx Smart Agent will not reflect datapoints set through the DogStatsD listener**
	DogStatsDPort *uint `yaml:"dogStatsDPort"`
	// This is only required when running the DogStatsD listener.  Set this to
	// your SignalFx access token.
	Token string `yaml:"token" neverLog:"true"`
	// Optionally override the default ip that the DogStatsD listener listens
	// on.  (**default**: "0.0.0.0")
	DogStatsDIP string `yaml:"dogStatsDIP"`
	// This is optional only used when running the DogStatsD listener.
	// By default the DogStatsD listener will emit to SignalFx Ingest.
	// (**default**: "https://ingest.signalfx.com")
	IngestEndpoint string `yaml:"ingestEndpoint"`
	// Set this to enable verbose logging from the monitor
	Verbose bool `yaml:"verbose"`
}

Config is the monitor-specific config with the generic config embedded

func (*Config) Validate

func (c *Config) Validate() error

Validate will check the config for correctness.

type Monitor

type Monitor struct {
	collectd.MonitorCore
}

Monitor is the main type that represents the monitor

func (*Monitor) Configure

func (m *Monitor) Configure(conf *Config) error

Configure configures and runs the plugin in collectd