package telemetry

Get desktop application:
View/edit binary Protocol Buffers messages

Interface exported by Agent

• rpc telemetrySubscribe (SubscriptionRequest, stream OpenConfigData)

  oc.proto:46

  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.

  message SubscriptionRequest

  oc.proto:65

  Message sent for a telemetry subscription request

  • optional SubscriptionInput input = 1

    Data associated with a telemetry subscription

  • repeated Path path_list = 2

    List of data models paths and filters which are used in a telemetry operation.

  • optional SubscriptionAdditionalConfig additional_config = 3

    The below configuration is not defined in Openconfig RPC. It is a proposed extension to configure additional subscription request features.

  message OpenConfigData

  oc.proto:172

  2. Telemetry data send back on the same connection as the subscription request.

  • string system_id = 1

    router name:export IP address

  • uint32 component_id = 2

    line card / RE (slot number)

  • uint32 sub_component_id = 3

    PFE (if applicable)

  • string path = 4

    Path specification for elements of OpenConfig data models

  • uint64 sequence_number = 5

    Sequence number, monotonically increasing for each system_id, component_id, sub_component_id + path.

  • uint64 timestamp = 6

    timestamp (milliseconds since epoch)

  • repeated KeyValue kv = 7

    List of key-value pairs

  • repeated Delete delete = 8

    For delete. If filled, it indicates delete

  • repeated Eom eom = 9

    If filled, it indicates end of marker for the respective path in the list.

  • bool sync_response = 10

    If filled, it indicates end of sync for complete subscription

• rpc cancelTelemetrySubscription (CancelSubscriptionRequest, CancelSubscriptionReply)

  oc.proto:49

  Terminates and removes an existing telemetry subscription

  message CancelSubscriptionRequest

  oc.proto:234

  Message sent for a telemetry subscription cancellation request

  • uint32 subscription_id = 1

    Subscription identifier as returned by the device when subscription was requested

  message CancelSubscriptionReply

  oc.proto:241

  Reply to telemetry subscription cancellation request

  • ReturnCode code = 1

    Return code

  • string code_str = 2

    Return code string

• rpc getTelemetrySubscriptions (GetSubscriptionsRequest, GetSubscriptionsReply)

  oc.proto:54

  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.

  message GetSubscriptionsRequest

  oc.proto:257

  Message sent for a telemetry get request

  • uint32 subscription_id = 1

    Subscription identifier as returned by the device when subscription was requested --- or --- 0xFFFFFFFF for all subscription identifiers

  message GetSubscriptionsReply

  oc.proto:266

  Reply to telemetry subscription get request

  • repeated SubscriptionReply subscription_list = 1

    List of current telemetry subscriptions

• rpc getTelemetryOperationalState (GetOperationalStateRequest, GetOperationalStateReply)

  oc.proto:57

  Get Telemetry Agent Operational States

  message GetOperationalStateRequest

  oc.proto:272

  Message sent for telemetry agent operational states request

  • uint32 subscription_id = 1

    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

  • VerbosityLevel verbosity = 2

    Control verbosity of the output

  message GetOperationalStateReply

  oc.proto:297

  Reply to telemetry agent operational states request

  • repeated KeyValue kv = 1

    List of key-value pairs where key = operational state definition value = operational state value

• rpc getDataEncodings (DataEncodingRequest, DataEncodingReply)

  oc.proto:61

  Return the set of data encodings supported by the device for telemetry data

  message DataEncodingRequest

  oc.proto:305

  Message sent for a data encoding request

  (message has no fields)

  message DataEncodingReply

  oc.proto:309

  Reply to data encodings supported request

  • repeated EncodingType encoding_list = 1

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

Used in: SubscriptionInput

• string address = 1

  IP address of collector endpoint

• uint32 port = 2

  Transport protocol port number for the collector destination.

Message indicating delete for a particular path

Used in: OpenConfigData

• string path = 1

Encoding Type Supported

Used in: DataEncodingReply

• UNDEFINED = 0

• XML = 1

• JSON_IETF = 2

• PROTO3 = 3

Message indicating EOM for a particular path

Used in: OpenConfigData

• string path = 1

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

Used in: GetOperationalStateReply, OpenConfigData

• string key = 1

  Key

• oneof value

  One of possible values

  • double double_value = 5

  • int64 int_value = 6

  • uint64 uint_value = 7

  • sint64 sint_value = 8

  • bool bool_value = 9

  • string str_value = 10

  • bytes bytes_value = 11

Data model path

Used in: SubscriptionReply, SubscriptionRequest

• string path = 1

  Data model path of interest Path specification for elements of OpenConfig data models

• string filter = 2

  Regular expression to be used in filtering state leaves

• bool suppress_unchanged = 3

  If this is set to true, the target device will only send updates to the collector upon a change in data value

• uint32 max_silent_interval = 4

  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.

• uint32 sample_frequency = 5

  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.

• bool need_eom = 6

  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.

Result of the operation

Used in: CancelSubscriptionReply

• SUCCESS = 0

• NO_SUBSCRIPTION_ENTRY = 1

• UNKNOWN_ERROR = 2

Configure subscription request additional features.

Used in: SubscriptionRequest

• int32 limit_records = 1

  limit the number of records sent in the stream

• int32 limit_time_seconds = 2

  limit the time the stream remains open

• bool need_eos = 3

  EOS needed for this subscription?

Data associated with a telemetry subscription

Used in: SubscriptionRequest

• repeated Collector collector_list = 1

  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.

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

Used in: GetSubscriptionsReply

• optional SubscriptionResponse response = 1

  Response message to a telemetry subscription creation or get request.

• repeated Path path_list = 2

  List of data models paths and filters which are used in a telemetry operation.

Response message to a telemetry subscription creation or get request.

Used in: SubscriptionReply

• uint32 subscription_id = 1

  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

Verbosity Level

Used in: GetOperationalStateRequest

• DETAIL = 0

• TERSE = 1

• BRIEF = 2