couchbase

Documentation

Index

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

Types

type Config

type Config struct {
	config.MonitorConfig `yaml:",inline" acceptsEndpoints:"true"`

	Host string `yaml:"host" validate:"required"`
	Port uint16 `yaml:"port" validate:"required"`
	// Define what this Module block will monitor: "NODE", for a Couchbase node,
	// or "BUCKET" for a Couchbase bucket.
	CollectTarget string `yaml:"collectTarget" validate:"required"`
	// If CollectTarget is "BUCKET", CollectBucket specifies the name of the
	// bucket that this will monitor.
	CollectBucket string `yaml:"collectBucket"`
	// Name of this Couchbase cluster. (**default**:"default")
	ClusterName string `yaml:"clusterName"`
	// Change to "detailed" to collect all available metrics from Couchbase
	// stats API. Defaults to "default", collecting a curated set that works
	// well with SignalFx. See [metric_info.py](https://github.com/signalfx/collectd-couchbase/blob/master/metric_info.py) for more information.
	CollectMode string `yaml:"collectMode"`
	// Username to authenticate with
	Username string `yaml:"username"`
	// Password to authenticate with
	Password string `yaml:"password" neverLog:"true"`
	// contains filtered or unexported fields
}

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

func (*Config) PythonConfig

func (c *Config) PythonConfig() *python.Config

PythonConfig returns the embedded python.Config struct from the interface

func (*Config) Validate

func (c *Config) Validate() error

Validate will check the config for correctness.

type Monitor

type Monitor struct {
	python.PyMonitor
}

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