statsclient

Documentation

Overview

Package statsclient is pure Go implementation of VPP stats API client.

Index

• Constants
• Variables
• type Option
  • func SetSocketRetryPeriod(t time.Duration) Option
  • func SetSocketRetryTimeout(t time.Duration) Option
• type StatsClient
  • func NewStatsClient(socket string, options ...Option) *StatsClient
  • func (sc *StatsClient) Connect() (err error)
  • func (sc *StatsClient) Disconnect() error
  • func (sc *StatsClient) DumpStats(patterns ...string) (entries []adapter.StatEntry, err error)
  • func (sc *StatsClient) ListStats(patterns ...string) (entries []adapter.StatIdentifier, err error)
  • func (sc *StatsClient) PrepareDir(patterns ...string) (*adapter.StatDir, error)
  • func (sc *StatsClient) PrepareDirOnIndex(indexes ...uint32) (*adapter.StatDir, error)
  • func (sc *StatsClient) UpdateDir(dir *adapter.StatDir) (err error)

Constants

const (
	// DefaultSocketName is default VPP stats socket file path.
	DefaultSocketName = adapter.DefaultStatsSocket

	// DefaultSocketRetryPeriod is the time period after the socket availability
	// will be re-checked
	DefaultSocketRetryPeriod = 50 * time.Millisecond

	// DefaultSocketRetryTimeout is the maximum time for the stats socket
	DefaultSocketRetryTimeout = 3 * time.Second
)

Variables

var (
	MaxWaitInProgress    = time.Millisecond * 100
	CheckDelayInProgress = time.Microsecond * 10
)

var (
	// Debug is global variable that determines debug mode
	Debug = os.Getenv("DEBUG_GOVPP_STATS") != ""

	// Log is global logger
	Log = logger.New()
)

var (
	// ErrStatDataLenIncorrect is returned when stat data does not match vector
	// length of a respective data directory
	ErrStatDataLenIncorrect = fmt.Errorf("stat data length incorrect")
)

Types

type Option

type Option func(*StatsClient)

Option is a StatsClient option

func SetSocketRetryPeriod

func SetSocketRetryPeriod(t time.Duration) Option

SetSocketRetryPeriod is and optional parameter to define a custom retry period while waiting for the VPP socket

func SetSocketRetryTimeout

func SetSocketRetryTimeout(t time.Duration) Option

SetSocketRetryTimeout is and optional parameter to define a custom timeout while waiting for the VPP socket

type StatsClient

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

StatsClient is the pure Go implementation for VPP stats API.

func NewStatsClient

func NewStatsClient(socket string, options ...Option) *StatsClient

NewStatsClient returns a new StatsClient using socket. If socket is empty string DefaultSocketName is used.

func (*StatsClient) Connect

func (sc *StatsClient) Connect() (err error)

Connect to validated VPP stats socket and start monitoring socket file changes

func (*StatsClient) Disconnect

func (sc *StatsClient) Disconnect() error

Disconnect from the socket, unmap shared memory and terminate socket monitor

func (*StatsClient) DumpStats

func (sc *StatsClient) DumpStats(patterns ...string) (entries []adapter.StatEntry, err error)

func (*StatsClient) ListStats

func (sc *StatsClient) ListStats(patterns ...string) (entries []adapter.StatIdentifier, err error)

func (*StatsClient) PrepareDir

func (sc *StatsClient) PrepareDir(patterns ...string) (*adapter.StatDir, error)

func (*StatsClient) PrepareDirOnIndex

func (sc *StatsClient) PrepareDirOnIndex(indexes ...uint32) (*adapter.StatDir, error)

func (*StatsClient) UpdateDir

func (sc *StatsClient) UpdateDir(dir *adapter.StatDir) (err error)

UpdateDir refreshes directory data for all counters