plugin

Documentation

Index

• Constants
• Variables
• func NewNomadPlugin(log hclog.Logger) apm.APM
• type APMPlugin
  • func (a *APMPlugin) PluginInfo() (*base.PluginInfo, error)
  • func (a *APMPlugin) Query(q string, _ sdk.TimeRange) (sdk.TimestampedMetrics, error)
  • func (a *APMPlugin) QueryMultiple(q string, r sdk.TimeRange) ([]sdk.TimestampedMetrics, error)
  • func (a *APMPlugin) SetConfig(config map[string]string) error

Constants

const (
	// queryTypes are the types of query the Nomad APM plugin can handle. Each
	// one has its own path to discovering the correct data and so its
	// important this is included and validated on every query request.
	QueryTypeTaskGroup = "taskgroup"
	QueryTypeNode      = "node"
)

Variables

var (
	PluginID = plugins.PluginID{
		Name:       pluginName,
		PluginType: plugins.PluginTypeAPM,
	}

	PluginConfig = &plugins.InternalPluginConfig{
		Factory: func(l hclog.Logger) interface{} { return NewNomadPlugin(l) },
	}
)

Functions

func NewNomadPlugin

func NewNomadPlugin(log hclog.Logger) apm.APM

Types

type APMPlugin

type APMPlugin struct {
	// contains filtered or unexported fields
}

func (*APMPlugin) PluginInfo

func (a *APMPlugin) PluginInfo() (*base.PluginInfo, error)

func (*APMPlugin) Query

func (a *APMPlugin) Query(q string, _ sdk.TimeRange) (sdk.TimestampedMetrics, error)

Query satisfies the Query function on the apm.APM interface. The Nomad Metrics API doesn't provide historical data, so time range for the query is not used.

func (*APMPlugin) QueryMultiple

func (a *APMPlugin) QueryMultiple(q string, r sdk.TimeRange) ([]sdk.TimestampedMetrics, error)

func (*APMPlugin) SetConfig

func (a *APMPlugin) SetConfig(config map[string]string) error