telemetry

README

Streaming Telemetry

Go Proto Library for Cisco IOS-XR Model Driven Telemetry

---

The content in proto_go directory is automatically generated and only committed to the repo for convenience.

Note: Model driven telemetry project is work in progress, and both the on and off box components are likely to evolve.

Should it be necessary to regenerate a golang binding, simply run prep_golang.py from the telemetry_proto root. This script will build the golang proto bindings based on content in the staging directory, generate code and tests, and run the tests, including performance benchmarks.

In some more detail, prep_golang.py takes care of setting up docs.go with go generate directives to generate golang bindings from .proto files, running go generate to generate the golang bindings for the .proto files, as well as generating the wrapper code to serve objects to unmarshal into using the encoding path in the telemetry message header as key. Once the wrapper code is generated, it is built, and auto generated tests are run.

Package documentation for golang can be browsed by firing up "godoc -http=:6060 &" picking which every port is covenient, and then point browser to "http://:6060/pkg/telemetry_proto/proto_go/" or clicking on the godoc link above.

A sample run looks like this:

[gows/src/telemetry_proto]$./prep_golang.py
Generating proto_go/mdt_telemetry.go...
Generating proto_go/mdt_telemetry_test.go...
Copying proto_go/doc.go...
Soft links to protos and adding 'go generate' directive in doc.go...
Generating golang bindings for 668 .proto files. This stage takes some time...
Building and running tests for package. The build stage also takes some time...

...
    --- PASS: TestYang2Proto/Cisco-IOS-XR-mpls-ldp-oper:mpls-ldp/global/active/default-vrf/afs/af/discovery/summary (0.00s)
    --- PASS: TestYang2Proto/Cisco-IOS-XR-ipv4-bgp-oper:bgp/instances/instance/instance-active/default-vrf/bmp/server-summaries/server-summary (0.00s)
    --- PASS: TestYang2Proto/Cisco-IOS-XR-mpls-ldp-oper:mpls-ldp/nodes/node/vrfs/vrf/afs/af/forwarding-summary (0.00s)
    --- PASS: TestYang2Proto/Cisco-IOS-XR-infra-tc-oper:traffic-collector/summary (0.00s)
    --- PASS: TestYang2Proto/Cisco-IOS-XR-ipv4-bgp-oper:bgp/instances/instance/instance-active/default-vrf/afs/af/advertised-paths/advertised-path (0.00s)
    --- PASS: TestYang2Proto/Cisco-IOS-XR-ipv4-bgp-oper:bgp/instances/instance/instance-standby/vrfs/vrf/update-inbound-error-vrf (0.00s)
=== RUN   ExampleEncodingPathToMessageReflectionSet
--- PASS: ExampleEncodingPathToMessageReflectionSet (0.00s)
=== RUN   ExampleProtoMsgs_MessageReflection
--- PASS: ExampleProtoMsgs_MessageReflection (0.00s)
BenchmarkMessageSetLookup-80            20000000               101 ns/op
PASS
ok      telemetry_proto/proto_go        8.139s
Done.

Dependencies

In order to build the golang bigmuddy-network-telemetry-proto package, go1.8 and protoc are required.

Note that given we are building a package, we do not vendor dependencies. The only dependency is protobuf.

go get -u github.com/golang/protobuf/{proto,protoc-gen-go}
./prep_golang.py

Documentation

Overview

This package provides protobuf golang bindings for Model Driven Telemetry (MDT) messages and gRPC service definitions as well as wrapper code to facilitate unmarshalling GPB encoded content from routers.

MDT provides a mechanism for an external entity to subscribe to a data set defined in a YANG model and receive periodic or event-based updates of the data set from an MDT-capable device. The data definition (YANG models), encodings on the wire, and the transports used are handled as independent layers to provide sufficient flexibility.

Top Level Messages

The outermost message of model driven telemetry payload can be found in the message Telemetry in telemetry.proto.

The normal mode of operation in MDT is expected to be the dial-out mode. In this mode, MDT is configured on an MDT-capable Device. Sensor-paths, and mdt-destinations are configured and bound together into one or more mdt-subscriptions. These configuration primitives are defined in the OpenConfig Telemetry model. An MDT-capable Device continually attempts to establish an MDT Session to each of the mdt-destinations that are bound into mdt-subscriptions. For each established MDT Session, the MDT-capable Device streams Telemetry Messages per the mdt-subscription configuration. Such mdt-subscriptions are considered persistent subscriptions.

The dial out service definition for gRPC can be found in:

mdt_grpc_dialout/mdt_grpc_dialout.proto

The dial-in mode of operation allows an MDT Collector to establish an MDT Session, and subscribe dynamically to one or more sensor-paths or mdt-subscriptions. The MDT-capable Device will stream Telemetry messages via the same MDT session (in-band). Such subscriptions are considered dynamic or ephemeral subscriptions. A dynamic subscription terminates either when the MDT Collector cancels the subscription, or when the MDT Session terminates.

The dial in service definition for gRPC can be found in:

mdt_grpc_dialin/mdt_grpc_dialin.proto

Mapping YANG Encoding Path And Model Version To Message Set

An application which has received and decoded a Telemetry message might find that the TelemetryGPBTable field is populated. This field points at the TelemetryGPBTable message which itself is a set of repeated TelemetryRowGPB messages:

message TelemetryRowGPB {
  uint64 timestamp = 1;
  bytes keys = 10;
  bytes content = 11;
}

The two fields keys, and content are bytes streams. Both are binary stream based on protobuf messages and can be unmarshalled against the matching .proto derived structure. The role of this package is to make figuring out the appropriate .proto derived structure easy even if there are thousands of proto files covering the telemetry models exported by a router.

In order to retrieve the ProtoMsgs object to use to unmarshal the payload, a ProtoKey object is composed using the YANG encoding path (retrieved from the encoding-path field in the Telemetry message), and the model version used if provided (again in the Telemetry message). The ProtoKey object is used as an argument to EncodingPathToMessageReflectionSet in order to fetch the pertinent set of message types ProtoMsgs to unmarshal against. Finally with a ProtoMsgs in hand, we can retrieve PROTO_KEYS_MSG structure to unmarshal 'keys' binary stream, or PROTO_CONTENT_MSG to unmarshall 'content'.

Autogenerated Protobuf Documentation

Index

• Constants
• type ProtoKey
  • func EncodingPathsSupported() []*ProtoKey
• type ProtoMsgType
• type ProtoMsgs
  • func EncodingPathToMessageReflectionSet(p *ProtoKey) *ProtoMsgs
  • func (p *ProtoMsgs) MessageReflection(t ProtoMsgType) reflect.Type
• type Telemetry
  • func (*Telemetry) Descriptor() ([]byte, []int)
  • func (m *Telemetry) GetCollectionEndTime() uint64
  • func (m *Telemetry) GetCollectionId() uint64
  • func (m *Telemetry) GetCollectionStartTime() uint64
  • func (m *Telemetry) GetDataGpb() *TelemetryGPBTable
  • func (m *Telemetry) GetDataGpbkv() []*TelemetryField
  • func (m *Telemetry) GetEncodingPath() string
  • func (m *Telemetry) GetModelVersion() string
  • func (m *Telemetry) GetMsgTimestamp() uint64
  • func (m *Telemetry) GetNodeId() isTelemetry_NodeId
  • func (m *Telemetry) GetNodeIdStr() string
  • func (m *Telemetry) GetSubscription() isTelemetry_Subscription
  • func (m *Telemetry) GetSubscriptionIdStr() string
  • func (*Telemetry) ProtoMessage()
  • func (m *Telemetry) Reset()
  • func (m *Telemetry) String() string
  • func (m *Telemetry) XXX_DiscardUnknown()
  • func (m *Telemetry) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
  • func (m *Telemetry) XXX_Merge(src proto.Message)
  • func (*Telemetry) XXX_OneofWrappers() []interface{}
  • func (m *Telemetry) XXX_Size() int
  • func (m *Telemetry) XXX_Unmarshal(b []byte) error
• type TelemetryField
  • func (*TelemetryField) Descriptor() ([]byte, []int)
  • func (m *TelemetryField) GetBoolValue() bool
  • func (m *TelemetryField) GetBytesValue() []byte
  • func (m *TelemetryField) GetDelete() bool
  • func (m *TelemetryField) GetDoubleValue() float64
  • func (m *TelemetryField) GetFields() []*TelemetryField
  • func (m *TelemetryField) GetFloatValue() float32
  • func (m *TelemetryField) GetName() string
  • func (m *TelemetryField) GetSint32Value() int32
  • func (m *TelemetryField) GetSint64Value() int64
  • func (m *TelemetryField) GetStringValue() string
  • func (m *TelemetryField) GetTimestamp() uint64
  • func (m *TelemetryField) GetUint32Value() uint32
  • func (m *TelemetryField) GetUint64Value() uint64
  • func (m *TelemetryField) GetValueByType() isTelemetryField_ValueByType
  • func (*TelemetryField) ProtoMessage()
  • func (m *TelemetryField) Reset()
  • func (m *TelemetryField) String() string
  • func (m *TelemetryField) XXX_DiscardUnknown()
  • func (m *TelemetryField) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
  • func (m *TelemetryField) XXX_Merge(src proto.Message)
  • func (*TelemetryField) XXX_OneofWrappers() []interface{}
  • func (m *TelemetryField) XXX_Size() int
  • func (m *TelemetryField) XXX_Unmarshal(b []byte) error
• type TelemetryField_BoolValue
• type TelemetryField_BytesValue
• type TelemetryField_DoubleValue
• type TelemetryField_FloatValue
• type TelemetryField_Sint32Value
• type TelemetryField_Sint64Value
• type TelemetryField_StringValue
• type TelemetryField_Uint32Value
• type TelemetryField_Uint64Value
• type TelemetryGPBTable
  • func (*TelemetryGPBTable) Descriptor() ([]byte, []int)
  • func (m *TelemetryGPBTable) GetRow() []*TelemetryRowGPB
  • func (*TelemetryGPBTable) ProtoMessage()
  • func (m *TelemetryGPBTable) Reset()
  • func (m *TelemetryGPBTable) String() string
  • func (m *TelemetryGPBTable) XXX_DiscardUnknown()
  • func (m *TelemetryGPBTable) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
  • func (m *TelemetryGPBTable) XXX_Merge(src proto.Message)
  • func (m *TelemetryGPBTable) XXX_Size() int
  • func (m *TelemetryGPBTable) XXX_Unmarshal(b []byte) error
• type TelemetryRowGPB
  • func (*TelemetryRowGPB) Descriptor() ([]byte, []int)
  • func (m *TelemetryRowGPB) GetContent() []byte
  • func (m *TelemetryRowGPB) GetKeys() []byte
  • func (m *TelemetryRowGPB) GetTimestamp() uint64
  • func (*TelemetryRowGPB) ProtoMessage()
  • func (m *TelemetryRowGPB) Reset()
  • func (m *TelemetryRowGPB) String() string
  • func (m *TelemetryRowGPB) XXX_DiscardUnknown()
  • func (m *TelemetryRowGPB) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
  • func (m *TelemetryRowGPB) XXX_Merge(src proto.Message)
  • func (m *TelemetryRowGPB) XXX_Size() int
  • func (m *TelemetryRowGPB) XXX_Unmarshal(b []byte) error
• type Telemetry_NodeIdStr
• type Telemetry_SubscriptionIdStr

Examples

• EncodingPathToMessageReflectionSet
• ProtoMsgs.MessageReflection

Constants

const (
	// PROTO_CONTENT_MSG corresponds to content field serialised
	// in TelemetryRowGPB message.
	PROTO_CONTENT_MSG = 0
	// PROTO_KEYS_MSG corresponds to keys field serialised
	// in TelemetryRowGPB message.
	PROTO_KEYS_MSG = 1
	//  PROTO_LEGACY_COMBINED_KEYS_AND_CONTENT_MSG, not populated
	//  anymore, but used to support legacy cases where keys
	//  and content used to be combined.
	PROTO_LEGACY_COMBINED_KEYS_AND_CONTENT_MSG = 2
)

Types

type ProtoKey

type ProtoKey struct {
	EncodingPath string
	Version      string
}

ProtoKey identifies which proto messages we are looking for. The encoding_path field in telemetry containing the yang path where the content in the message is rooted at is used to set EncodingPath. The Version field can be extracted from the Telemetry header and reflects the yang model version. If no Version is provided, the default for the package is used. As of IOS-XR 6.1.1, IOS-XR telemetry does not produce a version field yet in the Telemetry header.

func EncodingPathsSupported

func EncodingPathsSupported() []*ProtoKey

EncodingPathsSupported provides a list of gather path ProtoKeys supported by package (for reporting purposes).

type ProtoMsgType

type ProtoMsgType int

type ProtoMsgs

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

ProtoMsgs are an ordered collection of reflect.Type objects. These objects can be used to unmarshal a binary protobuf stream into a go structure. The index into the array is the ProtoMsgType.

func EncodingPathToMessageReflectionSet

func EncodingPathToMessageReflectionSet(p *ProtoKey) *ProtoMsgs

EncodingPathToMessageReflectionSet returns an opaque structure tracking relect.Type for Messages pertaining to the ProtoKey p.

Example

var t reflect.Type
//
// Extract encoding_path field from Telemetry message,
// and use pass it in
s := EncodingPathToMessageReflectionSet(
	&ProtoKey{
		EncodingPath: "Cisco-IOS-XR-infra-statsd-oper:infra-statistics/interfaces/interface/latest/generic-counters",
		Version:      ""})

// Use returned object to extract the KEYs message to
// unmarshal keys field from TelemetryRowGPB
t = s.MessageReflection(PROTO_KEYS_MSG)
fmt.Print(t)

Output:

*cisco_ios_xr_infra_statsd_oper_infra_statistics_interfaces_interface_latest_generic_counters.IfstatsbagGeneric_KEYS

func (*ProtoMsgs) MessageReflection

func (p *ProtoMsgs) MessageReflection(t ProtoMsgType) reflect.Type

MessageReflection returns reflection type of the object pertaining to the encoding path, and qualified by ProtoMsgType t

Example

var t reflect.Type
//
// Extract encoding_path field from Telemetry message,
// and use pass it in
s := EncodingPathToMessageReflectionSet(
	&ProtoKey{
		EncodingPath: "Cisco-IOS-XR-infra-statsd-oper:infra-statistics/interfaces/interface/latest/generic-counters",
		Version:      ""})

// Use returned object to extract the KEYs message to
// unmarshal keys field from TelemetryRowGPB
t = s.MessageReflection(PROTO_KEYS_MSG)
fmt.Print(t)

Output:

*cisco_ios_xr_infra_statsd_oper_infra_statistics_interfaces_interface_latest_generic_counters.IfstatsbagGeneric_KEYS

type Telemetry

type Telemetry struct {
	//
	// node_id_str is a string encoded unique node ID of the MDT-capable
	// device producing the message. (node_id_uuid alternative is not currently
	// produced in IOS-XR)
	//
	// Types that are valid to be assigned to NodeId:
	//	*Telemetry_NodeIdStr
	NodeId isTelemetry_NodeId `protobuf_oneof:"node_id"`
	//
	// subscription_id_str is the name of the subscription against which
	// this content is being produced. (subscription_id alternative is not
	//  currently produced in IOS-XR)
	//
	// Types that are valid to be assigned to Subscription:
	//	*Telemetry_SubscriptionIdStr
	Subscription isTelemetry_Subscription `protobuf_oneof:"subscription"`
	//
	// sensor_path is not currently produced in IOS-XR
	// string   sensor_path = 5;
	//
	// encoding_path is the Yang path leading to the content in this message.
	// The Yang tree encoded in the content section of this message is rooted
	// at the point described by the encoding_path.
	EncodingPath string `protobuf:"bytes,6,opt,name=encoding_path,json=encodingPath,proto3" json:"encoding_path,omitempty"`
	//
	// model_revision
	ModelVersion string `protobuf:"bytes,7,opt,name=model_version,json=modelVersion,proto3" json:"model_version,omitempty"`
	//
	// collection_id identifies messages belonging to a collection round.
	// Multiple message may be generated from a collection round.
	CollectionId uint64 `protobuf:"varint,8,opt,name=collection_id,json=collectionId,proto3" json:"collection_id,omitempty"`
	//
	// collection_start_time is the time when the collection identified by
	// the collection_id begins - encoded as milliseconds since the epoch.
	// If a single collection is spread over multiple Telemetry Messages,
	// collection_start_time may be encoded in the first Telemetry Message
	// for the collection only.
	CollectionStartTime uint64 `protobuf:"varint,9,opt,name=collection_start_time,json=collectionStartTime,proto3" json:"collection_start_time,omitempty"`
	//
	// msg_timestamp is the time when the data encoded in the Telemetry
	// message is generated - encoded as milliseconds since the epoch.
	MsgTimestamp uint64 `protobuf:"varint,10,opt,name=msg_timestamp,json=msgTimestamp,proto3" json:"msg_timestamp,omitempty"`
	//
	// data_gpbkv contains the payload data if data is being encoded in the
	// self-describing GPB-KV format.
	DataGpbkv []*TelemetryField `protobuf:"bytes,11,rep,name=data_gpbkv,json=dataGpbkv,proto3" json:"data_gpbkv,omitempty"`
	//
	// data_gpb contains the payload data if data is being encoded as
	// serialised GPB messages.
	DataGpb *TelemetryGPBTable `protobuf:"bytes,12,opt,name=data_gpb,json=dataGpb,proto3" json:"data_gpb,omitempty"`
	//
	// collection_end_time is the timestamp when the last Telemetry message
	// for a collection has been encoded - encoded as milliseconds since the
	// epoch. If a single collection is spread over multiple Telemetry
	// messages, collection_end_time is encoded in the last Telemetry Message
	// for the collection only.
	CollectionEndTime    uint64   `protobuf:"varint,13,opt,name=collection_end_time,json=collectionEndTime,proto3" json:"collection_end_time,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Telemetry message is the outermost payload message used to stream telemetry in a Model Driven Telemetry (MDT) system. MDT provides a mechanism for an external entity to subscribe to a data set defined in a Yang model and receive periodic or event-based updates of the data set from an MDT-capable device.

func (*Telemetry) Descriptor

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

func (*Telemetry) GetCollectionEndTime

func (m *Telemetry) GetCollectionEndTime() uint64

func (*Telemetry) GetCollectionId

func (m *Telemetry) GetCollectionId() uint64

func (*Telemetry) GetCollectionStartTime

func (m *Telemetry) GetCollectionStartTime() uint64

func (*Telemetry) GetDataGpb

func (m *Telemetry) GetDataGpb() *TelemetryGPBTable

func (*Telemetry) GetDataGpbkv

func (m *Telemetry) GetDataGpbkv() []*TelemetryField

func (*Telemetry) GetEncodingPath

func (m *Telemetry) GetEncodingPath() string

func (*Telemetry) GetModelVersion

func (m *Telemetry) GetModelVersion() string

func (*Telemetry) GetMsgTimestamp

func (m *Telemetry) GetMsgTimestamp() uint64

func (*Telemetry) GetNodeId

func (m *Telemetry) GetNodeId() isTelemetry_NodeId

func (*Telemetry) GetNodeIdStr

func (m *Telemetry) GetNodeIdStr() string

func (*Telemetry) GetSubscription

func (m *Telemetry) GetSubscription() isTelemetry_Subscription

func (*Telemetry) GetSubscriptionIdStr

func (m *Telemetry) GetSubscriptionIdStr() string

func (*Telemetry) ProtoMessage

func (*Telemetry) ProtoMessage()

func (*Telemetry) Reset

func (m *Telemetry) Reset()

func (*Telemetry) String

func (m *Telemetry) String() string

func (*Telemetry) XXX_DiscardUnknown

func (m *Telemetry) XXX_DiscardUnknown()

func (*Telemetry) XXX_Marshal

func (m *Telemetry) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Telemetry) XXX_Merge

func (m *Telemetry) XXX_Merge(src proto.Message)

func (*Telemetry) XXX_OneofWrappers

func (*Telemetry) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*Telemetry) XXX_Size

func (m *Telemetry) XXX_Size() int

func (*Telemetry) XXX_Unmarshal

func (m *Telemetry) XXX_Unmarshal(b []byte) error

type TelemetryField

type TelemetryField struct {
	//
	// timestamp represents the starting time of the generation of data
	// starting from this key, value pair in this message - encoded as
	// milliseconds since the epoch. It is encoded when different from the
	// msg_timestamp in the containing Telemetry Message. This field can be
	// omitted if the value is the same as a TelemetryField message up the
	// hierarchy within the same Telemetry Message as well.
	Timestamp uint64 `protobuf:"varint,1,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	//
	// name: string encoding of the name in the key, value pair. It is
	// the corresponding YANG element name.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	//
	// value_by_type, if present, for the corresponding YANG element
	// represented by the name field in the same TelemetryField message. The
	// value is encoded to the matching type as defined in the YANG model.
	// YANG models often define new types (derived types) using one or more
	// base types.  The types included in the oneof grouping is sufficient to
	// represent such derived types. Derived types represented as a Yang
	// container are encoded using the nesting primitive defined in this
	// encoding proposal.
	//
	// Types that are valid to be assigned to ValueByType:
	//	*TelemetryField_BytesValue
	//	*TelemetryField_StringValue
	//	*TelemetryField_BoolValue
	//	*TelemetryField_Uint32Value
	//	*TelemetryField_Uint64Value
	//	*TelemetryField_Sint32Value
	//	*TelemetryField_Sint64Value
	//	*TelemetryField_DoubleValue
	//	*TelemetryField_FloatValue
	ValueByType isTelemetryField_ValueByType `protobuf_oneof:"value_by_type"`
	//
	// The Yang model may include nesting (e.g hierarchy of containers). The
	// next level of nesting, if present, is encoded, starting from fields.
	Fields []*TelemetryField `protobuf:"bytes,15,rep,name=fields,proto3" json:"fields,omitempty"`
	// set only for delete event
	Delete               bool     `protobuf:"varint,16,opt,name=delete,proto3" json:"delete,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

TelemetryField messages are used to export content in the self describing GPB KV form. The TelemetryField message is sufficient to decode telemetry messages for all models. KV-GPB encoding is very similar in concept, to JSON encoding

func (*TelemetryField) Descriptor

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

func (*TelemetryField) GetBoolValue

func (m *TelemetryField) GetBoolValue() bool

func (*TelemetryField) GetBytesValue

func (m *TelemetryField) GetBytesValue() []byte

func (*TelemetryField) GetDelete

func (m *TelemetryField) GetDelete() bool

func (*TelemetryField) GetDoubleValue

func (m *TelemetryField) GetDoubleValue() float64

func (*TelemetryField) GetFields

func (m *TelemetryField) GetFields() []*TelemetryField

func (*TelemetryField) GetFloatValue

func (m *TelemetryField) GetFloatValue() float32

func (*TelemetryField) GetName

func (m *TelemetryField) GetName() string

func (*TelemetryField) GetSint32Value

func (m *TelemetryField) GetSint32Value() int32

func (*TelemetryField) GetSint64Value

func (m *TelemetryField) GetSint64Value() int64

func (*TelemetryField) GetStringValue

func (m *TelemetryField) GetStringValue() string

func (*TelemetryField) GetTimestamp

func (m *TelemetryField) GetTimestamp() uint64

func (*TelemetryField) GetUint32Value

func (m *TelemetryField) GetUint32Value() uint32

func (*TelemetryField) GetUint64Value

func (m *TelemetryField) GetUint64Value() uint64

func (*TelemetryField) GetValueByType

func (m *TelemetryField) GetValueByType() isTelemetryField_ValueByType

func (*TelemetryField) ProtoMessage

func (*TelemetryField) ProtoMessage()

func (*TelemetryField) Reset

func (m *TelemetryField) Reset()

func (*TelemetryField) String

func (m *TelemetryField) String() string

func (*TelemetryField) XXX_DiscardUnknown

func (m *TelemetryField) XXX_DiscardUnknown()

func (*TelemetryField) XXX_Marshal

func (m *TelemetryField) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*TelemetryField) XXX_Merge

func (m *TelemetryField) XXX_Merge(src proto.Message)

func (*TelemetryField) XXX_OneofWrappers

func (*TelemetryField) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*TelemetryField) XXX_Size

func (m *TelemetryField) XXX_Size() int

func (*TelemetryField) XXX_Unmarshal

func (m *TelemetryField) XXX_Unmarshal(b []byte) error

type TelemetryField_BoolValue

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

type TelemetryField_BytesValue

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

type TelemetryField_DoubleValue

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

type TelemetryField_FloatValue

type TelemetryField_FloatValue struct {
	FloatValue float32 `protobuf:"fixed32,12,opt,name=float_value,json=floatValue,proto3,oneof"`
}

type TelemetryField_Sint32Value

type TelemetryField_Sint32Value struct {
	Sint32Value int32 `protobuf:"zigzag32,9,opt,name=sint32_value,json=sint32Value,proto3,oneof"`
}

type TelemetryField_Sint64Value

type TelemetryField_Sint64Value struct {
	Sint64Value int64 `protobuf:"zigzag64,10,opt,name=sint64_value,json=sint64Value,proto3,oneof"`
}

type TelemetryField_StringValue

type TelemetryField_StringValue struct {
	StringValue string `protobuf:"bytes,5,opt,name=string_value,json=stringValue,proto3,oneof"`
}

type TelemetryField_Uint32Value

type TelemetryField_Uint32Value struct {
	Uint32Value uint32 `protobuf:"varint,7,opt,name=uint32_value,json=uint32Value,proto3,oneof"`
}

type TelemetryField_Uint64Value

type TelemetryField_Uint64Value struct {
	Uint64Value uint64 `protobuf:"varint,8,opt,name=uint64_value,json=uint64Value,proto3,oneof"`
}

type TelemetryGPBTable

type TelemetryGPBTable struct {
	Row                  []*TelemetryRowGPB `protobuf:"bytes,1,rep,name=row,proto3" json:"row,omitempty"`
	XXX_NoUnkeyedLiteral struct{}           `json:"-"`
	XXX_unrecognized     []byte             `json:"-"`
	XXX_sizecache        int32              `json:"-"`
}

TelemetryGPBTable contains a repeated number of TelemetryRowGPB, each of which represents content from a subtree instance in the the YANG model. For example; a TelemetryGPBTable might contain the interface statistics of a collection of interfaces.

func (*TelemetryGPBTable) Descriptor

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

func (*TelemetryGPBTable) GetRow

func (m *TelemetryGPBTable) GetRow() []*TelemetryRowGPB

func (*TelemetryGPBTable) ProtoMessage

func (*TelemetryGPBTable) ProtoMessage()

func (*TelemetryGPBTable) Reset

func (m *TelemetryGPBTable) Reset()

func (*TelemetryGPBTable) String

func (m *TelemetryGPBTable) String() string

func (*TelemetryGPBTable) XXX_DiscardUnknown

func (m *TelemetryGPBTable) XXX_DiscardUnknown()

func (*TelemetryGPBTable) XXX_Marshal

func (m *TelemetryGPBTable) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*TelemetryGPBTable) XXX_Merge

func (m *TelemetryGPBTable) XXX_Merge(src proto.Message)

func (*TelemetryGPBTable) XXX_Size

func (m *TelemetryGPBTable) XXX_Size() int

func (*TelemetryGPBTable) XXX_Unmarshal

func (m *TelemetryGPBTable) XXX_Unmarshal(b []byte) error

type TelemetryRowGPB

type TelemetryRowGPB struct {
	//
	// timestamp at which the data for this instance of the TelemetryRowGPB
	// message was generated by an MDT-capable device - encoded as
	// milliseconds since the epoch.  When included, this is typically
	// different from the msg_timestamp in the containing Telemetry message.
	Timestamp uint64 `protobuf:"varint,1,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	//
	// keys: if the encoding-path includes one or more list elements, and/or
	// ends in a list element, the keys field is a GPB encoded message that
	// contains the sequence of key values for each such list element in the
	// encoding-path traversed starting from the root.  The set of keys
	// unambiguously identifies the instance of data encoded in the
	// TelemetryRowGPB message. Corresponding protobuf message definition will
	// be required to decode the byte stream. The encoding_path field in
	// Telemetry message, together with model_version field should be
	// sufficient to identify the corresponding protobuf message.
	Keys []byte `protobuf:"bytes,10,opt,name=keys,proto3" json:"keys,omitempty"`
	//
	// content: the content field is a GPB encoded message that contains the
	// data for the corresponding encoding-path. A separate decoding pass
	// would be performed by consumer with the content field as a GPB message
	// and the matching .proto used to decode the message. Corresponding
	// protobuf message definition will be required to decode the byte
	// stream. The encoding_path field in Telemetry message, together with
	// model_version field should be sufficient to identify the corresponding
	// protobuf message. The decoded combination of keys (when present) and
	// content, unambiguously represents an instance of the data set, as
	// defined in the Yang model, identified by the encoding-path in the
	// containing Telemetry message.
	Content              []byte   `protobuf:"bytes,11,opt,name=content,proto3" json:"content,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

TelemetryRowGPB, in conjunction with the Telemetry encoding_path and model_version, unambiguously represents the root of a subtree in the YANG model, and content from that subtree encoded in serialised GPB messages. For example; a TelemetryRowGPB might contain the interface statistics of one interface. Per encoding-path .proto messages are required to decode keys/content pairs below.

func (*TelemetryRowGPB) Descriptor

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

func (*TelemetryRowGPB) GetContent

func (m *TelemetryRowGPB) GetContent() []byte

func (*TelemetryRowGPB) GetKeys

func (m *TelemetryRowGPB) GetKeys() []byte

func (*TelemetryRowGPB) GetTimestamp

func (m *TelemetryRowGPB) GetTimestamp() uint64

func (*TelemetryRowGPB) ProtoMessage

func (*TelemetryRowGPB) ProtoMessage()

func (*TelemetryRowGPB) Reset

func (m *TelemetryRowGPB) Reset()

func (*TelemetryRowGPB) String

func (m *TelemetryRowGPB) String() string

func (*TelemetryRowGPB) XXX_DiscardUnknown

func (m *TelemetryRowGPB) XXX_DiscardUnknown()

func (*TelemetryRowGPB) XXX_Marshal

func (m *TelemetryRowGPB) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*TelemetryRowGPB) XXX_Merge

func (m *TelemetryRowGPB) XXX_Merge(src proto.Message)

func (*TelemetryRowGPB) XXX_Size

func (m *TelemetryRowGPB) XXX_Size() int

func (*TelemetryRowGPB) XXX_Unmarshal

func (m *TelemetryRowGPB) XXX_Unmarshal(b []byte) error

type Telemetry_NodeIdStr

type Telemetry_NodeIdStr struct {
	NodeIdStr string `protobuf:"bytes,1,opt,name=node_id_str,json=nodeIdStr,proto3,oneof"`
}

type Telemetry_SubscriptionIdStr

type Telemetry_SubscriptionIdStr struct {
	SubscriptionIdStr string `protobuf:"bytes,3,opt,name=subscription_id_str,json=subscriptionIdStr,proto3,oneof"`
}