If you are using the current version of Cumulus NetQ, the content on this page may not be up to date. The current version of the documentation is available here. If you are redirected to the main page of the user guide, then this page may have been renamed; please search for it there.

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 Server or Appliance.

NetQ only collects statistics for physical interfaces; it does not collect statistics for virtual (non-physical) interfaces, such as bonds, bridges, and VXLANs. Specifically, the NetQ Agent collects the following interface statistics:

  • Transmit: tx_bytes, tx_carrier, tx_colls, tx_drop, tx_errs, tx_packets

  • Receive: rx_bytes, rx_drop, rx_errs, rx_frame, rx_multicast, rx_packets

You can use Grafana, an open source analytics and monitoring tool, to view the interface statistics collected by the NetQ Agents. The fastest way to achieve this is by installing Grafana on an application server or locally per user, and then importing the prepared NetQ dashboard.

Install NetQ Plugin for Grafana

The first step is to install the NetQ plugin on your NetQ server or appliance. There are three ways to install the plugin:

  • Docker File: Add the following to your existing Dockerfile

    # grafana docker file
    FROM grafana/grafana:6.2.2
    RUN grafana-cli --pluginUrl https://netq-grafana-dsrc.s3-us-west-2.amazonaws.com/dist.zip plugins install netq-dashboard
  • Grafana Docker Image: Download and run the plugin in your Grafana Docker container

    $ docker run -d -p 3000:3000 --name=grafana -e "GF_INSTALL_PLUGINS=https://netq-grafana-dsrc.s3-us-west-2.amazonaws.com/dist.zip;netq-dashboard" grafana/grafana
  • Grafana CLI: Download and install the Grafana plugin using Grafana CLI

    brew update
    brew install grafana
    brew services start grafana
    grafana-cli --pluginUrl https://netq-grafana-dsrc.s3-us-west-2.amazonaws.com/dist.zip plugins install netq-dashboard
    brew services restart grafana

    Then restart Grafana.

    The Grafana GUI is accessed through port 3000 by default. If you are running Grafana on a simulation server, you may need to modify forwarding rules in IPtables to allow access to port 3000.

Set Up a Dashboard

The quickest way to view the interface statistics for your Cumulus Linux network is to make use of the pre-configured dashboard installed with the plugin. Once you are familiar with that dashboard, you can create new dashboards or add new panels to the NetQ dashboard.

  1. Open the Grafana user interface:

    • Remote access: Enter <NetQ-Server-or-Appliance-IPaddr>:3000 in a web browser address field.
    • Local access: Enter localhost:3000 in a web browser address field.
  2. Log in using your application credentials.

    The Home Dashboard appears.

  3. Click Add data source or > Data Sources.

  4. Enter Net-Q in the search box or scroll down to the Other category, and select Net-Q from there.

  5. Enter Net-Q into the Name field.

  6. Enter the URL used to access the NetQ cloud service; for example api.netq.cumulusnetworks.com

  7. Enter your credentials (the ones used to login)

  8. For 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

  9. Click Save & Test

Create a Dashboard

You can either use the dashboard provided with the plugin, NetQ Interface Statistics, or create your own.

To use the Cumulus-provided dashboard, select the NetQ Interface Statistics from the left panel of the Home Page.

If you choose this option, you can skip directly to analyzing your data.

To create your own dashboard:

  1. Click to open a blank dashboard.

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

  3. Click Variables.

  4. Enter hostname into the Name field.

  5. Enter Hostname into the Label field.

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

  7. Enter hostname into the Query field.

  8. Click Add.

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

  9. Click to return to the new dashboard.

  10. Click Add Query.

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

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

  13. Click the General icon.

  14. Select hostname from the Repeat list.

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

  16. Return to the dashboard.

  17. Add additional panels with other metrics to complete your dashboard.

Analyze the Data

Once you have your dashboard configured, you can start analyzing the data:

  1. Select the hostname from the variable list at the top left of the charts to see the statistics for that switch or host.

  2. Review the statistics, looking for peaks and valleys, unusual patterns, and so forth.

  3. 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 a new variable by clicking the cog wheel, then selecting Variables
    • 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