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.
Configure this feature by creating or editing the ${OPENNMS_HOME}/etc/opennms.properties.d/grafana.properties file.
| 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 |
The hostname of the Grafana server. You may need to use the IP address or fully qualified domain name, based on your DNS records. |
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. |
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.
|