PNP Grafana Datasource - a Grafana backend datasource using PNP4Nagios to access RRD files

Installation

Search for pnp in the Grafana plugins directory or simply use the grafana-cli command:

grafana-cli plugins install sni-pnp-datasource

Also OMD-Labs comes with this datasource included, so if you use OMD-Labs, everything is setup already.

Otherwise follow these steps:

%> cd var/grafana/plugins
%> git clone -b release-1.0.6  https://github.com/sni/grafana-pnp-datasource.git
%> restart grafana

PNP API

In order to make this datasource work, you need the pnp api. This is a separate project at the moment and will be part of the official pnp in the future. You can fetch the api.php from https://github.com/lingej/pnp-metrics-api and place it in your controler folder.

In a standard PNP setup, you could basically just download the api directly into the controller folder with a simple wget:

wget "https://github.com/lingej/pnp-metrics-api/raw/master/application/controller/api.php" \
     -O /usr/share/pnp4nagios/html/application/controllers/api.php

Adjust the output path to your installation.

Create Datasource

Direct access and proxy datasources are possible. Add a new datasource and select:

Variant A:

Uses the Grafana proxy. Must have a local user which is used for all queries.

- Type 'PNP'
- Url 'https://localhost/sitename/pnp4nagios'
- Access 'proxy'
- Basic Auth 'True'
- User + Password for local pnp user

Variant B:

Uses direct access. PNP must be accessible from the public.

- Type 'PNP'
- Url 'https://yourhost/sitename/pnp4nagios' (Note: this has to be the absolute url)
- Access 'direct'
- Http Auth 'With Credentials'

Example Dashboard

This datasource ships an example dashboard which gets you started and shows the internal PNP statistics.

Queries

Simply select host, service and label in the query editor. Regular expressions are supported in the host and service field by adding slashes like /.*/.

Variables

You may use the following variables in the alias field

- $tag_host: will be replaced with the hostname
- $tag_service: will be replaced with the service name
- $tag_label: will be replaced with the label

Templating

There is basic templating variable support. There are 3 different querys available:

- $host:    hosts
- $service: services where host = /^$host$/
- $label:   labels where host = /^$host$/ and service = /^$service$/

Development

Setup

The easiest way to setup a test environment is to install the latest omd-labs package and clone this repository to to ~/var/grafana/plugins. Make sure there is only one pnp datasource, so you might have to remove the shiped one. Then run grunt watch and eventually restart Grafana after doing changes.

To test and improve the plugin you can run Grafana instance in Docker using following command (in the source directory of this plugin):

docker run --rm -it -v $PWD:/var/lib/grafana/plugins/sni-pnp-datasource
-p 3000:3000 --name grafana.docker
--env=GF_USERS_DEFAULT_THEME=light
grafana/grafana

This will expose local plugin from your machine to Grafana container. Now run grunt to compile dist directory and start changes watcher:

grunt watch

Create Release

How to create a new release: (from https://grafana.com/tutorials/build-a-data-source-plugin/#9)

%> vi src/plugin.json README.md
%> RELVERSION=0.0.1 && \
      git checkout -b release-${RELVERSION} && \
      grunt && \
      git add -f dist && \
      git commit -m "Release v${RELVERSION}" && \
      git tag -a v${RELVERSION} -m "Create release tag v${RELVERSION}" && \
      git push --set-upstream origin release-${RELVERSION} --follow-tags

Changelog

1.0.7 2020-09-11 - improve packaging

1.0.6 2020-06-29 - improve datasource error details - fix plugin beeing loaded twice (#17) - fix dashboard export

1.0.5 2017-11-20 - fix template query parsing

1.0.4 2017-09-29 - add mathematical factor option - fix template variables with latest grafana 4.5.2 - fix replacing template variables in repeated panels

1.0.3 2017-08-18 - add support for host / service / label templating variables

1.0.2 2017-08-16 - add support for warning / critical thresholds - fix accesing series containing spaces

1.0.1 2017-03-13 - plugin id changed according to guidelines - add fallback to pnp name if label does not exist

1.0.0 2017-03-02 - inital release