[docs] Edits the StackLight Collector plugin docs

Adds minor changes
Changes the collector_settings screenshot
Fixes the commands output to improve the build

This is the final PDF build:
https://drive.google.com/a/mirantis.com/file/d/0B30Lksc8WVCRSGlGb0lFSGZraHc/view?usp=sharing

Change-Id: I928c9eb6a34f5ae801f0806033f1566b9f1fd15a
(cherry picked from commit 4e9f910f1f)
This commit is contained in:
Maria Zlatkova 2016-07-22 15:28:28 +03:00
parent b705ff72ea
commit 944d7da664
4 changed files with 80 additions and 70 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 102 KiB

After

Width:  |  Height:  |  Size: 111 KiB

View File

@ -15,7 +15,7 @@ Plugin configuration
Plugin section. You should see a page like this:
.. image:: ../../images/collector_settings.png
:width: 350pt
:width: 400pt
:alt: The StackLight Collector Plugin settings
#. Select :guilabel:`The Logging, Monitoring and Alerting (LMA) Collector
@ -44,8 +44,6 @@ Plugin configuration
method you want to use. Then, specify the SMTP server fully qualified
name or IP address, the SMTP username and password to have the
permissions to send emails.
#. Specify the Nagios server URL, username, and password if you have chosen
to send alerts to an external Nagios server.
#. Configure your environment as described in `Configure your environment
<http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/configure-environment.html>`__.
@ -106,25 +104,37 @@ Troubleshooting
If you see no data in the Kibana and/or Grafana dashboards, follow the
instructions below to troubleshoot the issue:
#. Verify that the *collector* services are up and running::
#. Verify that the *collector* services are up and running:
# On the controller node(s)
[root@node-1 ~]# crm resource status metric_collector
[root@node-1 ~]# crm resource status log_collector
* On the controller nodes:
# On non controller nodes
[root@node-2 ~]# status log_collector
[root@node-2 ~]# status metric_collector
.. code-block:: console
#. If a *collector* is down, restart it::
[root@node-1 ~]# crm resource status metric_collector
[root@node-1 ~]# crm resource status log_collector
# On the controller node(s)
[root@node-1 ~]# crm resource start log_collector
[root@node-1 ~]# crm resource start metric_collector
* On non-controller nodes:
# On non controller nodes
[root@node-2 ~]# start log_collector
[root@node-2 ~]# start metric_collector
.. code-block:: console
[root@node-2 ~]# status log_collector
[root@node-2 ~]# status metric_collector
#. If a *collector* is down, restart it:
* On the controller nodes:
.. code-block:: console
[root@node-1 ~]# crm resource start log_collector
[root@node-1 ~]# crm resource start metric_collector
* On non-controller nodes:
.. code-block:: console
[root@node-2 ~]# start log_collector
[root@node-2 ~]# start metric_collector
#. Look for errors in the log file of the *collectors* located at
``/var/log/log_collector.log`` and ``/var/log/metric_collector.log``.
@ -222,53 +232,53 @@ these services manually.
.. code-block:: console
root@node-6:~# source ./openrc
root@node-6:~# neutron agent-list
+--------------+-------------------+-------------------+-------------------+-------+
| id | agent_type | host | availability_zone | alive |
+--------------+-------------------+-------------------+-------------------+-------+
| 08a69bad-... | Metadata agent | node-8.domain.tld | | :-) |
| 11b6dca6-... | Metadata agent | node-7.domain.tld | | xxx |
| 22ea82e3-... | DHCP agent | node-6.domain.tld | nova | :-) |
| 2d82849e-... | L3 agent | node-6.domain.tld | nova | :-) |
| 3221ec18-... | Open vSwitch agent| node-6.domain.tld | | :-) |
| 84bfd240-... | Open vSwitch agent| node-7.domain.tld | | xxx |
| 9452e8f0-... | Open vSwitch agent| node-9.domain.tld | | :-) |
| 97136b09-... | Open vSwitch agent| node-8.domain.tld | | :-) |
| c198bc94-... | DHCP agent | node-7.domain.tld | nova | xxx |
| c76c4ed4-... | L3 agent | node-7.domain.tld | nova | xxx |
| d0fd8bb5-... | L3 agent | node-8.domain.tld | nova | :-) |
| d21f9cea-... | DHCP agent | node-8.domain.tld | nova | :-) |
| f6f871b7-... | Metadata agent | node-6.domain.tld | | :-) |
+--------------+-------------------+-------------------+-------------------+-------+
root@node-6:~# nova service-list
+----+------------------+-------------------+----------+---------+-------+-----------------+
| Id | Binary | Host | Zone | Status | State | Updated_at |
+----+------------------+-------------------+----------+---------+-------+-----------------+
| 1 | nova-consoleauth | node-6.domain.tld | internal | enabled | up | 2016-07-19T11:43|
| 4 | nova-scheduler | node-6.domain.tld | internal | enabled | up | 2016-07-19T11:43|
| 7 | nova-cert | node-6.domain.tld | internal | enabled | up | 2016-07-19T11:43|
| 10 | nova-conductor | node-6.domain.tld | internal | enabled | up | 2016-07-19T11:42|
| 22 | nova-cert | node-7.domain.tld | internal | enabled | down | 2016-07-19T11:43|
| 25 | nova-consoleauth | node-7.domain.tld | internal | enabled | down | 2016-07-19T11:43|
| 28 | nova-scheduler | node-7.domain.tld | internal | enabled | down | 2016-07-19T11:43|
| 31 | nova-cert | node-8.domain.tld | internal | enabled | up | 2016-07-19T11:43|
| 34 | nova-consoleauth | node-8.domain.tld | internal | enabled | up | 2016-07-19T11:43|
| 37 | nova-conductor | node-7.domain.tld | internal | enabled | down | 2016-07-19T11:42|
| 43 | nova-scheduler | node-8.domain.tld | internal | enabled | up | 2016-07-19T11:43|
| 49 | nova-conductor | node-8.domain.tld | internal | enabled | up | 2016-07-19T11:42|
| 64 | nova-compute | node-9.domain.tld | nova | enabled | up | 2016-07-19T11:42|
+----+------------------+-------------------+----------+---------+-------+-----------------+
root@node-6:~# cinder service-list
+------------------+-------------------------------+------+---------+-------+-----------------+
| Binary | Host | Zone | Status | State | Updated_at |
+------------------+-------------------------------+------+---------+-------+-----------------+
| cinder-backup | node-9.domain.tld | nova | enabled | up | 2016-07-19T11:44|
| cinder-scheduler | node-6.domain.tld | nova | enabled | up | 2016-07-19T11:43|
| cinder-scheduler | node-7.domain.tld | nova | enabled | down | 2016-07-19T11:43|
| cinder-scheduler | node-8.domain.tld | nova | enabled | up | 2016-07-19T11:44|
| cinder-volume | node-9.domain.tld@LVM-backend | nova | enabled | up | 2016-07-19T11:44|
+------------------+-------------------------------+------+---------+-------+-----------------+
root@node-6:~# source ./openrc
root@node-6:~# neutron agent-list
+--------------+-------------------+-------------------+-------------------+-------+
| id | agent_type | host | availability_zone | alive |
+--------------+-------------------+-------------------+-------------------+-------+
| 08a69bad-... | Metadata agent | node-8.domain.tld | | :-) |
| 11b6dca6-... | Metadata agent | node-7.domain.tld | | xxx |
| 22ea82e3-... | DHCP agent | node-6.domain.tld | nova | :-) |
| 2d82849e-... | L3 agent | node-6.domain.tld | nova | :-) |
| 3221ec18-... | Open vSwitch agent| node-6.domain.tld | | :-) |
| 84bfd240-... | Open vSwitch agent| node-7.domain.tld | | xxx |
| 9452e8f0-... | Open vSwitch agent| node-9.domain.tld | | :-) |
| 97136b09-... | Open vSwitch agent| node-8.domain.tld | | :-) |
| c198bc94-... | DHCP agent | node-7.domain.tld | nova | xxx |
| c76c4ed4-... | L3 agent | node-7.domain.tld | nova | xxx |
| d0fd8bb5-... | L3 agent | node-8.domain.tld | nova | :-) |
| d21f9cea-... | DHCP agent | node-8.domain.tld | nova | :-) |
| f6f871b7-... | Metadata agent | node-6.domain.tld | | :-) |
+--------------+-------------------+-------------------+-------------------+-------+
root@node-6:~# nova service-list
+--+----------------+-----------------+---------+--------+-------+-----------------+
|Id|Binary |Host | Zone | Status | State | Updated_at |
+--+----------------+-----------------+---------+--------+-------+-----------------+
|1 |nova-consoleauth|node-6.domain.tld| internal| enabled| up | 2016-07-19T11:43|
|4 |nova-scheduler |node-6.domain.tld| internal| enabled| up | 2016-07-19T11:43|
|7 |nova-cert |node-6.domain.tld| internal| enabled| up | 2016-07-19T11:43|
|10|nova-conductor |node-6.domain.tld| internal| enabled| up | 2016-07-19T11:42|
|22|nova-cert |node-7.domain.tld| internal| enabled| down | 2016-07-19T11:43|
|25|nova-consoleauth|node-7.domain.tld| internal| enabled| down | 2016-07-19T11:43|
|28|nova-scheduler |node-7.domain.tld| internal| enabled| down | 2016-07-19T11:43|
|31|nova-cert |node-8.domain.tld| internal| enabled| up | 2016-07-19T11:43|
|34|nova-consoleauth|node-8.domain.tld| internal| enabled| up | 2016-07-19T11:43|
|37|nova-conductor |node-7.domain.tld| internal| enabled| down | 2016-07-19T11:42|
|43|nova-scheduler |node-8.domain.tld| internal| enabled| up | 2016-07-19T11:43|
|49|nova-conductor |node-8.domain.tld| internal| enabled| up | 2016-07-19T11:42|
|64|nova-compute |node-9.domain.tld| nova | enabled| up | 2016-07-19T11:42|
+--+----------------+-----------------+---------+--------+-------+-----------------+
root@node-6:~# cinder service-list
+----------------+-----------------------------+----+-------+-----+----------------+
| Binary | Host |Zone| Status|State| Updated_at |
+----------------+-----------------------------+----+-------+-----+----------------+
|cinder-backup | node-9.domain.tld |nova|enabled|up |2016-07-19T11:44|
|cinder-scheduler| node-6.domain.tld |nova|enabled|up |2016-07-19T11:43|
|cinder-scheduler| node-7.domain.tld |nova|enabled|down |2016-07-19T11:43|
|cinder-scheduler| node-8.domain.tld |nova|enabled|up |2016-07-19T11:44|
|cinder-volume |node-9.domain.tld@LVM-backend|nova|enabled|up |2016-07-19T11:44|
+----------------+-----------------------------+----+-------+-----+----------------+
#. Remove the services and/or agents that are reported failed on that node:

View File

@ -45,10 +45,10 @@ customize the plugin.
.. note:: Running a Fuel plugin that you built yourself is at your own risk
and will not be supported.
To install the StackLight Collector Plugin from source, first prepare
an environement to build the RPM file. The recommended approach is to
build the RPM file directly onto the Fuel Master node so that you
will not have to copy that file later on.
To install the StackLight Collector Plugin from source, first prepare an
environment to build the RPM file. The recommended approach is to build the
RPM file directly onto the Fuel Master node so that you will not have to copy
that file later on.
**To prepare an environment and build the plugin:**

View File

@ -19,7 +19,7 @@ The Collector is the key component of the so-called
.. image:: ../../images/toolchain_map.png
:align: center
:width: 80%
:width: 440pt
The Collector is installed on every node of your OpenStack environment. Each
Collector is individually responsible for supporting all the monitoring
@ -39,7 +39,7 @@ The main building blocks of the Collector are as follows:
plugins. Some of them are standard collectd plugins while others are
purpose-built plugins written in Python to perform various OpenStack
services checks.
* **Heka**, `a golang data-processing multifunctional tool by Mozilla
* **Heka**, `a Golang data-processing multifunctional tool by Mozilla
<https://github.com/mozilla-services/heka>`_. Heka supports a number of
standard input and output plugins that allows to ingest data from a variety
of sources including collectd, log files, and RabbitMQ, as well as to