elasticsearch

Documentation

Index

• type Config
  • func (c *Config) PythonConfig() *python.Config
• 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"`
	// AdditionalMetrics to report on
	AdditionalMetrics []string `yaml:"additionalMetrics"`
	// Cluster name to which the node belongs. This is an optional config that
	// will override the cluster name fetched from a node and will be used to
	// populate the plugin_instance dimension
	Cluster string `yaml:"cluster"`
	// DetailedMetrics turns on additional metric time series
	DetailedMetrics *bool `yaml:"detailedMetrics" default:"true"`
	// EnableClusterHealth enables reporting on the cluster health
	EnableClusterHealth *bool `yaml:"enableClusterHealth" default:"true"`
	// EnableIndexStats reports metrics about indexes
	EnableIndexStats *bool `yaml:"enableIndexStats" default:"true"`
	// Indexes to report on
	Indexes []string `yaml:"indexes" default:"[\"_all\"]"`
	// IndexInterval is an interval in seconds at which the plugin will report index stats.
	// It must be greater than or equal, and divisible by the Interval configuration
	IndexInterval *uint `yaml:"indexInterval" default:"300"`
	// IndexStatsMasterOnly sends index stats from the master only
	IndexStatsMasterOnly *bool `yaml:"indexStatsMasterOnly" default:"false"`
	IndexSummaryOnly     *bool `yaml:"indexSummaryOnly" default:"false"`
	// Password used to access elasticsearch stats api
	Password string `yaml:"password" neverLog:"true"`
	// Protocol used to connect: http or https
	Protocol string `yaml:"protocol"`
	// ThreadPools to report on
	ThreadPools []string `yaml:"threadPools" default:"[\"search\", \"index\"]"`
	// Username used to access elasticsearch stats api
	Username string `yaml:"username"`
	Version  string `yaml:"version"`
	// 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

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