plugins

Documentation

Index

• type Metric
• type Metrics
• type Plugins
  • func New(ctx context.Context) *Plugins
  • func (p *Plugins) Flush(pluginName string) *map[string]interface{}
  • func (p *Plugins) Inventory() []byte
  • func (p *Plugins) IsInternal(pluginName string) bool
  • func (p *Plugins) IsValid(pluginName string) bool
  • func (p *Plugins) Run(pluginName string) error
  • func (p *Plugins) Scan() error
  • func (p *Plugins) Stop() error

Types

type Metric

type Metric struct {
	Type  string      `json:"_type"`
	Value interface{} `json:"_value"`
}

Metric defines an individual metric sample or array of samples (histogram)

type Metrics

type Metrics map[string]Metric

Metrics defines the list of metrics for a given plugin

type Plugins

type Plugins struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

Plugins defines plugin manager

func New

func New(ctx context.Context) *Plugins

New returns a new instance of the plugins manager

func (*Plugins) Flush

func (p *Plugins) Flush(pluginName string) *map[string]interface{}

Flush plugin metrics

func (*Plugins) Inventory

func (p *Plugins) Inventory() []byte

Inventory returns list of active plugins

func (*Plugins) IsInternal

func (p *Plugins) IsInternal(pluginName string) bool

IsInternal checks to see if the plugin is one of the internal plugins (write|statsd)

func (*Plugins) IsValid

func (p *Plugins) IsValid(pluginName string) bool

IsValid determines if a specific plugin is valid

func (*Plugins) Run

func (p *Plugins) Run(pluginName string) error

Run one or all plugins

func (*Plugins) Scan

func (p *Plugins) Scan() error

Scan the plugin directory for new/updated plugins

func (*Plugins) Stop

func (p *Plugins) Stop() error

Stop any long running plugins