statsclient

Documentation

Overview

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

Index

• Constants
• Variables
• type StatsClient
  • func NewStatsClient(sockAddr string) *StatsClient
  • func (c *StatsClient) Connect() error
  • func (c *StatsClient) Disconnect() error
  • func (c *StatsClient) DumpStats(patterns ...string) (entries []adapter.StatEntry, err error)
  • func (c *StatsClient) DumpVPCStats(vni ...uint64) (entries []adapter.StatEntry, err error)
  • func (c *StatsClient) GetVPCStats(stats []adapter.StatEntry, vni ...uint64) (map[uint64]*VPCCounter, error)
  • func (c *StatsClient) ListStats(patterns ...string) (names []string, err error)
  • func (c *StatsClient) PrepareDir(patterns ...string) (*adapter.StatDir, error)
  • func (c *StatsClient) UpdateDir(dir *adapter.StatDir) (err error)
• type VPCCounter

Constants

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

Variables

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

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

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

var (
	ErrStatDataLenIncorrect = fmt.Errorf("stat data length incorrect")
)

Types

type StatsClient

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

StatsClient is the pure Go implementation for VPP stats API.

func NewStatsClient

func NewStatsClient(sockAddr string) *StatsClient

NewStatsClient returns new VPP stats API client.

func (*StatsClient) Connect

func (c *StatsClient) Connect() error

func (*StatsClient) Disconnect

func (c *StatsClient) Disconnect() error

func (*StatsClient) DumpStats

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

func (*StatsClient) DumpVPCStats

func (c *StatsClient) DumpVPCStats(vni ...uint64) (entries []adapter.StatEntry, err error)

func (*StatsClient) GetVPCStats

func (c *StatsClient) GetVPCStats(stats []adapter.StatEntry, vni ...uint64) (map[uint64]*VPCCounter, error)

GetVPCStats returns the summed statistical value of each thread

func (*StatsClient) ListStats

func (c *StatsClient) ListStats(patterns ...string) (names []string, err error)

func (*StatsClient) PrepareDir

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

func (*StatsClient) UpdateDir

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

type VPCCounter

type VPCCounter struct {
	InBytes    uint64 `json:"in_bytes"`
	InPackets  uint64 `json:"in_packets"`
	OutBytes   uint64 `json:"out_bytes"`
	OutPackets uint64 `json:"out_packets"`
}