mysql

Documentation

Index

• type Config
  • func (c *Config) Validate() error
• type Database
• type Monitor
  • func (am *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"`
	Name string `yaml:"name"`
	// A list of databases along with optional authentication credentials.
	Databases []Database `yaml:"databases" validate:"required"`
	// These credentials serve as defaults for all databases if not overridden
	Username string `yaml:"username"`
	Password string `yaml:"password" neverLog:"true"`
	// A SignalFx extension to the plugin that allows us to disable the normal
	// behavior of the MySQL collectd plugin where the `host` dimension is set
	// to the hostname of the MySQL database server.  When `false` (the
	// recommended and default setting), the globally configured `hostname`
	// config is used instead.
	ReportHost bool `yaml:"reportHost"`
}

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 Database

type Database struct {
	Name     string `yaml:"name" validate:"required"`
	Username string `yaml:"username"`
	Password string `yaml:"password" neverLog:"true"`
}

Database configures a particular MySQL database

type Monitor

type Monitor struct {
	collectd.MonitorCore
}

Monitor is the main type that represents the monitor

func (*Monitor) Configure

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

Configure configures and runs the plugin in collectd