Create Grafana dashboards


Note: Publish to Grafana is available only as a technology preview.

Overview

Grafana is an open source analytics and monitoring tool which can be used to visualise data from Gateway Hub and create alerts. If you have existing Grafana installs, you can seamlessly integrate data from Gateway Hub into your current dashboards.

Prerequisites

You should already have Grafana installed and configured. For more information consult the Grafana getting started documentation.

You should be familiar with the use of Grafana from the web interface. To learn more about using Grafana see the Grafana getting started guide.

Gateway Hub must have Transport Layer Security (TLS) enabled. For more information about configuring TLS, see Configure transport layer security.

Install the ITRS data source for Grafana

Grafana plug-ins allow you to add new data sources from external applications. To install the ITRS Geneos Gateway Hub Datasource:

  1. Download the grafana-geneos-datasource.<version>.tgz from ITRS Downloads
  2. Navigate to the Grafana plugins directory. The default location is /var/lib/grafana/plugins.
  3. Create a new subdirectory here, for example /itrs-geneos-gateway-hub-datasource.
  4. Extract the plugin file into the subdirectory.

You can also use the grafana-cli tool to install plugins.

For more information on installing Grafana plugins see grafana.com.

Note: The ITRS Geneos Gateway Hub Datasource is only compatible with the Gateway Hub of the same version.

Connecting to Gateway Hub

To fetch data from Gateway Hub, the Grafana host must be able to communicate with your Gateway Hub installation.

To allow this, you must:

Display data from Gateway Hub

Add Gateway Hub as a data source

To add a new data source:

  1. Navigate to your Home Dashboard.
  2. Select Configuration > Data Sources from the sidebar.
  3. Click Add data source.
  4. Select the ITRSGeneosGateway HubDatasource.
  5. Specify the following options:
    1. Name — name for the datasource in Grafana.
    2. URLREST API endpoint of the Gateway Hub in the form https://<hostname>:<port>/<API version>/.
    3. Skip TLS Verify — checked.

    All other options can be left at their default value.

  6. Click Save & Test. You should see a notification to indicate that the data source is correctly configured.

Caution: This feature is currently a technology preview and authentication is not available. This feature should not be used in production environments.

Visualise data from Gateway Hub

To visualise data from Gateway Hub you can create a new panel in a new or existing Grafana dashboard.

To display data from Gateway Hub:

  1. Open a dashboard or create a new dashboard.
  2. Click the Add Panel button.
  3. Click Add Query.
  4. Set the Query to the Gateway HubDatasource using the name you specified above.
  5. Configure the Query using the following options:
    1. Filter— a filter specified in the entity filter syntax, see Entity filter syntax.
    2. Endpoint type — API endpoint used to perform query. Choose from Metric Query, Events, or Entities.

  6. If the Endpoint type is Metric Query, specify:
    1. Group By — attributes included in the Query.
    2. Metrics — metric and aggregations used in the Query.
  7. If the Endpoint type is Events, specify:
    1. Events — event types used in the Query.
    2. Duration — duration bucket size used in the Query.
  8. If the Endpoint type is Entities, specify:
    1. Group By — attributes included in the Query.
  9. Click Visualisation.
  10. Configure the graphical representation of your data.
  11. Click General.
  12. Configure the Panel information.
  13. Click Save Dashboard.

Note: Grafana will validate your dashboard's configuration before saving and alert you to any errors.