Skip to content

Getting Started

Installation

Installing on a local Grafana:

For local instances, plugins are installed and updated via a simple CLI command. Plugins are not updated automatically, however you will be notified when updates are available right within your Grafana.

1: Install the Panel

Use the grafana-cli tool to install Network Weathermap from the commandline:

grafana-cli plugins install knightss27-weathermap-panel

The plugin will be installed into your grafana plugins directory; the default is /var/lib/grafana/plugins. More information on the cli tool.

Alternatively, you can manually download the .zip file from the latest release and unpack it into your grafana plugins directory.

2: Add the Panel to a Dashboard

Installed panels are available immediately in the Dashboards section in your Grafana main menu, and can be added like any other core panel in Grafana.

To see a list of installed panels, click the Plugins item in the main menu. Both core panels and installed panels will appear.

Testing

For testing with Docker, follow the instructions on the testing README. This will provide you with an instance to play around with.


Creating a New Weathermap

  1. In Grafana, create a new Empty Panel.
  2. Change the visualisation in the top right corner to Network Weathermap.
  3. You now have a brand new network weathermap panel! 🎉
  4. Learn about weathermap basics below!

On Startup

By default, the panel will start completely blank, looking something like this:

Blank Panel

Adding Nodes

  • Make sure you have selected Edit on the panel in Grafana.
  • On the right hand side, find the Nodes editor.

    Nodes 0

  • Click Add Node to create a new node.

  • Nodes have three basic fields:
    • X position (number): Node's X position.
    • Y position (number): Node's Y position.
    • Label (string): The text visible on the node.
  • You can then move the node by dragging it with your mouse.
  • Ensure you have at least two nodes.
  • On the right hand side, find the Links editor.

    Nodes 1

  • Click Add Link to create a new link.

  • Links are split into two sides, A and B.
  • Each side has four central fields:
    • Side (Node): The node this side of the link connects to.
    • Query (Query): A query representing the current side's throughput in the specified units.
    • Bandwidth # (number): A number representing the bandwidth of this side in specified units.
    • Bandwidth Query (Query): A query representing the bandwidth of this side in the specified units.
    • Units (unit): The units the link expects to recieve its data as. This is used for both the main query and bandwidth. Defaults to bits/sec (SI) (bps).
  • Select A and B side nodes from their respective dropdowns.

Adding Data

  • The weathermap expects a data frame with two fields, a time and a number.
  • You probably want this number in bits/sec, unless your links are expecting something else.
  • The weathermap works best with 'instant' queries, which just use the most recent value retrieved. (Otherwise, the weathermap will always choose the most recent data point possible).
  • Once you have added a query in the panel editor, you can can see all queries and select one from the dropdown in the Query fields of the links.

PLEASE NOTE: Queries with the exact same labels will be considered as such. If you have multiple queries and are unable to select the one that you want, double check to make sure it is labeled uniquely.

Setting Thresholds

  • The weathermap color scale allows you to color links based on their bandwidth usage.
  • On the right hand side, find the Color Scale editor. Nodes 2
  • Click Add Scale Value to create a new threshold.
  • Each threshold has two basic fields:
    • % (number): The percent of bandwidth usage at which to start this threshold.
    • Color (picker): The color of this threshold, can be any valid CSS color chosen or input with the picker.
      • green | #00FF00 | rgb(0, 255, 0)
  • By default, the scale will fill from the highest threshold to 100%. You can see the scale in the top left of the panel. When updating numerical values, click off of the input when you're finished to allow the scale to update.