74 lines
3.3 KiB
Markdown
74 lines
3.3 KiB
Markdown
# Cisco GNMI Telemetry
|
|
|
|
Cisco GNMI Telemetry is an input plugin that consumes telemetry data similar to the [GNMI specification](https://github.com/openconfig/reference/blob/master/rpc/gnmi/gnmi-specification.md).
|
|
This GRPC-based protocol can utilize TLS for authentication and encryption.
|
|
|
|
This plugin has been developed to support GNMI telemetry as produced by Cisco IOS XR (64-bit) version 6.5.1 and later.
|
|
|
|
|
|
### Configuration
|
|
|
|
```toml
|
|
[[inputs.cisco_telemetry_gnmi]]
|
|
## Address and port of the GNMI GRPC server
|
|
addresses = ["10.49.234.114:57777"]
|
|
|
|
## define credentials
|
|
username = "cisco"
|
|
password = "cisco"
|
|
|
|
## GNMI encoding requested (one of: "proto", "json", "json_ietf")
|
|
# encoding = "proto"
|
|
|
|
## redial in case of failures after
|
|
redial = "10s"
|
|
|
|
## enable client-side TLS and define CA to authenticate the device
|
|
# enable_tls = true
|
|
# tls_ca = "/etc/telegraf/ca.pem"
|
|
# insecure_skip_verify = true
|
|
|
|
## define client-side TLS certificate & key to authenticate to the device
|
|
# tls_cert = "/etc/telegraf/cert.pem"
|
|
# tls_key = "/etc/telegraf/key.pem"
|
|
|
|
## GNMI subscription prefix (optional, can usually be left empty)
|
|
## See: https://github.com/openconfig/reference/blob/master/rpc/gnmi/gnmi-specification.md#222-paths
|
|
# origin = ""
|
|
# prefix = ""
|
|
# target = ""
|
|
|
|
## Define additional aliases to map telemetry encoding paths to simple measurement names
|
|
# [inputs.cisco_telemetry_gnmi.aliases]
|
|
# ifcounters = "openconfig:/interfaces/interface/state/counters"
|
|
|
|
[[inputs.cisco_telemetry_gnmi.subscription]]
|
|
## Name of the measurement that will be emitted
|
|
name = "ifcounters"
|
|
|
|
## Origin and path of the subscription
|
|
## See: https://github.com/openconfig/reference/blob/master/rpc/gnmi/gnmi-specification.md#222-paths
|
|
##
|
|
## origin usually refers to a (YANG) data model implemented by the device
|
|
## and path to a specific substructe inside it that should be subscribed to (similar to an XPath)
|
|
## YANG models can be found e.g. here: https://github.com/YangModels/yang/tree/master/vendor/cisco/xr
|
|
origin = "openconfig-interfaces"
|
|
path = "/interfaces/interface/state/counters"
|
|
|
|
# Subscription mode (one of: "target_defined", "sample", "on_change") and interval
|
|
subscription_mode = "sample"
|
|
sample_interval = "10s"
|
|
|
|
## Suppress redundant transmissions when measured values are unchanged
|
|
# suppress_redundant = false
|
|
|
|
## If suppression is enabled, send updates at least every X seconds anyway
|
|
# heartbeat_interval = "60s"
|
|
```
|
|
|
|
### Example Output
|
|
```
|
|
ifcounters,path=openconfig-interfaces:/interfaces/interface/state/counters,host=linux,name=MgmtEth0/RP0/CPU0/0,source=10.49.234.115 in-multicast-pkts=0i,out-multicast-pkts=0i,out-errors=0i,out-discards=0i,in-broadcast-pkts=0i,out-broadcast-pkts=0i,in-discards=0i,in-unknown-protos=0i,in-errors=0i,out-unicast-pkts=0i,in-octets=0i,out-octets=0i,last-clear="2019-05-22T16:53:21Z",in-unicast-pkts=0i 1559145777425000000
|
|
ifcounters,path=openconfig-interfaces:/interfaces/interface/state/counters,host=linux,name=GigabitEthernet0/0/0/0,source=10.49.234.115 out-multicast-pkts=0i,out-broadcast-pkts=0i,in-errors=0i,out-errors=0i,in-discards=0i,out-octets=0i,in-unknown-protos=0i,in-unicast-pkts=0i,in-octets=0i,in-multicast-pkts=0i,in-broadcast-pkts=0i,last-clear="2019-05-22T16:54:50Z",out-unicast-pkts=0i,out-discards=0i 1559145777425000000
|
|
```
|