Integrate NetQ with Grafana

Switches collect statistics about the performance of their interfaces. The NetQ Agent on each switch collects these statistics every 15 seconds and then sends them to your NetQ Appliance or Virtual Machine.

NetQ collects statistics for physical interfaces; it does not collect statistics for virtual interfaces, such as bonds, bridges, and VXLANs.

NetQ displays:

  • Transmit with tx_ prefix: bytes, carrier, colls, drop, errs, packets
  • Receive with rx_ prefix: bytes, drop, errs, frame, multicast, packets

You can use Grafana version 6.x or 7.x, an open source analytics and monitoring tool, to view these statistics. The fastest way to achieve this is by installing Grafana on an application server or locally per user, and then installing the NetQ plug-in.

If you do not have Grafana installed already, refer to grafana.com for instructions on installing and configuring the Grafana tool.

Install NetQ Plug-in for Grafana

Use the Grafana CLI to install the NetQ plug-in. For more detail about this command, refer to the Grafana CLI documentation.

grafana-cli --pluginUrl https://netq-shared.s3-us-west-2.amazonaws.com/grafana/dist.zip plugins install netq-dashboard
installing netq-dashboard @
from: https://netq-shared.s3-us-west-2.amazonaws.com/grafana/dist.zip
into: /usr/local/var/lib/grafana/plugins

✔ Installed netq-dashboard successfully

After installing the plugin a restart of Grafana is required. Restart Grafana according to your implementation.

Set Up the NetQ Data Source

Now that you have the plug-in installed, you need to configure access to the NetQ data source.

  1. Open the Grafana user interface.

  2. Log in using your application credentials.

    The Home Dashboard appears.

  3. Click Add data source or > Data Sources.

  1. Enter Net-Q in the search box. Alternately, scroll down to the Other category, and select it from there.

  1. Enter Net-Q into the Name field.

  2. Enter the URL used to access the database:

    • Cloud: api.netq.cumulusnetworks.com
    • On-premises: <hostname-or-ipaddr-of-netq-appl-or-vm>/api
    • Cumulus in the Cloud (CITC): air.netq.cumulusnetworks.com
  1. Select procdevstats from the Module dropdown.

  2. Enter your credentials (the ones used to log in).

  3. For NetQ cloud deployments only, if you have more than one premises configured, you can select the premises you want to view, as follows:

    • If you leave the Premises field blank, the first premises name is selected by default

    • If you enter a premises name, that premises is selected for viewing

      Note: If multiple premises are configured with the same name, then the first premises of that name is selected for viewing

  4. Click Save & Test.

Create Your NetQ Dashboard

With the data source configured, you can create a dashboard with the transmit and receive statistics of interest to you.

Create a Dashboard

  1. Click to open a blank dashboard.

  2. Click (Dashboard Settings) at the top of the dashboard.

Add Variables

  1. Click Variables.

  2. Enter hostname into the Name field.

  3. Enter hostname into the Label field.

  1. Select Net-Q from the Data source list.

  2. Select On Dashboard Load from the Refresh list.

  3. Enter hostname into the Query field.

  4. Click Add.

    You should see a preview at the bottom of the hostname values.

  5. Click Variables to add another variable for the interface name.

  6. Enter ifname into the Name field.

  7. Enter ifname into the Label field.

  1. Select Net-Q from the Data source list.

  2. Select On Dashboard Load from the Refresh list.

  3. Enter ifname into the Query field.

  4. Click Add.

    You should see a preview at the bottom of the ifname values.

  5. Click Variables to add another variable for metrics.

  6. Enter metrics into the Name field.

  7. Enter metrics into the Label field.

  1. Select Net-Q from the Data source list.

  2. Select On Dashboard Load from the Refresh list.

  3. Enter metrics into the Query field.

  4. Click Add.

    You should see a preview at the bottom of the metrics values.

Add Charts

  1. Now that the variables are defined, click to return to the new dashboard.

  2. Click Add Query.

  1. Select Net-Q from the Query source list.

  2. Select the interface statistic you want to view from the Metric list.

  3. Click the General icon.

  4. Select hostname from the Repeat list.

  5. Set any other parameters around how to display the data.

  6. Return to the dashboard.

  7. Select one or more hostnames from the hostname list.

  8. Select one or more interface names from the ifname list.

  9. Selectric one or more metrics to display for these hostnames and interfaces from the metrics list.

This example shows a dashboard with two hostnames, two interfaces, and one metric selected. The more values you select from the variable options, the more charts appear on your dashboard.

Analyze the Data

Once you have your dashboard configured, you can start analyzing the data. Review the statistics, looking for peaks and valleys, unusual patterns, and so forth. Explore the data more by modifying the data view in one of several ways using the dashboard tool set:

  • Select a different time period for the data by clicking the forward or back arrows. The default time range is dependent on the width of your browser window.
  • Zoom in on the dashboard by clicking the magnifying glass.
  • Manually refresh the dashboard data, or set an automatic refresh rate for the dashboard from the down arrow.
  • Add additional panels
  • Click any chart title to edit or remove it from the dashboard
  • Rename the dashboard by clicking the cog wheel and entering the new name