InfluxDB-Grafana Plugin for Fuel

InfluxDB-Grafana plugin

Overview

InfluxDB provides an open source time series database. Grafana is a rich dashboard and graph editor for InfluxDB.

Requirements

Requirement	Version/Comment
Mirantis OpenStack compatibility	7.0 or higher

Recommendations

None.

Limitations

None.

Installation Guide

InfluxDB-Grafana plugin installation

To install the InfluxDB-Grafana plugin, follow these steps:

1. Download the plugin from the Fuel Plugins Catalog.

2. Copy the plugin file to the Fuel Master node. Follow the Quick start guide if you don't have a running Fuel Master node yet.

   scp influxdb_grafana-0.8-0.8.0-0.noarch.rpm root@<the Fuel Master node IP address>:
   

3. Install the plugin using the fuel command line:

   fuel plugins --install influxdb_grafana-0.8-0.8.0-0.noarch.rpm
   

4. Verify that the plugin is installed correctly:

   fuel plugins
   

Please refer to the Fuel Plugins wiki if you want to build the plugin by yourself, version 3.0.0 (or higher) of the Fuel Plugin Builder is required.

User Guide

InfluxDB-Grafana plugin configuration

1. Create a new environment with the Fuel UI wizard.
2. Click on the Settings tab of the Fuel web UI.
3. Scroll down the page, select the "InfluxDB-Grafana Server plugin" tab, enable the plugin and fill-in the required fields.
   • The password for the InfluxDB root user.
   • The name of the database where you want to store your metrics.
   • The username and the password for this specific database.
   • The name and the password for the Grafana admin user.
4. Add a node with the "InfluxDB Grafana" role.

Disks partitioning

The plugin uses:

• 20% of the first disk for the operating system by honoring the range of 15GB minimum and 50GB maximum.
• 10GB for /var/log.
• at least 30GB for the InfluxDB data (/opt/influxdb).

Testing

InfluxDB

Once installed, you can check that InfluxDB is working using curl:

curl -G 'http://<HOST>:8086/'  \
  --data-urlencode "u=<root user of InfluxDB>" \
  --data-urlencode "p=<password of root user>" \
  --data-urlencode "q=show databases"

Where HOST is the IP address or the name of the node that runs the server and credentials are those provided in the Fuel UI for the InfluxDB root user.

The curl command should return something similar to:

{"results":[{"series":[{"name":"databases","columns":["name"],"values":[["lma"]]}]}]}

Grafana

Grafana is available at:

http://$HOST:8000/

You can login by using the username and password that you provided in the Fuel UI.

Known issues

None.

Release Notes

0.8.0

• Upgrade Grafana to 2.1
• Upgrade InfluxDB to 0.9
• Add support for retention policy

0.7.0

• Initial release of the plugin. This is a beta version.

Development

The OpenStack Development Mailing List is the preferred way to communicate, emails should be sent to openstack-dev@lists.openstack.org with the subject prefixed by [fuel][plugins][lma].

Reporting Bugs

Bugs should be filled on the Launchpad fuel-plugins project (not GitHub) with the tag lma.

Contributing

If you would like to contribute to the development of this Fuel plugin you must follow the OpenStack development workflow.

Patch reviews take place on the OpenStack gerrit system.

Contributors

• Guillaume Thouvenin gthouvenin@mirantis.com
• Simon Pasquier spasquier@mirantis.com
• Swann Croiset scroiset@mirantis.com