handler

Documentation

Index

• type Handler

Types

type Handler

type Handler interface {
	// Run should only be used to send metrics or events apart from those being parsed from the transport. For example, this process could send metrics tracking the number of arrived messages and send them to the bus on a time delayed interval
	Run(context.Context, bus.MetricPublishFunc, bus.EventPublishFunc)

	// Returns identification string for a handler
	Identify() string

	// Handle parse incoming messages from the transport and write resulting metrics or events to the corresponding bus. Handlers MUST ensure that labelValues and labelKeys for metrics are always submitted int the same order
	Handle([]byte, bool, bus.MetricPublishFunc, bus.EventPublishFunc) error

	// Config a yaml object from the config file associated with this plugin is passed into this function. The plugin is responsible for handling this data
	Config([]byte) error
}

Handler mangle messages to place on metric bus