👣 Getting Started

Accessing Grafana

While Grafana will be available on port 3000, to access it use the link: http://your_ip:3000

Note

The default username and password are both admin.

The first time you access it, you will be required to create a new password to ensure secure access.

Integrating the API with Grafana

JSON API

With access to Grafana, go to the menu: Home » Connections » Data sources

Then click on [Add data source]

Look for [JSON API] and click on it.

In the URL field add http://localhost:5000 and set Timeout to 600

Click [Save & test] but before leaving, note that in the URL after “/edit/” you have the uid of the JSON API datasource.
Ex: http://192.168.87.28:3000/connections/datasources/edit/d686f6a48c4a

Note it down

Ex.: d686f6a48c4a

Service accounts (Token)

Now, in the menu Home » Administration » Service accounts, proceed to create a Token (Grafana API). This step is crucial to automate Dashboard imports through RR Flow.

Click on [Add service account]

Fill in the fields Display name: RR Flow API and Role: Admin

Click on [Add service account token]

Click [Generate token]

Click [Copy clipboard]

Note it down

Ex.: glsa_pUL0p6xJMpaY2ZaIVCClX4secEadvNNK_e835939c

Configuring RR Flow API

The API will run on port 5000; to access it use the following link: http://your_ip:5000/login

Note

The default password is remontti

When accessing the panel, you’ll find the API configuration files. All these files are in JSON format and are highly customizable, offering great flexibility to meet various customization needs.

Start by editing config.json

Previously, we noted the Service accounts example d686f6a48c4a and the uid of JSON API example glsa_pUL0p6xJMpaY2ZaIVCClX4secEadvNNK_e835939c

Adjust service_token and datasources with your notes above:

    "grafana": [
        {
            "datasources": "d686f6a48c4a",
            "service_token": "glsa_pUL0p6xJMpaY2ZaIVCClX4secEadvNNK_e835939c",
            "url": "http://localhost:3000"
        }
    ],

Click [Save], [Back], [Services] and [Restart API]

NOTE

Whenever the config.json file is modified, it is necessary to restart the service for the changes to take effect.
You can also restart from the terminal with the command: systemctl restart rr-flow-api.service

Importing Dashboards

You can choose to install or update all dashboards at once by clicking the [Remove and Reinstall All] button. You can also install dashboards individually or delete them as needed.

Warning

If Grafana is on an external server, I am NOT responsible for any accidental removal of other dashboards. I recommend installing each dashboard individually to avoid unwanted losses, or using the Grafana instance from the RR Flow API installation. Starting from version 1.4.0, only Dashboards with the following TAGs will be removed:
RR-FLOW-M RR-FLOW RR-INFO RR-FLOW-HOME RR FLOW

Click [Grafana] and [Remove and Reinstall All]

To access your settings, click on your username at the top right and select [Profile].

Then set Home Dashboard to General/Home and click [Save].

Now, on your home page, you will have access to all available Dashboards.

Add your 1st flow

Read the structure of config.json to understand the general context.

Then proceed with your first source_path and set up the integration with your router.

After integrating your router, restart the API.

Importing SNMP Data

Documentation: interfaces.json
To get interface data click the [Get SNMP data] button, then click the [Get interface data] button.

Documentation: peers.json
Also, do it for [Get Peers data]