Stream Telemetry with Telegraf, gNMI and SNMP

www.networktocode.com Network to Code Confidential
How to Introduce Telemetry
Streaming (gNMI) in Your
Network with SNMP with
Telegraf
November 2020

Who is Network to Code?
/company/network-to-code/
@networktocode
• Founded in mid 2014
• Network Automation Solution Provider
– Next-gen consulting and integration company
– Focus on automation/programmability and reducing
operational inefficiencies
– Services only business model
• Vendor Independent
– Infrastructure (Cisco, Juniper, Arista, HP, Cumulus, F5
etc.)
– Open Source Tools (Ansible, Salt, Python, StackStorm,
Puppet, Terraform, Telegraf, InfluxDB, Prometheus,
Grafana, ElasticSearch, Kibana)
– IT Operations Software – ServiceNOW, Remedy, IBM
www.networktocode.com

About David & Josh
David
● Dublin, IE
● Sr Network Automation
Consultant, Network to Code
● Automating Networks since
2013
● Telegraf user since 2019
Josh
● Minnesota, US
● Network Automation
Engineer, Network to Code
● Automating Networks since
2015
● Telegraf user since 2018
@vanderaaj@davidban77 @jvanderaa@davidban77

Agenda
One of the best times to be gathering telemetry data from
network devices!
• Network Streaming Telemetry Stack
• gNMI
• Gathering of Data from Network Devices with Telegraf
• Enriching and Modifying metrics
• Demo
• Wrap Up & Tips and Tricks

Telemetry Stack
Collect
Enrichment
Store
Dashboard
Network Devices

gNMI - Streaming Telemetry

What is gNMI
• Model driven configuration and retrieval of
operational data over gRPC (Remote
Procedure Calls)
• Protocol Buffers
• Subscription model

gNMI Plugin Note
• Previously Cisco gNMI Telemetry
(cisco_telemetry_gnmi)
• Renamed to just gNMI in Telegraf 1.15
• https://github.com/influxdata/telegraf/tree/rel
ease-1.16/plugins/inputs/gnmi

Telegraf for Network Telemetry

What is Telegraf?
• Telegraf is a plugin-driven server agent for
collecting & reporting metrics written in Go
• Pulls metrics from system running on, 3rd
party APIs
• Output plugins to send to various data stores

Telegraf - gNMI
11
[[inputs.gnmi]]
addresses = ["device1"]
username = "<USERNAME>"
password = "<PASSWORD>"
[[inputs.gnmi.subscription]]
origin = "openconfig-interfaces"
path = "/interfaces/interface"
subscription_mode = "sample"
sample_interval = "60s"
Collect Interfaces/interface counters
Base config : Device + Credential

Want to monitor all of this, streaming telemetry
would be terrific

Several devices in your environment do not yet
support Streaming Telemetry!

Hybrid Collection

Telegraf - SNMP
15
[[inputs.snmp]]
agents = ["device1"]
version = 2
community = "<SNMP Community>"
interval = "60s"
timeout = "10s"
retries = 3
[[inputs.snmp.field]]
name = "hostname"
oid = "RFC1213-MIB::sysName.0"
is_tag = true
[[inputs.snmp.table]]
name = "interface"
inherit_tags = [ "hostname" ]
oid = "IF-MIB::ifXTable"
[[inputs.snmp.table.field]]
name = "name"
oid = "IF-MIB::ifDescr"
is_tag = true
Base config : Device, Credential, interval
Convert sysName.0 as tag hostname
Collect IF-MIB::ifXTable Table
Convert ifDescr as Tag name

Challenge with Multiple Input Plugins
16
snmp
gnmi
interface_counters,agent_host=router1,ifName=Ethernet7
ifOutOctets=3814i,ifInOctets=469i 160519
interface,source=192.0.2.10,name=Ethernet7 in_octets=2176i 1605192
interface,source=192.0.2.10,name=Ethernet7 out_octets=316i 1605192
Measurement Tag Set Field Set TimestampInflux Line Protocol:

Telegraf Pipeline

Telegraf Pipeline
snmp
Output Plugin
40+ availableprometheus_client
gnmi Execd
regex
Input Plugins
190+ available
Processors Plugins
25+ available
influxdb
rename
Collect
Data
Enrichment
Output

Data Enrichment

Data Normalization with Telegraf - single device
20
snmp
Output Plugin - Send to InfluxDB
Normalize Data
influxdb_v2
gnmi execd
regex
rename rename rename
Collect Data + Add device level Tags
Enrich Data (add interface role)

# Processor to rename the snmp fields
[[processors.rename]]
[[processors.rename.replace]]
field = "ifHCInOctets"
dest = "in_octets"
field = "ifHCOutOctets"
dest = "out_octets"
tag = "agent_host"
dest = "source"
Telegraf - Rename Data
21
Rename the field ifHCInOctets and ifHCOutOctets to match gNMI
Rename the tag agent_host to match gNMI

Telegraf - Add metadata
22
[[processors.regex]]
[processors.regex.tagpass]
host = device1
[[processors.regex.tags]]
key = "name"
pattern = "^ge-0/0/0$"
replacement = "management"
result_key = "interfacerole"
key = "name"
pattern = "^ge-0/0/1$"
replacement = "data"
result_key = "interfacerole"
Apply these rules only for measurement with a tag host=device1
If a tag name=ge-0/0/0 is present, add a tag interfacerole=management
If a tag name=ge-0/0/1 is present, add a tag interfacerole=data

Demo Environment

Recap
• Collect Data from devices
• Normalize the data
• Enrich the data
• Output the data
• Dashboard of the data

What’s Next & Tips and Tricks

What we are trying to do next?
• Flux language
• InfluxDB 2.0
• InfluxDB IOx
• Additional plugins - Input and Processor
• Starlark processor

Telegraf Tips & Tricks
• Automate configuration with templating - Ansible is a good choice
• Run in Docker
• Install SNMP MIB’s Locally
• Use files output for troubleshooting
• SNMP/gNMI won’t work? Look at writing your own executable
with the execd plugins
• Input Internal Plugin (about the Telegraf Plugin)
• Consider running on device natively
• Use the reachability plugins (Network Response, DNS)
• Look at the Plugin Documentation (search “Telegraf Plugins”)

Monitor Your Network With gNMI, SNMP, and Grafana
http://blog.networktocode.com/post/monitor_your_network_with_gnmi_snmp_and_grafana/
Network Telemetry for SNMP Devices
http://blog.networktocode.com/post/network_telemetry_for_snmp_devices/
Monitoring Websites with Telegraf and
Prometheus
https://blog.networktocode.com/post/monitoring_websites_with_telegraf_and_prometheus/
Network to Code Blog Content

Thank You!
/company/network-to-code/
@networktocode
www.networktocode.com
slack.networktocode.com

Appendix Items

[global_tags]
device_role = "spine"
[agent]
hostname = "telegraf-r1"
Telegraf-R1: Base Input Configuration
[[inputs.snmp]]
agents = ["r1"]
version = 2
community = "${SNMP_COMMUNITY}"
interval = "60s"
timeout = "10s"
retries = 3
[[inputs.snmp.table]]
name = "interface"
oid = "IF-MIB::ifXTable"
[[inputs.snmp.table.field]]
name = "name"
oid = "IF-MIB::ifDescr"
is_tag = true
Cont.

Telegraf -R1 Data Normalization and Enrichment
field = "ifHCInOctets"
dest = "in_octets"
field = "ifHCOutOctets"
dest = "out_octets"
tag = "agent_host"
dest = "device"
namepass = ["interface"]
key = "name"
pattern = "^GigaS+0$"
result_key = "intf_role"
key = "name"
pattern = "^GigaS+0/1$"
replacement = "spine"
key = "name"
pattern = "^GigaS+0/2$"
replacement = "backbone"
Cont.

Telegraf -R1 Output InfluxDB and STDOUT
[[outputs.influxdb]]
urls = ["http://influxdb:8086"]
[[outputs.file]]
files = ["stdout"]
data_format = "influx"

[global_tags]
device_role = "spine"
[agent]
hostname = "telegraf-r2"
Telegraf-R2: Base Input Configuration
Cont.
[[inputs.gnmi]]
addresses = ["r2:6030"]
username = "${GNMI_USER}"
password = "${GNMI_PASSWORD}"
redial = "10s"
[[inputs.gnmi.subscription]]
name = "interface"
origin = "openconfig-interfaces"
path = "/interfaces/interface/state/counters"
subscription_mode = "sample"
sample_interval = "5s"

Telegraf -R2 Data Normalization and Enrichment
Cont.
tag = "source"
dest = "device"
namepass = ["interface"]
key = "name"
pattern = "^Managementd+$"
key = "name"
pattern = "^Ethernet1$"
replacement = "spine"
key = "name"
pattern = "^Ethernet2$"
replacement = "backbone"

Telegraf -R2 Output InfluxDB and STDOUT
[[outputs.influxdb]]
urls = ["http://influxdb:8086"]
[[outputs.file]]
files = ["stdout"]
data_format = "influx"

Stream Telemetry with Telegraf, gNMI and SNMP

Recomendados

Recomendados

Más contenido relacionado

La actualidad más candente

La actualidad más candente (20)

Similar a Stream Telemetry with Telegraf, gNMI and SNMP

Similar a Stream Telemetry with Telegraf, gNMI and SNMP (20)

Más de InfluxData

Más de InfluxData (20)

Último

Último (20)

Stream Telemetry with Telegraf, gNMI and SNMP