Juniper-Grafana is a collection of Python scripts that allows you to visualize statistics and telemetry from Juniper Networks devices using Grafana.
These scripts gather the telemetry data using two different mechanisms:
- Periodic polling of interface traffic counters using NETCONF.
- Stream push of queue depths and latency using Google Protocol Buffers (GPB).
Juniper-Grafana is implemented using:
- InfluxDB as the time-series database.
- Grafana for visualization.
- PyEZ to implement the NETCONF interface to Juniper devices and gather telemetry data such as interface counters.
- Google Protocol Buffers (GPB) to deserialize the analytics records streamed by a Juniper QFX switch.
- The vSRX virtual firewall to generate the telemetry data (as an example).
All examples and scripts below are written for 64-bit Ubuntu 15.04.
This is a personal project for fun. It is not associated with Juniper Networks in any way, shape, or form. There is no guarantee that this works or does anything useful. There is no support. If this causes your network to blow up, you cannot sue me. You have been warned. You are free to use this in any way you see fit subject to a few conditions. See LICENSE file for same information in legalese.
The script 'netconf-poll.py' uses NETCONF to periodically poll a Juniper device, retrieve interface traffic counters, and store them in the InfluxDB time series database.
The script currently supports a limited set of interface statistics: bytes sent, bytes received, packets sent, packets received for every interface. The intent is to add more statistics later on.
Because we use NETCONF to gather telemetry from the device, this should work with any Juniper device including SRX firewalls, MX, PTX, and ACX routers, EX, QFX, and OCX switches, including virtual devices such as the vSRX virtual firewall and the vMX virtual router. We only tested with vSRX.
The script 'gpb-stream.py' consumes Network Analytics records that are streamed using Google Protocol Buffers (GPB) from a Juniper QFX switch.
Network Analytics streaming is supported on Juniper EX and QFX switches running Junos 13.2X50-D15 and later. However, the CLI was changed in a non backwards compatible way in Junos 13.2X51-D15. Here, we use the new CLI.
If not already installed, install Python and PIP:
sudo apt-get install --yes python-pip
sudo apt-get install --yes python-dev
Install InfluxDB for storing the collected telemetry:
wget https://s3.amazonaws.com/influxdb/influxdb_latest_amd64.deb
sudo dpkg -i influxdb_latest_amd64.deb
Start InfluxDB:
sudo /etc/init.d/influxdb start
You need to create a "network" time-series database that we will use later in the demo.
Open the graphical user interface by using a web browser to navigate to URL http://localhost:8083. The default user name is root and the default password is root.
In the "Create Database" form, enter "network" in the Database Name field, and click on the "Create Database" button.
Install Grafana for visualization:
wget https://grafanarel.s3.amazonaws.com/builds/grafana_2.0.2_amd64.deb
sudo apt-get install -y adduser libfontconfig
sudo dpkg -i grafana_2.0.2_amd64.deb
Start Grafana:
sudo service grafana-server start
Open the graphical user interface by using a web browser to navigate to URL http://localhost:3000. The default user name is admin and the default password is admin.
Install PyEZ for the Python NETCONF client
sudo apt-get install --yes libxml2-dev
sudo apt-get install --yes libxslt1-dev
pip install junos-eznc
Install Google Protocol Buffers (GPB) for deserializing the streamed Network Analytics messages
sudo apt-get install --yes python-protobuf
Use the Google Protocol Buffers compiler (protoc) to compile the data model for the stream analytics messages (analytics.proto) into Python code for deserializing those messages:
protoc --python_out=. analytics.proto
This generates a Python module analytics_pb2.py.
You will need some Juniper device to gather statistics from. For NETCONF polling, we use vSRX for testing (for GPB streaming we have to use a physical QFX). If you have a Juniper support account you can download vSRX from http://www.juniper.net/support/downloads/?p=firefly#sw. You can download it as a VMware virtual machine or a KVM virtual machine. Note that the product may be called JunosV Firefly Perimeter (or just Firefly for short) on the download page; that is the old name for vSRX.
Start the downloaded vSRX image using the virtual machine manager of your choice.
Login to the vSRX using the console. The default user name is root and initially it does not have a password (we will set one below).
We use vSRX on VMware Fusion 7 on an Apple iMac. It is a little bit tricky to get the management interface (ge-0/0/0) to come up. You have to go into the VMware Fusion virtual machine settings and configure the first network adapter as follows: enable "Connect Network Adapter" and "Share with my Mac". Then restart the virtual machine. Once vSRX has restarted, connect to the console, login as root (no password), and statically assign an IP address to the ge-0/0/0.0 interface, for example:
root@% cli
root> configure
Entering configuration mode
[edit]
root# set interfaces ge-0/0/0 unit 0 family inet address 192.168.229.185/24
[edit]
root# commit and-quit
commit complete
Exiting configuration mode
You should pick an unused address on the same subnet as vmnet8 interface in the host:
$ ifconfig vmnet8
vmnet8: flags=8863<UP,BROADCAST,SMART,RUNNING,SIMPLEX,MULTICAST> mtu 1500
ether 00:50:56:c0:00:08
inet 192.168.229.1 netmask 0xffffff00 broadcast 192.168.229.255
You also need to create a user to allow NETCONF connections to be established. Junos won't let you commit the configuration change unless you also assign a password to the root user. For example:
test> configure
Entering configuration mode
[edit]
root# set system root-authentication plain-text-password
New password:
Retype new password:
[edit]
root# set system login user test class super-user authentication plain-text-password
New password:
Retype new password:
[edit]
test# commit and-quit
commit complete
Exiting configuration mode
test>
At this point you should be able to SSH into the vSRX.
$ ssh [email protected]
Password:
--- JUNOS 12.1X47-D20.7 built 2015-03-03 21:53:50 UTC
test>
Finally, you also need to enable NETCONF:
test> configure
Entering configuration mode
[edit]
test# set system services netconf ssh
[edit]
test# commit and-quit
commit complete
Exiting configuration mode
test>
We will only use the CLI and NETCONF interface, but in case you are interested, vSRX also provides a web interface: http://192.168.229.185.
The install.sh and startup.sh scripts automate all of the above installation steps, except for vSRX installation.
The netconf-poll.py python script is an example of how to use PyEZ to retrieve statistics from a Juniper device and inject them into an InfluxDB time-series database.
It is not intended to be production quality code: it only collects statistics from a single device, lots of parameters that should be configurable are hard-coded, error handling is non-existent, etc.
The script is very simple. In this section we explain the structure of the code - follow along by reading the netconf-poll.py source code.
The script uses PyEZ to open a NETCONF connection to Juniper device, in our case a vSRX. We use port 22 (SSH) instead of the default port 830 because for some reason port 830 traffic doesn't make it through the VMware NAT between my Linux VM and my vSRX VM.
device = Device(host=device_ip, port=22, user=user_name, passwd=password)
device.open()
We display some information about the device:
switch_name = device.facts['fqdn']
print 'Connected to', switch_name, '(', device.facts['model'], 'running', device.facts['version'], ')'
We determine the list of ports on the device:
ports_table = EthPortTable(device)
We connect to the InfluxDB database. The time-series database "network" was previously created in the installation steps:
db = client.InfluxDBClient('localhost', 8086, 'root', 'root', 'network')
We go into an endless loop. In each iteration we retrieve the operational attributes for the ports:
ports = ports_table.get()
We then iterate over all the ports and create data points for the counters:
for port in ports:
point = {'name': switch_name + '.' + port['name'],
'columns': columns,
'points': [[int(port['rx_packets']),
int(port['rx_bytes']),
int(port['tx_packets']),
int(port['tx_bytes'])]]}
Finally, we write the data points into the time-series database:
db.write_points([point])
We log in to the vSRX and issue a fast ping to generate a burst of traffic to make the graphs look a little bit more interesting:
$ ssh [email protected]
Password:
--- JUNOS 12.1X47-D20.7 built 2015-03-03 21:53:50 UTC
root@% ping -f 192.168.229.185
PING 192.168.229.185 (192.168.229.185): 56 data bytes
.........................................^C.
--- 192.168.229.185 ping statistics ---
6042 packets transmitted, 6000 packets received, 0% packet loss
round-trip min/avg/max/stddev = 0.069/0.090/0.418/0.029 ms
Run the poll-juniper.py script to start gathering statistics:
$ python poll-juniper.py
No handlers could be found for logger "paramiko.hostkeys"
Connected to ( FIREFLY-PERIMETER running 12.1X47-D20.7 )
Connected to InfluxDB
Collecting metrics...
TODO: Explain the data model. Point to the official documentation.
The gpb-stream.py script listens for an incoming TCP connection from a QFX switch, parses the GPB-encoded stream of telemetry data, and stores a subset of the statistics (namely queue depth and latency) in the InfluxDB time-series database.
Once again, this script is intended for instruction. It is not intended for production deployment.
The main function connects to the InfluxDB data and then starts the server:
def main():
db = client.InfluxDBClient('localhost', INFLUX_DB_PORT, 'root', 'root', 'network')
print 'Connected to InfluxDB'
server(db)
The server function accepts an incoming TCP connection and processes telemetry records received over that TCP connection:
def server(db):
sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
sock.bind(('0.0.0.0', ANALYTICS_PORT))
sock.listen(1)
conn, addr = sock.accept()
print 'Accepted incoming TCP connection from', addr
while receive_record(db, conn):
pass
conn.close()
The receive_record function receives a single telemetry record over the TCP connection. Each record consists of an 8-byte header and a variable-length body. The header contains a 4-byte length field for the body, and a 1-byte version number. The body is de-serialized (decoded) using Google Protocol Buffers (GPB). The function to de-serialize the record (analytics_pb2.AnRecord().ParseFromString) is code that was generated by the GPB compiler when we compiled the analytics.proto data model.
def receive_record(db, conn):
data = conn.recv(HEADER_SIZE)
if not data:
print 'Connection closed'
return False
length = ord(data[0]) + (ord(data[1]) << 8) + (ord(data[2]) << 16) + (ord(data[3]) << 24)
version = ord(data[4])
if version != VERSION:
print 'Wrong version ', version
return False
data = conn.recv(length)
if not data:
print 'Connection closed'
return False
record = analytics_pb2.AnRecord()
record.ParseFromString(data)
process_record(db, record)
return True
TODO: Explain the structure of the rest of the code
Unfortunately, we cannot use the vSRX as the device under test to stream telemetry data - it does not support that feature. We have to use a physical QFX5100-Series switch running Junos 13.2X51-D15 or later.
TODO: Explain to configure the QFX to stream telemetry
TODO: Show example output of running the script
We can look at the contents of the "network" time-series database in InfluxDB to make sure that statistics as being collected.
As before, open the graphical user interface by using a web browser to navigate to URL http://localhost:8083. The default user name is root and the default password is root.
Click on "Databases" in the main menu at the top, and click on "Explore Data" for the "networks" database. Enter "select * from /.*/" in the Query field and click on the "Execute Query" button.
You should see graphs and a time-series table for the interface counters.
Now we use Grafana to visualize the counters.
Open the graphical user interface by using a web browser to navigate to URL http://localhost:3000. The default user name is admin and the default password is admin.
Click on the "Grafana" icon in the top left of the screen (it will change into a menu icon when you hover over it)
Select "Data Sources" in the left menu.
Select "Data sources > Add new" in the top menu.
Enter the following information:
| Field | Enter value |
|---|---|
| Name | network |
| Url | http://localhost:8086 |
| Type | InfluxDB 0.8.x |
| Database | network |
| User | root |
| Password | root |
Select "Dashboards" in the left menu.
Select "Home" in the top menu.
Click on the "+ New" button in the drop down menu.
Click on the little green bar in the first and only row, select "Add Panel" in the menu, and then "Graph"
In the graph row, click on "no title (click here)". Select "edit". A new menu will appear below the graph row.
Select "Metrics". Click the button in the bottom right that says "Grafana" (it says Datasource when you hover over it) and select "network" as the data source.
For the first series, enter "/.*/" in the series field. In the select field, click on "mean" and select "difference", then click on "value" and select "tx_packets".
Remove the 2nd and 3rd series by clicking on the "x" button on the right.
Click on "Back to dashboard"
Click on the floppy disk icon at the top (it will say "Save dashboard" when you hover over it)
TODO: Explain the steps
TODO: Show a screen-shot