Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/PowerDNS/grafana-metronome


https://github.com/PowerDNS/grafana-metronome

Last synced: 5 days ago
JSON representation

Awesome Lists containing this project

README 

        
# Grafana integration with PowerDNS Metronome



This repository provides integration between the [Grafana dashboard](http://grafana.org/) and [PowerDNS Metronome](https://github.com/ahupowerdns/metronome), allowing you to graph Metronome datasources in Grafana. Pre-made dashboard configurations to monitor PowerDNS services are included (currently only for dnsdist, others coming soon).



Integration is implemented using a custom Metronome loader plugin for the [Graphite-API server](http://graphite-api.readthedocs.io/en/latest/). This API server can be configured as a Graphite data source in Grafana to translate API requests to Metronome's REST API.



It provides a ready-to-run [Docker Compose](https://docs.docker.com/compose/) file to quickly get Grafana and the customized Graphite-API server up and running with a simple `docker-compose up`. 



## Quickstart using Docker



Prerequisites:



 * [Docker](https://docs.docker.com/engine/installation/)

 * [Docker Compose](https://docs.docker.com/compose/)



After cloning this repository, simply run:



    $ docker-compose up



You can add the `-d` flag to start the services in te background.



You will now have Grafana running on  with 'admin' as the default login and password.



After logging in as admin, click on the left-top menu > Data Sources > Add Data Source. Fill out the following fields:



 * Name: make sure to use 'metronome' to be able to use the shipped PowerDNS dashboard configurations. You might want to click 'default' to make it the default data source.

 * Type: graphite

 * Url: http://graphiteproxy (this hostname will be available within the Docker container)

 * Access: proxy

 * No authentication



If you go to your dashboards, your will find a few PowerDNS dashboards that display similar graphs as the default Metronome distribution (currently only for dnsdist, the ones for the recursor and authoritive server are coming soon).



You might want to check the [Grafana Getting Started Guide](http://docs.grafana.org/guides/gettingstarted/) on how to add new dashboards and customize the shipped ones.



## Manual installation



If you want to setup Grafana and Graphite-API yourself without using Docker, you can follow the default documentation for both packages.



In order for Graphite-API to connect to Metronome servers, you need to copy the `graphite-api/metronome/` Python package to your Python site-packages (cleaner method coming soon), and add the following to your Graphite-API configuration file:



    finders:

      - metronome.MetronomeFinder

    metronome:

      # URL of your Metronome instance,

      # or use the public PowerDNS hosted server for testing

      url: https://metrics.powerdns.com/metronome

      # How often to update the list of Metronome metrics (in seconds)

      metrics_cache_expiry: 300



Graphite-API must be run behind an nginx proxy, because its gunicorn sync workers do not handle clients that keep open connection well (crashing workers). 



Under `dashboards/` you will find a few special PowerDNS dashboards JSON files that will help you monitor PowerDNS services. You can either import them in Grafana, or add the directory as a JSON dashboard file loading location to the Grafana configuration. Customizing these is best done by editing `dashboards/generate.py` and running it.



Even if you are not using Docker, you might want to look at the following files for inspiration on how to configure your setup and run Graphite-API:



 * `docker-compose.yml`

 * `grafana.ini`

 * `graphite-api/Dockerfile`

 * `graphite-api/graphite-api.yaml`



## Deploy with HTTP/2 for performance



The grafana web client performs many requests at the same time, one for each graph. Since browsers like Chrome limit the number of connections to one server to six, and fetching the data for one graph can take up to a few seconds, you end up with a staircase of requests in the network panel and very slow performance for large dashboards.



HTTP/2 allows multiplexing many requests over one TCP connection, which removes this connection limit issue. It will allow the frontend to send all requests at once to the server. It is therefore **strongly recommended** to setup a proxy that supports HTTP/2 in front of the grafana server.



Note that most browsers will only talk HTTP/2 to SSL (HTTPS) servers, so you need to get an SSL certificate for your domain name. Also, make sure your web server uses OpenSSL 1.0.2+ (Ubuntu 16.04+), [otherwise HTTP/2 will not work on Chrome](https://www.nginx.com/blog/supporting-http2-google-chrome-users/).



Resources:



 * [How to set up nginx with HTTP/2 support on Ubuntu 16.04](https://www.digitalocean.com/community/tutorials/how-to-set-up-nginx-with-http-2-support-on-ubuntu-16-04) 



## Debugging



Metronome API requests:



 * List of metrics: 

 * Fetch data: 



Graphite-API requests:



 * Query metrics: 

 * Render graph: 

 * Get JSON data: 



## TODO



 * Distribute the Graphite-API metronome loader plugin as a proper Python package.