Grafana Dashboard Reports

Horizon provides three templates to create a PDF report from an existing Grafana dashboard. You can also schedule and email these PDF reports to anyone:

  • Keep staff without access to Horizon informed about network performance for improved capacity planning

  • Create a permanent record of strategic information and progress over a long period of time

The PDF report displays each of the panels from the specified dashboard, with one, two, or four panels per page, depending on the selected template.

Dashboard to PDF:

PDF report

Before you begin

This feature requires Horizon and an instance of Grafana with at least one dashboard and panel. OpenNMS lets you create a report for any Grafana dashboard, not just those created using OpenNMS Helm.

You must set up Grafana as a data source by configuring the Grafana endpoint in Horizon.

If you are using the Docker image for Grafana, you must complete additional configuration. Refer to Grafana’s Remote rendering service documentation for more information on how to set up remote rendering. Additional details are available on GitHub.

Configure the Grafana endpoint

Configuring the Grafana endpoint sets up Grafana as the data source for the dashboards from which you create PDFs.

  1. Login to your Grafana instance.

  2. Choose Configuration  API Keys New API Key.

  3. Specify a key name and "Viewer" role and click Add.

    1. Leave the time to live blank so that the key never expires.

  4. Copy the key so that you can paste it into the Horizon UI.

    Grafana API

    1. If desired, use the cURL command provided in the API key dialog to test the key.

  5. In OpenNMS, click Please add a Grafana endpoint:

    Endpoint

  6. In the Endpoint Configuration screen click the plus sign on the right to add a new endpoint.

  7. Fill in the information and click Test Connection.

  8. Click Create.

You can now use Horizon to create PDF reports of Grafana dashboards.

Create a PDF of a Grafana dashboard

  1. In the Horizon UI, choose Reports  Database Reports.

  2. In the Report Templates area, click Grafana Dashboard Report <Xppp>, where <Xppp> represents the number of panels per page you want to display.

  3. In the Report Parameters area, specify the appropriate information (see table below).

    1. Note that Grafana Endpoint is the data source. Select a Grafana dashboard from the list.

    2. You can also specify CSV for report type.

  4. Click Create Report.

    1. You are prompted to save the report locally or open it. The file is saved to a folder on the Horizon server. It also appears in the UI in the Persisted Reports tab.

  5. To send the report to someone, click Deliver this report.

  6. Fill out the Report Delivery Options.

    1. If you select Email report, specify the recipient’s email address in the Recipient field. Separate multiple recipient emails with a comma.

    2. Webhook lets you post the generated report to the specified URL.

  7. Click Deliver Report.

  8. To schedule the report for regular delivery, click Schedule this report.

  9. Specify the report frequency (daily, days per week, and so on) and interval of the report.

  10. Click Schedule Report.

Scheduled reports appear in the Report Schedules tab, where you can edit or delete them:

pdf report

Parameters

Field Description Default

Title

Title for the report.

"Grafana Dashboard Report"

Description

Brief description of the report

Time Zone

The time zone for the data in this report. A dropdown provides all the available options.

Default System Time Zone

Start Date

Select the start date for the report.

Yesterday

End Date

Select the end date for the report

Today