status

Documentation

Overview

Package status is a generated protocol buffer package.

Package status provides data model for status information of the agent.

It is generated from these files:

status.proto

It has these top-level messages:

AgentStatus
PluginStatus
InterfaceStats

Index

• Constants
• Variables
• func AgentStatusKey() string
• func PluginStatusKey(pluginLabel string) string
• type AgentStatus
  • func (m *AgentStatus) GetInterfaceStats() *InterfaceStats
  • func (*AgentStatus) ProtoMessage()
  • func (m *AgentStatus) Reset()
  • func (m *AgentStatus) String() string
• type InterfaceStats
  • func (m *InterfaceStats) GetInterfaces() []*InterfaceStats_Interface
  • func (*InterfaceStats) ProtoMessage()
  • func (m *InterfaceStats) Reset()
  • func (m *InterfaceStats) String() string
• type InterfaceStats_Interface
  • func (*InterfaceStats_Interface) ProtoMessage()
  • func (m *InterfaceStats_Interface) Reset()
  • func (m *InterfaceStats_Interface) String() string
• type OperationalState
  • func (x OperationalState) String() string
• type PluginStatus
  • func (*PluginStatus) ProtoMessage()
  • func (m *PluginStatus) Reset()
  • func (m *PluginStatus) String() string

Constants

const (
	// StatusPrefix is the relative key prefix for the agent/plugin status.
	StatusPrefix = "check/status/v1/"
	// AgentStatusPrefix is the relative key prefix for the agent status,
	// filtering out statuses of individual plugins.
	AgentStatusPrefix = StatusPrefix + "agent"
)

Variables

var OperationalState_name = map[int32]string{
	0: "INIT",
	1: "OK",
	2: "ERROR",
}

var OperationalState_value = map[string]int32{
	"INIT":  0,
	"OK":    1,
	"ERROR": 2,
}

Functions

func AgentStatusKey

func AgentStatusKey() string

AgentStatusKey returns the key used in ETCD to store the operational status of the vpp agent instance.

func PluginStatusKey

func PluginStatusKey(pluginLabel string) string

PluginStatusKey returns the key used in ETCD to store the operational status of the vpp agent plugin.

Types

type AgentStatus

type AgentStatus struct {
	BuildVersion   string           `protobuf:"bytes,1,opt,name=build_version,proto3" json:"build_version,omitempty"`
	BuildDate      string           `protobuf:"bytes,2,opt,name=build_date,proto3" json:"build_date,omitempty"`
	State          OperationalState `protobuf:"varint,3,opt,name=state,proto3,enum=status.OperationalState" json:"state,omitempty"`
	StartTime      int64            `protobuf:"varint,4,opt,name=start_time,proto3" json:"start_time,omitempty"`
	LastChange     int64            `protobuf:"varint,5,opt,name=last_change,proto3" json:"last_change,omitempty"`
	LastUpdate     int64            `protobuf:"varint,6,opt,name=last_update,proto3" json:"last_update,omitempty"`
	InterfaceStats *InterfaceStats  `protobuf:"bytes,7,opt,name=interface_stats" json:"interface_stats,omitempty"`
	CommitHash     string           `protobuf:"bytes,8,opt,name=commit_hash,proto3" json:"commit_hash,omitempty"`
}

func (*AgentStatus) GetInterfaceStats

func (m *AgentStatus) GetInterfaceStats() *InterfaceStats

func (*AgentStatus) ProtoMessage

func (*AgentStatus) ProtoMessage()

func (*AgentStatus) Reset

func (m *AgentStatus) Reset()

func (*AgentStatus) String

func (m *AgentStatus) String() string

type InterfaceStats

type InterfaceStats struct {
	Interfaces []*InterfaceStats_Interface `protobuf:"bytes,1,rep,name=interfaces" json:"interfaces,omitempty"`
}

func (*InterfaceStats) GetInterfaces

func (m *InterfaceStats) GetInterfaces() []*InterfaceStats_Interface

func (*InterfaceStats) ProtoMessage

func (*InterfaceStats) ProtoMessage()

func (*InterfaceStats) Reset

func (m *InterfaceStats) Reset()

func (*InterfaceStats) String

func (m *InterfaceStats) String() string

type InterfaceStats_Interface

type InterfaceStats_Interface struct {
	InternalName string `protobuf:"bytes,1,opt,name=internal_name,proto3" json:"internal_name,omitempty"`
	Index        uint32 `protobuf:"varint,3,opt,name=index,proto3" json:"index,omitempty"`
	Status       string `protobuf:"bytes,4,opt,name=status,proto3" json:"status,omitempty"`
	IpAddress    string `protobuf:"bytes,5,opt,name=ip_address,proto3" json:"ip_address,omitempty"`
	MacAddress   string `protobuf:"bytes,6,opt,name=mac_address,proto3" json:"mac_address,omitempty"`
}

func (*InterfaceStats_Interface) ProtoMessage

func (*InterfaceStats_Interface) ProtoMessage()

func (*InterfaceStats_Interface) Reset

func (m *InterfaceStats_Interface) Reset()

func (*InterfaceStats_Interface) String

func (m *InterfaceStats_Interface) String() string

type OperationalState

type OperationalState int32

const (
	OperationalState_INIT  OperationalState = 0
	OperationalState_OK    OperationalState = 1
	OperationalState_ERROR OperationalState = 2
)

func (OperationalState) String

func (x OperationalState) String() string

type PluginStatus

type PluginStatus struct {
	State      OperationalState `protobuf:"varint,1,opt,name=state,proto3,enum=status.OperationalState" json:"state,omitempty"`
	LastChange int64            `protobuf:"varint,4,opt,name=last_change,proto3" json:"last_change,omitempty"`
	LastUpdate int64            `protobuf:"varint,5,opt,name=last_update,proto3" json:"last_update,omitempty"`
	Error      string           `protobuf:"bytes,6,opt,name=error,proto3" json:"error,omitempty"`
}

func (*PluginStatus) ProtoMessage

func (*PluginStatus) ProtoMessage()

func (*PluginStatus) Reset

func (m *PluginStatus) Reset()

func (*PluginStatus) String

func (m *PluginStatus) String() string