telemetry

package
v1.32.1 Latest Latest
Warning

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

 Go to latest Published: Oct 7, 2024 License: MIT Imports: 8 Imported by: 8

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	ReturnCode_name = map[int32]string{
		0: "SUCCESS",
		1: "NO_SUBSCRIPTION_ENTRY",
		2: "UNKNOWN_ERROR",
	}
	ReturnCode_value = map[string]int32{
		"SUCCESS":               0,
		"NO_SUBSCRIPTION_ENTRY": 1,
		"UNKNOWN_ERROR":         2,
	}
)

Enum value maps for ReturnCode.

View Source 
var (
	VerbosityLevel_name = map[int32]string{
		0: "DETAIL",
		1: "TERSE",
		2: "BRIEF",
	}
	VerbosityLevel_value = map[string]int32{
		"DETAIL": 0,
		"TERSE":  1,
		"BRIEF":  2,
	}
)

Enum value maps for VerbosityLevel.

View Source 
var (
	EncodingType_name = map[int32]string{
		0: "UNDEFINED",
		1: "XML",
		2: "JSON_IETF",
		3: "PROTO3",
	}
	EncodingType_value = map[string]int32{
		"UNDEFINED": 0,
		"XML":       1,
		"JSON_IETF": 2,
		"PROTO3":    3,
	}
)

Enum value maps for EncodingType.

View Source 
var File_oc_oc_proto protoreflect.FileDescriptor
View Source 
var OpenConfigTelemetry_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "telemetry.OpenConfigTelemetry",
	HandlerType: (*OpenConfigTelemetryServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "cancelTelemetrySubscription",
			Handler:    _OpenConfigTelemetry_CancelTelemetrySubscription_Handler,
		},
		{
			MethodName: "getTelemetrySubscriptions",
			Handler:    _OpenConfigTelemetry_GetTelemetrySubscriptions_Handler,
		},
		{
			MethodName: "getTelemetryOperationalState",
			Handler:    _OpenConfigTelemetry_GetTelemetryOperationalState_Handler,
		},
		{
			MethodName: "getDataEncodings",
			Handler:    _OpenConfigTelemetry_GetDataEncodings_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "telemetrySubscribe",
			Handler:       _OpenConfigTelemetry_TelemetrySubscribe_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "oc/oc.proto",
}

OpenConfigTelemetry_ServiceDesc is the grpc.ServiceDesc for OpenConfigTelemetry service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterOpenConfigTelemetryServer 

func RegisterOpenConfigTelemetryServer(s grpc.ServiceRegistrar, srv OpenConfigTelemetryServer)

Types

type CancelSubscriptionReply 

type CancelSubscriptionReply struct {

	// Return code
	Code ReturnCode `protobuf:"varint,1,opt,name=code,proto3,enum=telemetry.ReturnCode" json:"code,omitempty"`
	// Return code string
	CodeStr string `protobuf:"bytes,2,opt,name=code_str,json=codeStr,proto3" json:"code_str,omitempty"`
	// contains filtered or unexported fields
}

Reply to telemetry subscription cancellation request

func (*CancelSubscriptionReply) Descriptor deprecated 

func (*CancelSubscriptionReply) Descriptor() ([]byte, []int)

Deprecated: Use CancelSubscriptionReply.ProtoReflect.Descriptor instead.

func (*CancelSubscriptionReply) GetCode 

func (x *CancelSubscriptionReply) GetCode() ReturnCode

func (*CancelSubscriptionReply) GetCodeStr 

func (x *CancelSubscriptionReply) GetCodeStr() string

func (*CancelSubscriptionReply) ProtoMessage 

func (*CancelSubscriptionReply) ProtoMessage()

func (*CancelSubscriptionReply) ProtoReflect added in v1.20.4 

func (x *CancelSubscriptionReply) ProtoReflect() protoreflect.Message

func (*CancelSubscriptionReply) Reset 

func (x *CancelSubscriptionReply) Reset()

func (*CancelSubscriptionReply) String 

func (x *CancelSubscriptionReply) String() string

type CancelSubscriptionRequest 

type CancelSubscriptionRequest struct {

	// Subscription identifier as returned by the device when
	// subscription was requested
	SubscriptionId uint32 `protobuf:"varint,1,opt,name=subscription_id,json=subscriptionId,proto3" json:"subscription_id,omitempty"`
	// contains filtered or unexported fields
}

Message sent for a telemetry subscription cancellation request

func (*CancelSubscriptionRequest) Descriptor deprecated 

func (*CancelSubscriptionRequest) Descriptor() ([]byte, []int)

Deprecated: Use CancelSubscriptionRequest.ProtoReflect.Descriptor instead.

func (*CancelSubscriptionRequest) GetSubscriptionId 

func (x *CancelSubscriptionRequest) GetSubscriptionId() uint32

func (*CancelSubscriptionRequest) ProtoMessage 

func (*CancelSubscriptionRequest) ProtoMessage()

func (*CancelSubscriptionRequest) ProtoReflect added in v1.20.4 

func (x *CancelSubscriptionRequest) ProtoReflect() protoreflect.Message

func (*CancelSubscriptionRequest) Reset 

func (x *CancelSubscriptionRequest) Reset()

func (*CancelSubscriptionRequest) String 

func (x *CancelSubscriptionRequest) String() string

type Collector 

type Collector struct {

	// IP address of collector endpoint
	Address string `protobuf:"bytes,1,opt,name=address,proto3" json:"address,omitempty"`
	// Transport protocol port number for the collector destination.
	Port uint32 `protobuf:"varint,2,opt,name=port,proto3" json:"port,omitempty"`
	// contains filtered or unexported fields
}

Collector endpoints to send data specified as an ip+port combination.

func (*Collector) Descriptor deprecated 

func (*Collector) Descriptor() ([]byte, []int)

Deprecated: Use Collector.ProtoReflect.Descriptor instead.

func (*Collector) GetAddress 

func (x *Collector) GetAddress() string

func (*Collector) GetPort 

func (x *Collector) GetPort() uint32

func (*Collector) ProtoMessage 

func (*Collector) ProtoMessage()

func (*Collector) ProtoReflect added in v1.20.4 

func (x *Collector) ProtoReflect() protoreflect.Message

func (*Collector) Reset 

func (x *Collector) Reset()

func (*Collector) String 

func (x *Collector) String() string

type DataEncodingReply 

type DataEncodingReply struct {
	EncodingList []EncodingType `` /* 133-byte string literal not displayed */
	// contains filtered or unexported fields
}

Reply to data encodings supported request

func (*DataEncodingReply) Descriptor deprecated 

func (*DataEncodingReply) Descriptor() ([]byte, []int)

Deprecated: Use DataEncodingReply.ProtoReflect.Descriptor instead.

func (*DataEncodingReply) GetEncodingList 

func (x *DataEncodingReply) GetEncodingList() []EncodingType

func (*DataEncodingReply) ProtoMessage 

func (*DataEncodingReply) ProtoMessage()

func (*DataEncodingReply) ProtoReflect added in v1.20.4 

func (x *DataEncodingReply) ProtoReflect() protoreflect.Message

func (*DataEncodingReply) Reset 

func (x *DataEncodingReply) Reset()

func (*DataEncodingReply) String 

func (x *DataEncodingReply) String() string

type DataEncodingRequest 

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

Message sent for a data encoding request

func (*DataEncodingRequest) Descriptor deprecated 

func (*DataEncodingRequest) Descriptor() ([]byte, []int)

Deprecated: Use DataEncodingRequest.ProtoReflect.Descriptor instead.

func (*DataEncodingRequest) ProtoMessage 

func (*DataEncodingRequest) ProtoMessage()

func (*DataEncodingRequest) ProtoReflect added in v1.20.4 

func (x *DataEncodingRequest) ProtoReflect() protoreflect.Message

func (*DataEncodingRequest) Reset 

func (x *DataEncodingRequest) Reset()

func (*DataEncodingRequest) String 

func (x *DataEncodingRequest) String() string

type Delete 

type Delete struct {
	Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
	// contains filtered or unexported fields
}

Message indicating delete for a particular path

func (*Delete) Descriptor deprecated 

func (*Delete) Descriptor() ([]byte, []int)

Deprecated: Use Delete.ProtoReflect.Descriptor instead.

func (*Delete) GetPath 

func (x *Delete) GetPath() string

func (*Delete) ProtoMessage 

func (*Delete) ProtoMessage()

func (*Delete) ProtoReflect added in v1.20.4 

func (x *Delete) ProtoReflect() protoreflect.Message

func (*Delete) Reset 

func (x *Delete) Reset()

func (*Delete) String 

func (x *Delete) String() string

type EncodingType 

type EncodingType int32

Encoding Type Supported 

const (
	EncodingType_UNDEFINED EncodingType = 0
	EncodingType_XML       EncodingType = 1
	EncodingType_JSON_IETF EncodingType = 2
	EncodingType_PROTO3    EncodingType = 3
)

func (EncodingType) Descriptor added in v1.20.4 

func (EncodingType) Descriptor() protoreflect.EnumDescriptor

func (EncodingType) Enum added in v1.20.4 

func (x EncodingType) Enum() *EncodingType

func (EncodingType) EnumDescriptor deprecated 

func (EncodingType) EnumDescriptor() ([]byte, []int)

Deprecated: Use EncodingType.Descriptor instead.

func (EncodingType) Number added in v1.20.4 

func (x EncodingType) Number() protoreflect.EnumNumber

func (EncodingType) String 

func (x EncodingType) String() string

func (EncodingType) Type added in v1.20.4 

func (EncodingType) Type() protoreflect.EnumType

type Eom 

type Eom struct {
	Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
	// contains filtered or unexported fields
}

Message indicating EOM for a particular path

func (*Eom) Descriptor deprecated 

func (*Eom) Descriptor() ([]byte, []int)

Deprecated: Use Eom.ProtoReflect.Descriptor instead.

func (*Eom) GetPath 

func (x *Eom) GetPath() string

func (*Eom) ProtoMessage 

func (*Eom) ProtoMessage()

func (*Eom) ProtoReflect added in v1.20.4 

func (x *Eom) ProtoReflect() protoreflect.Message

func (*Eom) Reset 

func (x *Eom) Reset()

func (*Eom) String 

func (x *Eom) String() string

type GetOperationalStateReply 

type GetOperationalStateReply struct {

	// List of key-value pairs where
	//     key      = operational state definition
	//     value    = operational state value
	Kv []*KeyValue `protobuf:"bytes,1,rep,name=kv,proto3" json:"kv,omitempty"`
	// contains filtered or unexported fields
}

Reply to telemetry agent operational states request

func (*GetOperationalStateReply) Descriptor deprecated 

func (*GetOperationalStateReply) Descriptor() ([]byte, []int)

Deprecated: Use GetOperationalStateReply.ProtoReflect.Descriptor instead.

func (*GetOperationalStateReply) GetKv 

func (x *GetOperationalStateReply) GetKv() []*KeyValue

func (*GetOperationalStateReply) ProtoMessage 

func (*GetOperationalStateReply) ProtoMessage()

func (*GetOperationalStateReply) ProtoReflect added in v1.20.4 

func (x *GetOperationalStateReply) ProtoReflect() protoreflect.Message

func (*GetOperationalStateReply) Reset 

func (x *GetOperationalStateReply) Reset()

func (*GetOperationalStateReply) String 

func (x *GetOperationalStateReply) String() string

type GetOperationalStateRequest 

type GetOperationalStateRequest struct {

	// Per-subscription_id level operational state can be requested.
	//
	// Subscription identifier as returned by the device when
	// subscription was requested
	// --- or ---
	// 0xFFFFFFFF for all subscription identifiers including agent-level
	// operational stats
	// --- or ---
	// If subscription_id is not present then sent only agent-level
	// operational stats
	SubscriptionId uint32 `protobuf:"varint,1,opt,name=subscription_id,json=subscriptionId,proto3" json:"subscription_id,omitempty"`
	// Control verbosity of the output
	Verbosity VerbosityLevel `protobuf:"varint,2,opt,name=verbosity,proto3,enum=telemetry.VerbosityLevel" json:"verbosity,omitempty"`
	// contains filtered or unexported fields
}

Message sent for telemetry agent operational states request

func (*GetOperationalStateRequest) Descriptor deprecated 

func (*GetOperationalStateRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetOperationalStateRequest.ProtoReflect.Descriptor instead.

func (*GetOperationalStateRequest) GetSubscriptionId 

func (x *GetOperationalStateRequest) GetSubscriptionId() uint32

func (*GetOperationalStateRequest) GetVerbosity 

func (x *GetOperationalStateRequest) GetVerbosity() VerbosityLevel

func (*GetOperationalStateRequest) ProtoMessage 

func (*GetOperationalStateRequest) ProtoMessage()

func (*GetOperationalStateRequest) ProtoReflect added in v1.20.4 

func (x *GetOperationalStateRequest) ProtoReflect() protoreflect.Message

func (*GetOperationalStateRequest) Reset 

func (x *GetOperationalStateRequest) Reset()

func (*GetOperationalStateRequest) String 

func (x *GetOperationalStateRequest) String() string

type GetSubscriptionsReply 

type GetSubscriptionsReply struct {

	// List of current telemetry subscriptions
	SubscriptionList []*SubscriptionReply `protobuf:"bytes,1,rep,name=subscription_list,json=subscriptionList,proto3" json:"subscription_list,omitempty"`
	// contains filtered or unexported fields
}

Reply to telemetry subscription get request

func (*GetSubscriptionsReply) Descriptor deprecated 

func (*GetSubscriptionsReply) Descriptor() ([]byte, []int)

Deprecated: Use GetSubscriptionsReply.ProtoReflect.Descriptor instead.

func (*GetSubscriptionsReply) GetSubscriptionList 

func (x *GetSubscriptionsReply) GetSubscriptionList() []*SubscriptionReply

func (*GetSubscriptionsReply) ProtoMessage 

func (*GetSubscriptionsReply) ProtoMessage()

func (*GetSubscriptionsReply) ProtoReflect added in v1.20.4 

func (x *GetSubscriptionsReply) ProtoReflect() protoreflect.Message

func (*GetSubscriptionsReply) Reset 

func (x *GetSubscriptionsReply) Reset()

func (*GetSubscriptionsReply) String 

func (x *GetSubscriptionsReply) String() string

type GetSubscriptionsRequest 

type GetSubscriptionsRequest struct {

	// Subscription identifier as returned by the device when
	// subscription was requested
	// --- or ---
	// 0xFFFFFFFF for all subscription identifiers
	SubscriptionId uint32 `protobuf:"varint,1,opt,name=subscription_id,json=subscriptionId,proto3" json:"subscription_id,omitempty"`
	// contains filtered or unexported fields
}

Message sent for a telemetry get request

func (*GetSubscriptionsRequest) Descriptor deprecated 

func (*GetSubscriptionsRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetSubscriptionsRequest.ProtoReflect.Descriptor instead.

func (*GetSubscriptionsRequest) GetSubscriptionId 

func (x *GetSubscriptionsRequest) GetSubscriptionId() uint32

func (*GetSubscriptionsRequest) ProtoMessage 

func (*GetSubscriptionsRequest) ProtoMessage()

func (*GetSubscriptionsRequest) ProtoReflect added in v1.20.4 

func (x *GetSubscriptionsRequest) ProtoReflect() protoreflect.Message

func (*GetSubscriptionsRequest) Reset 

func (x *GetSubscriptionsRequest) Reset()

func (*GetSubscriptionsRequest) String 

func (x *GetSubscriptionsRequest) String() string

type KeyValue 

type KeyValue struct {

	// Key
	Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	// One of possible values
	//
	// Types that are assignable to Value:
	//	*KeyValue_DoubleValue
	//	*KeyValue_IntValue
	//	*KeyValue_UintValue
	//	*KeyValue_SintValue
	//	*KeyValue_BoolValue
	//	*KeyValue_StrValue
	//	*KeyValue_BytesValue
	Value isKeyValue_Value `protobuf_oneof:"value"`
	// contains filtered or unexported fields
}

Simple Key-value, where value could be one of scalar types

func (*KeyValue) Descriptor deprecated 

func (*KeyValue) Descriptor() ([]byte, []int)

Deprecated: Use KeyValue.ProtoReflect.Descriptor instead.

func (*KeyValue) GetBoolValue 

func (x *KeyValue) GetBoolValue() bool

func (*KeyValue) GetBytesValue 

func (x *KeyValue) GetBytesValue() []byte

func (*KeyValue) GetDoubleValue 

func (x *KeyValue) GetDoubleValue() float64

func (*KeyValue) GetIntValue 

func (x *KeyValue) GetIntValue() int64

func (*KeyValue) GetKey 

func (x *KeyValue) GetKey() string

func (*KeyValue) GetSintValue 

func (x *KeyValue) GetSintValue() int64

func (*KeyValue) GetStrValue 

func (x *KeyValue) GetStrValue() string

func (*KeyValue) GetUintValue 

func (x *KeyValue) GetUintValue() uint64

func (*KeyValue) GetValue 

func (m *KeyValue) GetValue() isKeyValue_Value

func (*KeyValue) ProtoMessage 

func (*KeyValue) ProtoMessage()

func (*KeyValue) ProtoReflect added in v1.20.4 

func (x *KeyValue) ProtoReflect() protoreflect.Message

func (*KeyValue) Reset 

func (x *KeyValue) Reset()

func (*KeyValue) String 

func (x *KeyValue) String() string

type KeyValue_BoolValue 

type KeyValue_BoolValue struct {
	BoolValue bool `protobuf:"varint,9,opt,name=bool_value,json=boolValue,proto3,oneof"`
}

type KeyValue_BytesValue 

type KeyValue_BytesValue struct {
	BytesValue []byte `protobuf:"bytes,11,opt,name=bytes_value,json=bytesValue,proto3,oneof"`
}

type KeyValue_DoubleValue 

type KeyValue_DoubleValue struct {
	DoubleValue float64 `protobuf:"fixed64,5,opt,name=double_value,json=doubleValue,proto3,oneof"`
}

type KeyValue_IntValue 

type KeyValue_IntValue struct {
	IntValue int64 `protobuf:"varint,6,opt,name=int_value,json=intValue,proto3,oneof"`
}

type KeyValue_SintValue 

type KeyValue_SintValue struct {
	SintValue int64 `protobuf:"zigzag64,8,opt,name=sint_value,json=sintValue,proto3,oneof"`
}

type KeyValue_StrValue 

type KeyValue_StrValue struct {
	StrValue string `protobuf:"bytes,10,opt,name=str_value,json=strValue,proto3,oneof"`
}

type KeyValue_UintValue 

type KeyValue_UintValue struct {
	UintValue uint64 `protobuf:"varint,7,opt,name=uint_value,json=uintValue,proto3,oneof"`
}

type OpenConfigData 

type OpenConfigData struct {

	// router name:export IP address
	SystemId string `protobuf:"bytes,1,opt,name=system_id,json=systemId,proto3" json:"system_id,omitempty"`
	// line card / RE (slot number)
	ComponentId uint32 `protobuf:"varint,2,opt,name=component_id,json=componentId,proto3" json:"component_id,omitempty"`
	// PFE (if applicable)
	SubComponentId uint32 `protobuf:"varint,3,opt,name=sub_component_id,json=subComponentId,proto3" json:"sub_component_id,omitempty"`
	// Path specification for elements of OpenConfig data models
	Path string `protobuf:"bytes,4,opt,name=path,proto3" json:"path,omitempty"`
	// Sequence number, monotonically increasing for each
	// system_id, component_id, sub_component_id + path.
	SequenceNumber uint64 `protobuf:"varint,5,opt,name=sequence_number,json=sequenceNumber,proto3" json:"sequence_number,omitempty"`
	// timestamp (milliseconds since epoch)
	Timestamp uint64 `protobuf:"varint,6,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	// List of key-value pairs
	Kv []*KeyValue `protobuf:"bytes,7,rep,name=kv,proto3" json:"kv,omitempty"`
	// For delete. If filled, it indicates delete
	Delete []*Delete `protobuf:"bytes,8,rep,name=delete,proto3" json:"delete,omitempty"`
	// If filled, it indicates end of marker for the
	// respective path in the list.
	Eom []*Eom `protobuf:"bytes,9,rep,name=eom,proto3" json:"eom,omitempty"`
	// If filled, it indicates end of sync for complete subscription
	SyncResponse bool `protobuf:"varint,10,opt,name=sync_response,json=syncResponse,proto3" json:"sync_response,omitempty"`
	// contains filtered or unexported fields
}
  1. Telemetry data send back on the same connection as the subscription request.

func (*OpenConfigData) Descriptor deprecated 

func (*OpenConfigData) Descriptor() ([]byte, []int)

Deprecated: Use OpenConfigData.ProtoReflect.Descriptor instead.

func (*OpenConfigData) GetComponentId 

func (x *OpenConfigData) GetComponentId() uint32

func (*OpenConfigData) GetDelete 

func (x *OpenConfigData) GetDelete() []*Delete

func (*OpenConfigData) GetEom 

func (x *OpenConfigData) GetEom() []*Eom

func (*OpenConfigData) GetKv 

func (x *OpenConfigData) GetKv() []*KeyValue

func (*OpenConfigData) GetPath 

func (x *OpenConfigData) GetPath() string

func (*OpenConfigData) GetSequenceNumber 

func (x *OpenConfigData) GetSequenceNumber() uint64

func (*OpenConfigData) GetSubComponentId 

func (x *OpenConfigData) GetSubComponentId() uint32

func (*OpenConfigData) GetSyncResponse 

func (x *OpenConfigData) GetSyncResponse() bool

func (*OpenConfigData) GetSystemId 

func (x *OpenConfigData) GetSystemId() string

func (*OpenConfigData) GetTimestamp 

func (x *OpenConfigData) GetTimestamp() uint64

func (*OpenConfigData) ProtoMessage 

func (*OpenConfigData) ProtoMessage()

func (*OpenConfigData) ProtoReflect added in v1.20.4 

func (x *OpenConfigData) ProtoReflect() protoreflect.Message

func (*OpenConfigData) Reset 

func (x *OpenConfigData) Reset()

func (*OpenConfigData) String 

func (x *OpenConfigData) String() string

type OpenConfigTelemetryClient 

type OpenConfigTelemetryClient interface {
	// Request an inline subscription for data at the specified path.
	// The device should send telemetry data back on the same
	// connection as the subscription request.
	TelemetrySubscribe(ctx context.Context, in *SubscriptionRequest, opts ...grpc.CallOption) (OpenConfigTelemetry_TelemetrySubscribeClient, error)
	// Terminates and removes an existing telemetry subscription
	CancelTelemetrySubscription(ctx context.Context, in *CancelSubscriptionRequest, opts ...grpc.CallOption) (*CancelSubscriptionReply, error)
	// Get the list of current telemetry subscriptions from the
	// target. This command returns a list of existing subscriptions
	// not including those that are established via configuration.
	GetTelemetrySubscriptions(ctx context.Context, in *GetSubscriptionsRequest, opts ...grpc.CallOption) (*GetSubscriptionsReply, error)
	// Get Telemetry Agent Operational States
	GetTelemetryOperationalState(ctx context.Context, in *GetOperationalStateRequest, opts ...grpc.CallOption) (*GetOperationalStateReply, error)
	// Return the set of data encodings supported by the device for
	// telemetry data
	GetDataEncodings(ctx context.Context, in *DataEncodingRequest, opts ...grpc.CallOption) (*DataEncodingReply, error)
}

OpenConfigTelemetryClient is the client API for OpenConfigTelemetry service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewOpenConfigTelemetryClient 

func NewOpenConfigTelemetryClient(cc grpc.ClientConnInterface) OpenConfigTelemetryClient

type OpenConfigTelemetryServer 

type OpenConfigTelemetryServer interface {
	// Request an inline subscription for data at the specified path.
	// The device should send telemetry data back on the same
	// connection as the subscription request.
	TelemetrySubscribe(*SubscriptionRequest, OpenConfigTelemetry_TelemetrySubscribeServer) error
	// Terminates and removes an existing telemetry subscription
	CancelTelemetrySubscription(context.Context, *CancelSubscriptionRequest) (*CancelSubscriptionReply, error)
	// Get the list of current telemetry subscriptions from the
	// target. This command returns a list of existing subscriptions
	// not including those that are established via configuration.
	GetTelemetrySubscriptions(context.Context, *GetSubscriptionsRequest) (*GetSubscriptionsReply, error)
	// Get Telemetry Agent Operational States
	GetTelemetryOperationalState(context.Context, *GetOperationalStateRequest) (*GetOperationalStateReply, error)
	// Return the set of data encodings supported by the device for
	// telemetry data
	GetDataEncodings(context.Context, *DataEncodingRequest) (*DataEncodingReply, error)
	// contains filtered or unexported methods
}

OpenConfigTelemetryServer is the server API for OpenConfigTelemetry service. All implementations must embed UnimplementedOpenConfigTelemetryServer for forward compatibility

type OpenConfigTelemetry_TelemetrySubscribeClient 

type OpenConfigTelemetry_TelemetrySubscribeClient interface {
	Recv() (*OpenConfigData, error)
	grpc.ClientStream
}

type OpenConfigTelemetry_TelemetrySubscribeServer 

type OpenConfigTelemetry_TelemetrySubscribeServer interface {
	Send(*OpenConfigData) error
	grpc.ServerStream
}

type Path 

type Path struct {

	// Data model path of interest
	// Path specification for elements of OpenConfig data models
	Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
	// Regular expression to be used in filtering state leaves
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// If this is set to true, the target device will only send
	// updates to the collector upon a change in data value
	SuppressUnchanged bool `protobuf:"varint,3,opt,name=suppress_unchanged,json=suppressUnchanged,proto3" json:"suppress_unchanged,omitempty"`
	// Maximum time in ms the target device may go without sending
	// a message to the collector. If this time expires with
	// suppress-unchanged set, the target device must send an update
	// message regardless if the data values have changed.
	MaxSilentInterval uint32 `protobuf:"varint,4,opt,name=max_silent_interval,json=maxSilentInterval,proto3" json:"max_silent_interval,omitempty"`
	// Time in ms between collection and transmission of the
	// specified data to the collector platform. The target device
	// will sample the corresponding data (e.g,. a counter) and
	// immediately send to the collector destination.
	//
	// If sample-frequency is set to 0, then the network device
	// must emit an update upon every datum change.
	SampleFrequency uint32 `protobuf:"varint,5,opt,name=sample_frequency,json=sampleFrequency,proto3" json:"sample_frequency,omitempty"`
	// EOM needed for each walk cycle of this path?
	//   For periodic sensor, applicable for each complete reap
	//   For event sensor, applicable when initial dump is over
	//     (same as EOS)
	// This feature is not implemented currently.
	NeedEom bool `protobuf:"varint,6,opt,name=need_eom,json=needEom,proto3" json:"need_eom,omitempty"`
	// contains filtered or unexported fields
}

Data model path

func (*Path) Descriptor deprecated 

func (*Path) Descriptor() ([]byte, []int)

Deprecated: Use Path.ProtoReflect.Descriptor instead.

func (*Path) GetFilter 

func (x *Path) GetFilter() string

func (*Path) GetMaxSilentInterval 

func (x *Path) GetMaxSilentInterval() uint32

func (*Path) GetNeedEom 

func (x *Path) GetNeedEom() bool

func (*Path) GetPath 

func (x *Path) GetPath() string

func (*Path) GetSampleFrequency 

func (x *Path) GetSampleFrequency() uint32

func (*Path) GetSuppressUnchanged 

func (x *Path) GetSuppressUnchanged() bool

func (*Path) ProtoMessage 

func (*Path) ProtoMessage()

func (*Path) ProtoReflect added in v1.20.4 

func (x *Path) ProtoReflect() protoreflect.Message

func (*Path) Reset 

func (x *Path) Reset()

func (*Path) String 

func (x *Path) String() string

type ReturnCode 

type ReturnCode int32

Result of the operation 

const (
	ReturnCode_SUCCESS               ReturnCode = 0
	ReturnCode_NO_SUBSCRIPTION_ENTRY ReturnCode = 1
	ReturnCode_UNKNOWN_ERROR         ReturnCode = 2
)

func (ReturnCode) Descriptor added in v1.20.4 

func (ReturnCode) Descriptor() protoreflect.EnumDescriptor

func (ReturnCode) Enum added in v1.20.4 

func (x ReturnCode) Enum() *ReturnCode

func (ReturnCode) EnumDescriptor deprecated 

func (ReturnCode) EnumDescriptor() ([]byte, []int)

Deprecated: Use ReturnCode.Descriptor instead.

func (ReturnCode) Number added in v1.20.4 

func (x ReturnCode) Number() protoreflect.EnumNumber

func (ReturnCode) String 

func (x ReturnCode) String() string

func (ReturnCode) Type added in v1.20.4 

func (ReturnCode) Type() protoreflect.EnumType

type SubscriptionAdditionalConfig 

type SubscriptionAdditionalConfig struct {

	// limit the number of records sent in the stream
	LimitRecords int32 `protobuf:"varint,1,opt,name=limit_records,json=limitRecords,proto3" json:"limit_records,omitempty"`
	// limit the time the stream remains open
	LimitTimeSeconds int32 `protobuf:"varint,2,opt,name=limit_time_seconds,json=limitTimeSeconds,proto3" json:"limit_time_seconds,omitempty"`
	// EOS needed for this subscription?
	NeedEos bool `protobuf:"varint,3,opt,name=need_eos,json=needEos,proto3" json:"need_eos,omitempty"`
	// contains filtered or unexported fields
}

Configure subscription request additional features.

func (*SubscriptionAdditionalConfig) Descriptor deprecated 

func (*SubscriptionAdditionalConfig) Descriptor() ([]byte, []int)

Deprecated: Use SubscriptionAdditionalConfig.ProtoReflect.Descriptor instead.

func (*SubscriptionAdditionalConfig) GetLimitRecords 

func (x *SubscriptionAdditionalConfig) GetLimitRecords() int32

func (*SubscriptionAdditionalConfig) GetLimitTimeSeconds 

func (x *SubscriptionAdditionalConfig) GetLimitTimeSeconds() int32

func (*SubscriptionAdditionalConfig) GetNeedEos 

func (x *SubscriptionAdditionalConfig) GetNeedEos() bool

func (*SubscriptionAdditionalConfig) ProtoMessage 

func (*SubscriptionAdditionalConfig) ProtoMessage()

func (*SubscriptionAdditionalConfig) ProtoReflect added in v1.20.4 

func (x *SubscriptionAdditionalConfig) ProtoReflect() protoreflect.Message

func (*SubscriptionAdditionalConfig) Reset 

func (x *SubscriptionAdditionalConfig) Reset()

func (*SubscriptionAdditionalConfig) String 

func (x *SubscriptionAdditionalConfig) String() string

type SubscriptionInput 

type SubscriptionInput struct {

	// List of optional collector endpoints to send data for
	// this subscription.
	// If no collector destinations are specified, the collector
	// destination is assumed to be the requester on the rpc channel.
	CollectorList []*Collector `protobuf:"bytes,1,rep,name=collector_list,json=collectorList,proto3" json:"collector_list,omitempty"`
	// contains filtered or unexported fields
}

Data associated with a telemetry subscription

func (*SubscriptionInput) Descriptor deprecated 

func (*SubscriptionInput) Descriptor() ([]byte, []int)

Deprecated: Use SubscriptionInput.ProtoReflect.Descriptor instead.

func (*SubscriptionInput) GetCollectorList 

func (x *SubscriptionInput) GetCollectorList() []*Collector

func (*SubscriptionInput) ProtoMessage 

func (*SubscriptionInput) ProtoMessage()

func (*SubscriptionInput) ProtoReflect added in v1.20.4 

func (x *SubscriptionInput) ProtoReflect() protoreflect.Message

func (*SubscriptionInput) Reset 

func (x *SubscriptionInput) Reset()

func (*SubscriptionInput) String 

func (x *SubscriptionInput) String() string

type SubscriptionReply 

type SubscriptionReply struct {

	// Response message to a telemetry subscription creation or
	// get request.
	Response *SubscriptionResponse `protobuf:"bytes,1,opt,name=response,proto3" json:"response,omitempty"`
	// List of data models paths and filters
	// which are used in a telemetry operation.
	PathList []*Path `protobuf:"bytes,2,rep,name=path_list,json=pathList,proto3" json:"path_list,omitempty"`
	// contains filtered or unexported fields
}

1. Reply data message sent out using out-of-band channel.

func (*SubscriptionReply) Descriptor deprecated 

func (*SubscriptionReply) Descriptor() ([]byte, []int)

Deprecated: Use SubscriptionReply.ProtoReflect.Descriptor instead.

func (*SubscriptionReply) GetPathList 

func (x *SubscriptionReply) GetPathList() []*Path

func (*SubscriptionReply) GetResponse 

func (x *SubscriptionReply) GetResponse() *SubscriptionResponse

func (*SubscriptionReply) ProtoMessage 

func (*SubscriptionReply) ProtoMessage()

func (*SubscriptionReply) ProtoReflect added in v1.20.4 

func (x *SubscriptionReply) ProtoReflect() protoreflect.Message

func (*SubscriptionReply) Reset 

func (x *SubscriptionReply) Reset()

func (*SubscriptionReply) String 

func (x *SubscriptionReply) String() string

type SubscriptionRequest 

type SubscriptionRequest struct {

	// Data associated with a telemetry subscription
	Input *SubscriptionInput `protobuf:"bytes,1,opt,name=input,proto3" json:"input,omitempty"`
	// List of data models paths and filters
	// which are used in a telemetry operation.
	PathList []*Path `protobuf:"bytes,2,rep,name=path_list,json=pathList,proto3" json:"path_list,omitempty"`
	// The below configuration is not defined in Openconfig RPC.
	// It is a proposed extension to configure additional
	// subscription request features.
	AdditionalConfig *SubscriptionAdditionalConfig `protobuf:"bytes,3,opt,name=additional_config,json=additionalConfig,proto3" json:"additional_config,omitempty"`
	// contains filtered or unexported fields
}

Message sent for a telemetry subscription request

func (*SubscriptionRequest) Descriptor deprecated 

func (*SubscriptionRequest) Descriptor() ([]byte, []int)

Deprecated: Use SubscriptionRequest.ProtoReflect.Descriptor instead.

func (*SubscriptionRequest) GetAdditionalConfig 

func (x *SubscriptionRequest) GetAdditionalConfig() *SubscriptionAdditionalConfig

func (*SubscriptionRequest) GetInput 

func (x *SubscriptionRequest) GetInput() *SubscriptionInput

func (*SubscriptionRequest) GetPathList 

func (x *SubscriptionRequest) GetPathList() []*Path

func (*SubscriptionRequest) ProtoMessage 

func (*SubscriptionRequest) ProtoMessage()

func (*SubscriptionRequest) ProtoReflect added in v1.20.4 

func (x *SubscriptionRequest) ProtoReflect() protoreflect.Message

func (*SubscriptionRequest) Reset 

func (x *SubscriptionRequest) Reset()

func (*SubscriptionRequest) String 

func (x *SubscriptionRequest) String() string

type SubscriptionResponse 

type SubscriptionResponse struct {

	// Unique id for the subscription on the device. This is
	// generated by the device and returned in a subscription
	// request or when listing existing subscriptions
	SubscriptionId uint32 `protobuf:"varint,1,opt,name=subscription_id,json=subscriptionId,proto3" json:"subscription_id,omitempty"`
	// contains filtered or unexported fields
}

Response message to a telemetry subscription creation or get request.

func (*SubscriptionResponse) Descriptor deprecated 

func (*SubscriptionResponse) Descriptor() ([]byte, []int)

Deprecated: Use SubscriptionResponse.ProtoReflect.Descriptor instead.

func (*SubscriptionResponse) GetSubscriptionId 

func (x *SubscriptionResponse) GetSubscriptionId() uint32

func (*SubscriptionResponse) ProtoMessage 

func (*SubscriptionResponse) ProtoMessage()

func (*SubscriptionResponse) ProtoReflect added in v1.20.4 

func (x *SubscriptionResponse) ProtoReflect() protoreflect.Message

func (*SubscriptionResponse) Reset 

func (x *SubscriptionResponse) Reset()

func (*SubscriptionResponse) String 

func (x *SubscriptionResponse) String() string

type UnimplementedOpenConfigTelemetryServer added in v1.20.4 

type UnimplementedOpenConfigTelemetryServer struct {
}

UnimplementedOpenConfigTelemetryServer must be embedded to have forward compatible implementations.

func (UnimplementedOpenConfigTelemetryServer) CancelTelemetrySubscription added in v1.20.4 

func (UnimplementedOpenConfigTelemetryServer) CancelTelemetrySubscription(context.Context, *CancelSubscriptionRequest) (*CancelSubscriptionReply, error)

func (UnimplementedOpenConfigTelemetryServer) GetDataEncodings added in v1.20.4 

func (UnimplementedOpenConfigTelemetryServer) GetDataEncodings(context.Context, *DataEncodingRequest) (*DataEncodingReply, error)

func (UnimplementedOpenConfigTelemetryServer) GetTelemetryOperationalState added in v1.20.4 

func (UnimplementedOpenConfigTelemetryServer) GetTelemetryOperationalState(context.Context, *GetOperationalStateRequest) (*GetOperationalStateReply, error)

func (UnimplementedOpenConfigTelemetryServer) GetTelemetrySubscriptions added in v1.20.4 

func (UnimplementedOpenConfigTelemetryServer) GetTelemetrySubscriptions(context.Context, *GetSubscriptionsRequest) (*GetSubscriptionsReply, error)

func (UnimplementedOpenConfigTelemetryServer) TelemetrySubscribe added in v1.20.4 

func (UnimplementedOpenConfigTelemetryServer) TelemetrySubscribe(*SubscriptionRequest, OpenConfigTelemetry_TelemetrySubscribeServer) error

type UnsafeOpenConfigTelemetryServer added in v1.20.4 

type UnsafeOpenConfigTelemetryServer interface {
	// contains filtered or unexported methods
}

UnsafeOpenConfigTelemetryServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to OpenConfigTelemetryServer will result in compilation errors.

type VerbosityLevel 

type VerbosityLevel int32

Verbosity Level 

const (
	VerbosityLevel_DETAIL VerbosityLevel = 0
	VerbosityLevel_TERSE  VerbosityLevel = 1
	VerbosityLevel_BRIEF  VerbosityLevel = 2
)

func (VerbosityLevel) Descriptor added in v1.20.4 

func (VerbosityLevel) Descriptor() protoreflect.EnumDescriptor

func (VerbosityLevel) Enum added in v1.20.4 

func (x VerbosityLevel) Enum() *VerbosityLevel

func (VerbosityLevel) EnumDescriptor deprecated 

func (VerbosityLevel) EnumDescriptor() ([]byte, []int)

Deprecated: Use VerbosityLevel.Descriptor instead.

func (VerbosityLevel) Number added in v1.20.4 

func (x VerbosityLevel) Number() protoreflect.EnumNumber

func (VerbosityLevel) String 

func (x VerbosityLevel) String() string

func (VerbosityLevel) Type added in v1.20.4 

func (VerbosityLevel) Type() protoreflect.EnumType

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.