gNMI (gRPC Network Management Interface) dial-out Input Plugin
This plugin consumes telemetry data based on gNMI messages sent by network devices in dial-out mode. This plugin supports a list of vendor protocols such as Nokia dial-out telemetry.
Introduced in: Telegraf v1.39.0 Tags: network OS support: all
Service Input
This plugin is a service input. Normal plugins gather metrics determined by the interval setting. Service plugins start a service to listen and wait for metrics or events to occur. Service plugins have two key differences from normal plugins:
- The global or plugin specific
intervalsetting may not apply - The CLI options of
--test,--test-wait, and--oncemay not produce output for this plugin
Global configuration options
Plugins support additional global and plugin configuration settings for tasks such as modifying metrics, tags, and fields, creating aliases, and configuring plugin ordering. See CONFIGURATION.md for more details.
Configuration
# gNMI dial-out telemetry plugin
[[inputs.gnmi_listener]]
## Address and port of the gNMI GRPC server
address = "localhost:57400"
## Protocol to use, available options:
## nokia -- Nokia SR OS dial-out protocol
# protocol = "nokia"
## Emit a metric for "delete" messages
# emit_delete_metrics = false
## Enable to get the canonical path as field-name
# canonical_field_names = false
## Remove leading slashes and dots in field-name
# trim_field_names = false
## Prefix tags from path keys with the path element
# prefix_tag_key_with_path = false
## Guess the path-tag if an update does not contain a prefix-path
## Supported values are
## none -- do not add a 'path' tag
## common path -- use the common path elements of all fields in an update
## subscription -- use the subscription path
# path_guessing_strategy = "none"
## Vendor specific options
## This defines what vendor specific options to load.
## * Juniper Header Extension (juniper_header): some sensors are directly managed by
## Linecard, which adds the Juniper GNMI Header Extension. Enabling this
## allows the decoding of the Extension header if present. Currently this knob
## adds component, component_id & sub_component_id as additional tags
# vendor_specific = []
## YANG model paths for decoding IETF JSON payloads
## Model files are loaded recursively from the given directories. Disabled if
## no models are specified.
# yang_model_paths = []
## Used for TLS server certificate authentication
# tls_cert = "/path/to/certfile"
## Used for TLS server certificate authentication
# tls_key = "/path/to/keyfile"
## Password for encrypted key files
# tls_key_pwd = ""
## CA certificates used for verifying client certificates
# tls_allowed_cacerts = []
## List of ciphers to accept, by default all secure ciphers will be accepted
## See https://pkg.go.dev/crypto/tls#pkg-constants for supported values.
## Use "all", "secure" and "insecure" to add all support ciphers, secure
## suites or insecure suites respectively.
# tls_cipher_suites = ["secure"]
## Minimal TLS version to accept by the server
# tls_min_version = "TLS12"
## Maximum TLS version to accept by the server
# tls_max_version = ""
## Whitelist for certificate DNS names to accept
# tls_allowed_dns_names = []Supported Nokia devices
The nokia protocol supports Nokia SR OS devices with dial-out telemetry such
as the following platforms:
- 7250 Interconnect Router (IXR)
- 7450 Ethernet Service Switch (ESS)
- 7750 Service Router (SR)
- 7950 Extensible Routing System (XRS)
- Virtualized Service Router (VSR)
See server implementation for details.
Metrics
Each GNMI message will emit a different measurement. Leaf entries in a GNMI SubscribeResponse Update message will produce a field reading in the measurement. GNMI PathElement keys for leaves will attach tags to the field(s).
Example Output
gnmi,path=openconfig-interfaces:/interfaces/interface/state/counters,host=linux,name=MgmtEth0/RP0/CPU0/0,source=10.49.234.115,descr/description=Foo 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
gnmi,path=openconfig-interfaces:/interfaces/interface/state/counters,host=linux,name=GigabitEthernet0/0/0/0,source=10.49.234.115,descr/description=Bar 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 1559145777425000000Troubleshooting
Missing path tag
Some devices (e.g. Arista) omit the prefix and specify the path in the update
if there is only one value reported. This leads to a missing path tag for
the resulting metrics. In those cases you should set path_guessing_strategy
to subscription to use the subscription path as path tag.
Other devices might omit the prefix in updates altogether. Here setting
path_guessing_strategy to common path can help to infer the path tag by
using the part of the path that is common to all values in the update.
Was this page helpful?
Thank you for your feedback!
Support and feedback
Thank you for being part of our community! We welcome and encourage your feedback and bug reports for Telegraf and this documentation. To find support, use the following resources:
Customers with an annual or support contract can contact InfluxData Support.