x
/
fuel-plugin-influxdb-grafana
Code Issues Proposed changes

Added LMA Toolchain schema and improved figures integration. 

Change-Id: I6b4611893d4b75034eab62a23e6d7875b1ac9b92
This commit is contained in:
Patrick Petit 2015-11-14 11:58:04 -08:00 committed by Swann Croiset
parent 0abce36fdc
commit b99c1a04d1
2 changed files with 66 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
doc/source/overview.rst
View File

@ -12,14 +12,40 @@ The annotations contain insightful information about the detected fault
or anomaly that triggered a change of state for a node cluster or service
cluster as well as textual hints about what might be the root cause of the
fault or anomaly.
The InfluxDB-Grafana Plugin is an indispensable tool to answering
the questions "what has changed, when and why?". Grafana is installed with
a collection of predefined dashboards for each of the OpenStack services.
Among those, the *Main Dashboard* provides a single pane of glass overview
the questions "what has changed in my OpenStack environment,when and why?".
Grafana is installed with
a collection of predefined dashboards for each of the OpenStack services
that are monitored.
Among those dashboards, the *Main Dashboard* provides a single pane of glass overview
of your OpenStack environment status.
The InfluxDB-Grafana Plugin is a key component of the
**Logging, Monitoring and Alerting (LMA) Toolchain** of Mirantis OpenStack.
As shown in the figure below, the InfluxDB-Grafana Plugin is a constituent of the
**Logging, Monitoring and Alerting (LMA) Toolchain** map::
...................................................
| LMA Collector Plugin |
| |
| measurement / collection / analysis / persistence |
'...................................................'
| | |
| | |
| | |
+====================================+ | | | ................................
|| InfluxDB Grafana Plugin || | | | | Elasticsearch Kibana Plugin |
|| ||<--' | '-->| |
|| metrics / annotations analytics || | | logs / notifications analytics |
+====================================+ | '................................'
v
................................
| Infrastructure Alerting Plugin |
| |
| alerting / escalation |
'................................'
.. _plugin_requirements:

40
doc/source/user.rst
View File

@ -18,10 +18,14 @@ To configure your plugin, you need to follow these steps:
#. Scroll down the page and select the InfluxDB-Grafana Plugin in the left column.
The InfluxDB-Grafana Plugin settings screen should appear as shown below.
|
.. image:: ../images/influx_grafana_settings.png
:width: 800
:align: center
|
#. Select the InfluxDB-Grafana Plugin checkbox and fill-in the required fields.
a. Specify the number of days retention period for data.
@ -37,10 +41,14 @@ To configure your plugin, you need to follow these steps:
#. Assign the *InfluxDB Grafana* role to the node where you would like to install
the InfluxDB and Grafana servers as shown below.
|
.. image:: ../images/influx_grafana_role.png
:width: 800
:align: center
|
.. note:: Because of a bug with Fuel 7.0 (see bug `#1496328
<https://bugs.launchpad.net/fuel-plugins/+bug/1496328>`_), the UI won't let
you assign the *InfluxDB Grafana* role if at least one node is already
@ -75,10 +83,14 @@ deploying a Mirantis OpenStack environment can typically take anything
from 30 minutes to several hours. But once your deployment is complete,
you should see a notification that looks like the following:
|
.. image:: ../images/deployment_notification.png
:width: 800
:align: center
|
Verifying InfluxDB
~~~~~~~~~~~~~~~~~~
Once your deployment has completed, you should verify that InfluxDB is
@ -135,10 +147,13 @@ The Grafana user interface runs on port 8000.
Pointing your browser to the URL http://<HOST>:8000/ you should see the
Grafana login page:
|
.. image:: ../images/grafana_login.png
:align: center
:width: 800
|
You should be redirected to the Grafana *Home Page*.
The first time you access Grafana, you are requested to
@ -147,10 +162,14 @@ Once you have authenticated successfully, you should be automatically
redirected to the *Home Page* from where you can select a dashboard as
shown below.
|
.. image:: ../images/grafana_home.png
:align: center
:width: 800
|
Exploring your time-series with Grafana
---------------------------------------
@ -167,12 +186,17 @@ We suggest you start with the *Main Dashboard*, as shown
below. The *Main Dashboard* provides a
single pane of glass to visualize the health
status of all the OpenStack services being monitored
such as Nova or Cinder but also HAProxy, MySQL and RabbitMQ.
such as Nova or Cinder but also HAProxy, MySQL and RabbitMQ to
name a few..
|
.. image:: ../images/grafana_main.png
:align: center
:width: 800
|
As you can see, the *Main Dashboard* (as most dashboards) provides
a drop down menu list in the upper left corner of the window
from where you can select a metric tag (a.k.a dimension) such as
@ -225,10 +249,13 @@ dashboards for each of the OpenStack services being monitored.
For example, if you click through the Nova box, you should see
a screen like this:
|
.. image:: ../images/grafana_nova.png
:align: center
:width: 800
|
The Nova Dashboard
~~~~~~~~~~~~~~~~~~
@ -321,10 +348,13 @@ Nova has changed a state to *warning* because the system has detected
5xx errors and that it may be due to the fact that Neutron is *down*.
An example of what an annotation looks like is shown below.
.. image:: ../images/grafana_nova_annot.png
:align: center
:width: 800
|
.. image:: ../images/grafana_nova_annot.png
:align: center
:width: 800
|
Troubleshooting
---------------
@ -358,5 +388,5 @@ If you get no data in Grafana, follow these troubleshooting tips.
[root@node-37 ~]# /etc/init.d/grafana-server start
* Starting Grafana Server
#. If none of the above solve the problem, check the logs in ``/var/log/influxdb/influxdb.log``
#. If none of the above solves the problem, check the logs in ``/var/log/influxdb/influxdb.log``
and ``/var/log/grafana/grafana.log`` to find out what might have gone wrong.