plugin

Documentation

Index

• type Info
• type Metrics
• type Queries
• type QueriesFlags

Types

type Info

type Info struct {
	Hostname        string
	Port            string
	Distro          string
	Version         string
	DSN             string
	QuerySource     string
	PMMUserPassword string
}

Info describes plugin.

type Metrics

type Metrics interface {
	// Init initializes plugin and returns Info about database.
	Init(ctx context.Context, pmmUserPassword string) (*Info, error)
	// Name of the exporter.
	// As the time of writing this is limited to linux, mysql, mongodb, proxysql and postgresql.
	Name() string
	// Args is a list of additional arguments passed to exporter executable.
	Args() []string
	// Environment is a list of additional environment variables passed to exporter executable.
	Environment() []string
	// Executable is a name of exporter executable under PMMBaseDir.
	Executable() string
	// KV is a list of additional Key-Value data stored in consul.
	KV() map[string][]byte
	// Cluster defines cluster name for the target.
	Cluster() string
	// Multiple returns true if exporter can be added multiple times.
	Multiple() bool
	// DefaultPort returns default port.
	DefaultPort() int
}

Metrics is a common interface for all exporters.

type Queries

type Queries interface {
	// Init initializes plugin and returns Info about database.
	Init(ctx context.Context, pmmUserPassword string) (*Info, error)
	// Name of the queries.
	// As the time of writing this is limited to mysql and mongodb.
	Name() string
	// InstanceTypeName returns name of instance type used by QAN API.
	// Deprecated: QAN API should be modified and use same value as Name().
	InstanceTypeName() string
	// Config returns pc.QAN, this allows for additional configuration of QAN.
	Config() pc.QAN
}

Queries is a common interface for all Query Analytics plugins.

type QueriesFlags

type QueriesFlags struct {
	DisableQueryExamples bool
}

QueriesFlags Queries specific flags.