Grafana Dashboard Box

Grafana provides an API key which gives access for 3rd party application like Horizon. The Grafana Dashboard Box on the start page shows dashboards related to Horizon. To filter relevant dashboards, you can use a tag for dashboards and make them accessible. If no tag is provided all dashboards from Grafana will be shown.

The feature is by default deactivated and is configured by defining a .properties file in the ${OPENNMS_HOME}/etc/opennms.properties.d/ directory. Please note that this feature works with Grafana v2.5.0+.

Figure 1. Quick access to Grafana dashboards from the Horizon start page

Table 1. Grafana Dashboard configuration properties
Name	Description	Type	Default
org.opennms.grafanaBox.show	This setting controls whether a grafana box showing the available dashboards is placed on the landing page.	Boolean	false
org.opennms.grafanaBox.hostname	If the box is enabled you also need to specify hostname of the Grafana server.	String	localhost
org.opennms.grafanaBox.port	The port of the Grafana server ReST API.	Integer	3000
org.opennms.grafanaBox.basePath	The Grafana base path to use.	String
org.opennms.grafanaBox.apiKey	The API key is needed for the ReST calls to work. The process to generate a Grafana API Key can be found in the HTTP API documentation.	String
org.opennms.grafanaBox.tag	When a tag is specified only dashboards with this given tag will be displayed. When no tag is given all dashboards will be displayed.	String
org.opennms.grafanaBox.protocol	The protocol for the ReST call can also be specified.	String	http
org.opennms.grafanaBox.connectionTimeout	Timeout in milliseconds for getting information from the Grafana server.	Integer	500
org.opennms.grafanaBox.soTimeout	Socket timeout.	Integer	500
org.opennms.grafanaBox.dashboardLimit	Maximum number of entries to be displayed (0 for unlimited).	Integer	0
org.opennms.grafanaBox.link.protocol	The protocol used to build each dashboard link URL.	String	org.opennms.grafanaBox.protocol
org.opennms.grafanaBox.link.hostname	Hostname used to build each dashboard link URL.	String	org.opennms.grafanaBox.hostname
org.opennms.grafanaBox.link.port	The port used to build each dashboard link URL.	Integer	org.opennms.grafanaBox.port
org.opennms.grafanaBox.link.basePath	The Grafana base path used to build each dashboard link URL.	String	org.opennms.grafanaBox.basePath

If you have Grafana behind a reverse proxy, you may need to specify the org.opennms.grafanaBox.link.* properties. The "link" properties, if set, are used to build the links that are shown to users, independent of the other properties which are used for internal interaction with the Grafana REST API.