govppmux

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: 29 Imported by: 0

Documentation

Overview

Package govppmux implements the GoVPPMux plugin that allows multiple plugins to share a single connection to VPP.

Index

Constants

This section is empty.

Variables

View Source
var DefaultPlugin = *NewPlugin()

DefaultPlugin is default instance of Plugin

Functions

func NewStatsAdapter added in v1.8.1

func NewStatsAdapter(socketName string) adapter.StatsAPI

NewStatsAdapter returns VPP stats API adapter, implemented as pure Go client.

func NewVppAdapter added in v1.4.0

func NewVppAdapter(addr string, useShm bool) adapter.VppAPI

NewVppAdapter returns VPP binary API adapter, implemented as pure Go client.

Types

type API added in v1.0.4

type API interface {
	// VPPInfo returns VPP information which is retrieved immediatelly after connecting to VPP.
	VPPInfo() (VPPInfo, error)

	govppapi.ChannelProvider
}

API for other plugins to get connectivity to VPP.

type Config added in v1.0.5

type Config struct {
	TraceEnabled             bool          `json:"trace-enabled"`
	ReconnectResync          bool          `json:"resync-after-reconnect"`
	HealthCheckProbeInterval time.Duration `json:"health-check-probe-interval"`
	HealthCheckReplyTimeout  time.Duration `json:"health-check-reply-timeout"`
	HealthCheckThreshold     int           `json:"health-check-threshold"`
	ReplyTimeout             time.Duration `json:"reply-timeout"`
	// Connect to VPP for configuration requests via the shared memory instead of through the socket.
	ConnectViaShm bool `json:"connect-via-shm"`
	// The prefix prepended to the name used for shared memory (SHM) segments. If not set,
	// shared memory segments are created directly in the SHM directory /dev/shm.
	ShmPrefix        string `json:"shm-prefix"`
	BinAPISocketPath string `json:"binapi-socket-path"`
	StatsSocketPath  string `json:"stats-socket-path"`
	// How many times can be request resent in case vpp is suddenly disconnected.
	RetryRequestCount int `json:"retry-request-count"`
	// Time between request resend attempts. Default is 500ms.
	RetryRequestTimeout time.Duration `json:"retry-request-timeout"`
	// How many times can be connection request resent in case the vpp is not reachable.
	RetryConnectCount int `json:"retry-connect-count"`
	// Time between connection request resend attempts. Default is 1s.
	RetryConnectTimeout time.Duration `json:"retry-connect-timeout"`
}

Config groups the configurable parameter of GoVpp.

type Deps added in v1.0.2

type Deps struct {
	infra.PluginDeps
	HTTPHandlers rest.HTTPHandlers
	StatusCheck  statuscheck.PluginStatusWriter
	Resync       *resync.Plugin
}

Deps groups injected dependencies of plugin so that they do not mix with other plugin fields.

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

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

Plugin implements the govppmux plugin interface.

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 reports status check.

func (*Plugin) Close added in v1.8.1

func (p *Plugin) Close() error

Close cleans up the resources allocated by the govppmux plugin.

func (*Plugin) DumpStats added in v1.8.1

func (p *Plugin) DumpStats(prefixes ...string) ([]adapter.StatEntry, error)

DumpStats returns all stats with name, type and value

func (*Plugin) GetBufferStats

func (p *Plugin) GetBufferStats(stats *govppapi.BufferStats) error

GetErrorStats retrieves VPP error counters

func (*Plugin) GetErrorStats added in v1.8.1

func (p *Plugin) GetErrorStats(stats *govppapi.ErrorStats) error

GetErrorStats retrieves VPP error counters

func (*Plugin) GetInterfaceStats added in v1.8.1

func (p *Plugin) GetInterfaceStats(stats *govppapi.InterfaceStats) error

GetInterfaceStats retrieves all counters related to the VPP interfaces

func (*Plugin) GetNodeStats added in v1.8.1

func (p *Plugin) GetNodeStats(stats *govppapi.NodeStats) error

GetNodeStats retrieves a list of Node VPP counters (vectors, clocks, ...)

func (*Plugin) GetSystemStats added in v1.8.1

func (p *Plugin) GetSystemStats(stats *govppapi.SystemStats) error

GetSystemStats retrieves system statistics of the connected VPP instance like Vector rate, Input rate, etc.

func (*Plugin) Init added in v1.8.1

func (p *Plugin) Init() (err error)

Init is the entry point called by Agent Core. A single binary-API connection to VPP is established.

func (*Plugin) ListStats added in v1.8.1

func (p *Plugin) ListStats(prefixes ...string) ([]string, error)

ListStats returns all stats names

func (*Plugin) NewAPIChannel added in v1.8.1

func (p *Plugin) NewAPIChannel() (govppapi.Channel, error)

NewAPIChannel returns a new API channel for communication with VPP via govpp core. It uses default buffer sizes for the request and reply Go channels.

Example of binary API call from some plugin using GOVPP:

ch, _ := govpp_mux.NewAPIChannel()
ch.SendRequest(req).ReceiveReply

func (*Plugin) NewAPIChannelBuffered added in v1.8.1

func (p *Plugin) NewAPIChannelBuffered(reqChanBufSize, replyChanBufSize int) (govppapi.Channel, error)

NewAPIChannelBuffered returns a new API channel for communication with VPP via govpp core. It allows to specify custom buffer sizes for the request and reply Go channels.

Example of binary API call from some plugin using GOVPP:

ch, _ := govpp_mux.NewAPIChannelBuffered(100, 100)
ch.SendRequest(req).ReceiveReply

func (*Plugin) VPPInfo

func (p *Plugin) VPPInfo() (VPPInfo, error)

VPPInfo returns information about VPP session.

type Stats

type Stats struct {
	ChannelsCreated uint64
	ChannelsOpen    uint64

	RequestsSent   uint64
	RequestsDone   uint64
	RequestsErrors uint64
	RequestReplies uint64

	Errors metrics.Calls

	AllMessages metrics.CallStats
	Messages    metrics.Calls

	Replies metrics.Calls
}

Stats defines various statistics for govppmux plugin.

func GetStats

func GetStats() *Stats

type StatsAPI added in v1.8.1

type StatsAPI interface {
	API

	govppapi.StatsProvider
}

StatsAPI is extended API with ability to get VPP stats data

type VPPInfo

type VPPInfo struct {
	Connected bool
	vppcalls.VersionInfo
	vppcalls.VpeInfo
}

VPPInfo defines retrieved information about the connected VPP instance.

func (VPPInfo) GetReleaseVersion

func (vpp VPPInfo) GetReleaseVersion() string

GetReleaseVersion returns VPP release version (XX.YY), which is normalized from VersionInfo.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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