plugins

Documentation

Index

• Variables
• func Add(name string, creator Creator)
• type Accumulator
• type Creator
• type MockPlugin
  • func (m *MockPlugin) Gather(_a0 Accumulator) error
• type Plugin
• type ServicePlugin

Variables

var Plugins = map[string]Creator{}

Functions

func Add

func Add(name string, creator Creator)

Types

type Accumulator

type Accumulator interface {
	// Create a point with a value, decorating it with tags
	// NOTE: tags is expected to be owned by the caller, don't mutate
	// it after passing to Add.
	Add(measurement string,
		value interface{},
		tags map[string]string,
		t ...time.Time)

	AddFields(measurement string,
		fields map[string]interface{},
		tags map[string]string,
		t ...time.Time)
}

type Creator

type Creator func() Plugin

type MockPlugin

type MockPlugin struct {
	mock.Mock
}

func (*MockPlugin) Gather

func (m *MockPlugin) Gather(_a0 Accumulator) error

type Plugin

type Plugin interface {
	// SampleConfig returns the default configuration of the Plugin
	SampleConfig() string

	// Description returns a one-sentence description on the Plugin
	Description() string

	// Gather takes in an accumulator and adds the metrics that the Plugin
	// gathers. This is called every "interval"
	Gather(Accumulator) error
}

type ServicePlugin

type ServicePlugin interface {
	// SampleConfig returns the default configuration of the Plugin
	SampleConfig() string

	// Description returns a one-sentence description on the Plugin
	Description() string

	// Gather takes in an accumulator and adds the metrics that the Plugin
	// gathers. This is called every "interval"
	Gather(Accumulator) error

	// Start starts the ServicePlugin's service, whatever that may be
	Start() error

	// Stop stops the services and closes any necessary channels and connections
	Stop()
}