telemetry

Documentation

Index

• Variables
• type Config
• type Deps
• type InterfaceIndexProvider
• type Option
  • func UseDeps(cb func(*Deps)) Option
• type Plugin
  • func NewPlugin(opts ...Option) *Plugin
  • func (p *Plugin) AfterInit() error
  • func (p *Plugin) Close() error
  • func (p *Plugin) Init() error
  • func (s *Plugin) PollStats(req *configurator.PollStatsRequest, ...) error

Variables

var DefaultPlugin = *NewPlugin()

DefaultPlugin is default instance of Plugin

Types

type Config

type Config struct {
	// Custom polling interval, default value is 30s
	PollingInterval time.Duration `json:"polling-interval"`
	// Allows to disable plugin
	Disabled bool `json:"disabled"`
	// Allows to export prometheus in telemetry plugin
	PrometheusDisabled bool `json:"prometheus-disabled"`
	// Skip collecting some of the metrics:
	// 	runtime, memory, buffers, nodes, interfaces
	Skipped []string `json:"skipped"`
}

Config file representation for telemetry plugin

type Deps

type Deps struct {
	infra.PluginDeps
	ServiceLabel servicelabel.ReaderAPI
	VPP          govppmux.API
	Prometheus   prom.API
	GRPC         grpc.Server
	HTTPHandlers rest.HTTPHandlers
	IfPlugin     InterfaceIndexProvider
}

Deps represents dependencies of Telemetry Plugin

type InterfaceIndexProvider

type InterfaceIndexProvider interface {
	// GetInterfaceIndex gives read-only access to map with metadata of all configured
	// VPP interfaces.
	GetInterfaceIndex() ifaceidx.IfaceMetadataIndex
}

type Option

type Option func(*Plugin)

Option is a function that acts on a Plugin to inject Dependencies or configuration

func UseDeps

func UseDeps(cb func(*Deps)) Option

UseDeps returns Option that can inject custom dependencies.

type Plugin

type Plugin struct {
	Deps
	// contains filtered or unexported fields
}

Plugin registers Telemetry Plugin

func NewPlugin

func NewPlugin(opts ...Option) *Plugin

NewPlugin creates a new Plugin with the provides Options

func (*Plugin) AfterInit

func (p *Plugin) AfterInit() error

AfterInit executes after initializion of Telemetry Plugin

func (*Plugin) Close

func (p *Plugin) Close() error

Close is used to clean up resources used by Telemetry Plugin

func (*Plugin) Init

func (p *Plugin) Init() error

Init initializes Telemetry Plugin

func (*Plugin) PollStats

func (s *Plugin) PollStats(req *configurator.PollStatsRequest, svr configurator.StatsPollerService_PollStatsServer) error