telemetry

package
v2.5.1+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 6, 2019 License: Apache-2.0 Imports: 24 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var DefaultPlugin = *NewPlugin()

DefaultPlugin is default instance of Plugin

Functions

This section is empty.

Types

type Config added in v1.5.1

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
	GoVppmux     govppmux.StatsAPI
	Prometheus   prom.API
	GRPC         grpc.Server
}

Deps represents dependencies of Telemetry Plugin

type Option added in v1.8.1

type Option func(*Plugin)

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

func UseDeps added in v1.8.1

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 added in v1.8.1

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

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL