summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMaria Zlatkova <mzlatkova@mirantis.com>2016-07-22 15:28:28 +0300
committerMaria Zlatkova <mzlatkova@mirantis.com>2016-07-22 14:01:33 +0000
commit944d7da66414b6ff686a8be3e1f71a0eef136a8e (patch)
tree7c28cd39aa1379c87d9b5ab8f2599e5da251cdf2
parentb705ff72ea1ae364af01edb2a588d8642357fe02 (diff)
[docs] Edits the StackLight Collector plugin docs0.10.0
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 4e9f910f1f5f94d73af2a091ba62cc4cbf0b8ff4)
Notes
Notes (review): Code-Review+2: Simon Pasquier <spasquier@mirantis.com> Workflow+1: Simon Pasquier <spasquier@mirantis.com> Verified+2: Jenkins Submitted-by: Jenkins Submitted-at: Fri, 22 Jul 2016 14:33:08 +0000 Reviewed-on: https://review.openstack.org/346047 Project: openstack/fuel-plugin-lma-collector Branch: refs/heads/stable/0.10
-rw-r--r--doc/images/collector_settings.pngbin104329 -> 113862 bytes
-rw-r--r--doc/user/source/configure_plugin.rst138
-rw-r--r--doc/user/source/install.rst8
-rw-r--r--doc/user/source/intro.rst4
4 files changed, 80 insertions, 70 deletions
diff --git a/doc/images/collector_settings.png b/doc/images/collector_settings.png
index 9160928..c5a1ad6 100644
--- a/doc/images/collector_settings.png
+++ b/doc/images/collector_settings.png
Binary files differ
diff --git a/doc/user/source/configure_plugin.rst b/doc/user/source/configure_plugin.rst
index 397c15d..cae9b9e 100644
--- a/doc/user/source/configure_plugin.rst
+++ b/doc/user/source/configure_plugin.rst
@@ -15,7 +15,7 @@ Plugin configuration
15 Plugin section. You should see a page like this: 15 Plugin section. You should see a page like this:
16 16
17 .. image:: ../../images/collector_settings.png 17 .. image:: ../../images/collector_settings.png
18 :width: 350pt 18 :width: 400pt
19 :alt: The StackLight Collector Plugin settings 19 :alt: The StackLight Collector Plugin settings
20 20
21#. Select :guilabel:`The Logging, Monitoring and Alerting (LMA) Collector 21#. Select :guilabel:`The Logging, Monitoring and Alerting (LMA) Collector
@@ -44,8 +44,6 @@ Plugin configuration
44 method you want to use. Then, specify the SMTP server fully qualified 44 method you want to use. Then, specify the SMTP server fully qualified
45 name or IP address, the SMTP username and password to have the 45 name or IP address, the SMTP username and password to have the
46 permissions to send emails. 46 permissions to send emails.
47 #. Specify the Nagios server URL, username, and password if you have chosen
48 to send alerts to an external Nagios server.
49 47
50#. Configure your environment as described in `Configure your environment 48#. Configure your environment as described in `Configure your environment
51 <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/configure-environment.html>`__. 49 <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/configure-environment.html>`__.
@@ -106,25 +104,37 @@ Troubleshooting
106If you see no data in the Kibana and/or Grafana dashboards, follow the 104If you see no data in the Kibana and/or Grafana dashboards, follow the
107instructions below to troubleshoot the issue: 105instructions below to troubleshoot the issue:
108 106
109#. Verify that the *collector* services are up and running:: 107#. Verify that the *collector* services are up and running:
110 108
111 # On the controller node(s) 109 * On the controller nodes:
112 [root@node-1 ~]# crm resource status metric_collector
113 [root@node-1 ~]# crm resource status log_collector
114 110
115 # On non controller nodes 111 .. code-block:: console
116 [root@node-2 ~]# status log_collector
117 [root@node-2 ~]# status metric_collector
118 112
119#. If a *collector* is down, restart it:: 113 [root@node-1 ~]# crm resource status metric_collector
114 [root@node-1 ~]# crm resource status log_collector
120 115
121 # On the controller node(s) 116 * On non-controller nodes:
122 [root@node-1 ~]# crm resource start log_collector
123 [root@node-1 ~]# crm resource start metric_collector
124 117
125 # On non controller nodes 118 .. code-block:: console
126 [root@node-2 ~]# start log_collector 119
127 [root@node-2 ~]# start metric_collector 120 [root@node-2 ~]# status log_collector
121 [root@node-2 ~]# status metric_collector
122
123#. If a *collector* is down, restart it:
124
125 * On the controller nodes:
126
127 .. code-block:: console
128
129 [root@node-1 ~]# crm resource start log_collector
130 [root@node-1 ~]# crm resource start metric_collector
131
132 * On non-controller nodes:
133
134 .. code-block:: console
135
136 [root@node-2 ~]# start log_collector
137 [root@node-2 ~]# start metric_collector
128 138
129#. Look for errors in the log file of the *collectors* located at 139#. Look for errors in the log file of the *collectors* located at
130 ``/var/log/log_collector.log`` and ``/var/log/metric_collector.log``. 140 ``/var/log/log_collector.log`` and ``/var/log/metric_collector.log``.
@@ -222,53 +232,53 @@ these services manually.
222 232
223 .. code-block:: console 233 .. code-block:: console
224 234
225 root@node-6:~# source ./openrc 235 root@node-6:~# source ./openrc
226 root@node-6:~# neutron agent-list 236 root@node-6:~# neutron agent-list
227 +--------------+-------------------+-------------------+-------------------+-------+ 237 +--------------+-------------------+-------------------+-------------------+-------+
228 | id | agent_type | host | availability_zone | alive | 238 | id | agent_type | host | availability_zone | alive |
229 +--------------+-------------------+-------------------+-------------------+-------+ 239 +--------------+-------------------+-------------------+-------------------+-------+
230 | 08a69bad-... | Metadata agent | node-8.domain.tld | | :-) | 240 | 08a69bad-... | Metadata agent | node-8.domain.tld | | :-) |
231 | 11b6dca6-... | Metadata agent | node-7.domain.tld | | xxx | 241 | 11b6dca6-... | Metadata agent | node-7.domain.tld | | xxx |
232 | 22ea82e3-... | DHCP agent | node-6.domain.tld | nova | :-) | 242 | 22ea82e3-... | DHCP agent | node-6.domain.tld | nova | :-) |
233 | 2d82849e-... | L3 agent | node-6.domain.tld | nova | :-) | 243 | 2d82849e-... | L3 agent | node-6.domain.tld | nova | :-) |
234 | 3221ec18-... | Open vSwitch agent| node-6.domain.tld | | :-) | 244 | 3221ec18-... | Open vSwitch agent| node-6.domain.tld | | :-) |
235 | 84bfd240-... | Open vSwitch agent| node-7.domain.tld | | xxx | 245 | 84bfd240-... | Open vSwitch agent| node-7.domain.tld | | xxx |
236 | 9452e8f0-... | Open vSwitch agent| node-9.domain.tld | | :-) | 246 | 9452e8f0-... | Open vSwitch agent| node-9.domain.tld | | :-) |
237 | 97136b09-... | Open vSwitch agent| node-8.domain.tld | | :-) | 247 | 97136b09-... | Open vSwitch agent| node-8.domain.tld | | :-) |
238 | c198bc94-... | DHCP agent | node-7.domain.tld | nova | xxx | 248 | c198bc94-... | DHCP agent | node-7.domain.tld | nova | xxx |
239 | c76c4ed4-... | L3 agent | node-7.domain.tld | nova | xxx | 249 | c76c4ed4-... | L3 agent | node-7.domain.tld | nova | xxx |
240 | d0fd8bb5-... | L3 agent | node-8.domain.tld | nova | :-) | 250 | d0fd8bb5-... | L3 agent | node-8.domain.tld | nova | :-) |
241 | d21f9cea-... | DHCP agent | node-8.domain.tld | nova | :-) | 251 | d21f9cea-... | DHCP agent | node-8.domain.tld | nova | :-) |
242 | f6f871b7-... | Metadata agent | node-6.domain.tld | | :-) | 252 | f6f871b7-... | Metadata agent | node-6.domain.tld | | :-) |
243 +--------------+-------------------+-------------------+-------------------+-------+ 253 +--------------+-------------------+-------------------+-------------------+-------+
244 root@node-6:~# nova service-list 254 root@node-6:~# nova service-list
245 +----+------------------+-------------------+----------+---------+-------+-----------------+ 255 +--+----------------+-----------------+---------+--------+-------+-----------------+
246 | Id | Binary | Host | Zone | Status | State | Updated_at | 256 |Id|Binary |Host | Zone | Status | State | Updated_at |
247 +----+------------------+-------------------+----------+---------+-------+-----------------+ 257 +--+----------------+-----------------+---------+--------+-------+-----------------+
248 | 1 | nova-consoleauth | node-6.domain.tld | internal | enabled | up | 2016-07-19T11:43| 258 |1 |nova-consoleauth|node-6.domain.tld| internal| enabled| up | 2016-07-19T11:43|
249 | 4 | nova-scheduler | node-6.domain.tld | internal | enabled | up | 2016-07-19T11:43| 259 |4 |nova-scheduler |node-6.domain.tld| internal| enabled| up | 2016-07-19T11:43|
250 | 7 | nova-cert | node-6.domain.tld | internal | enabled | up | 2016-07-19T11:43| 260 |7 |nova-cert |node-6.domain.tld| internal| enabled| up | 2016-07-19T11:43|
251 | 10 | nova-conductor | node-6.domain.tld | internal | enabled | up | 2016-07-19T11:42| 261 |10|nova-conductor |node-6.domain.tld| internal| enabled| up | 2016-07-19T11:42|
252 | 22 | nova-cert | node-7.domain.tld | internal | enabled | down | 2016-07-19T11:43| 262 |22|nova-cert |node-7.domain.tld| internal| enabled| down | 2016-07-19T11:43|
253 | 25 | nova-consoleauth | node-7.domain.tld | internal | enabled | down | 2016-07-19T11:43| 263 |25|nova-consoleauth|node-7.domain.tld| internal| enabled| down | 2016-07-19T11:43|
254 | 28 | nova-scheduler | node-7.domain.tld | internal | enabled | down | 2016-07-19T11:43| 264 |28|nova-scheduler |node-7.domain.tld| internal| enabled| down | 2016-07-19T11:43|
255 | 31 | nova-cert | node-8.domain.tld | internal | enabled | up | 2016-07-19T11:43| 265 |31|nova-cert |node-8.domain.tld| internal| enabled| up | 2016-07-19T11:43|
256 | 34 | nova-consoleauth | node-8.domain.tld | internal | enabled | up | 2016-07-19T11:43| 266 |34|nova-consoleauth|node-8.domain.tld| internal| enabled| up | 2016-07-19T11:43|
257 | 37 | nova-conductor | node-7.domain.tld | internal | enabled | down | 2016-07-19T11:42| 267 |37|nova-conductor |node-7.domain.tld| internal| enabled| down | 2016-07-19T11:42|
258 | 43 | nova-scheduler | node-8.domain.tld | internal | enabled | up | 2016-07-19T11:43| 268 |43|nova-scheduler |node-8.domain.tld| internal| enabled| up | 2016-07-19T11:43|
259 | 49 | nova-conductor | node-8.domain.tld | internal | enabled | up | 2016-07-19T11:42| 269 |49|nova-conductor |node-8.domain.tld| internal| enabled| up | 2016-07-19T11:42|
260 | 64 | nova-compute | node-9.domain.tld | nova | enabled | up | 2016-07-19T11:42| 270 |64|nova-compute |node-9.domain.tld| nova | enabled| up | 2016-07-19T11:42|
261 +----+------------------+-------------------+----------+---------+-------+-----------------+ 271 +--+----------------+-----------------+---------+--------+-------+-----------------+
262 root@node-6:~# cinder service-list 272 root@node-6:~# cinder service-list
263 +------------------+-------------------------------+------+---------+-------+-----------------+ 273 +----------------+-----------------------------+----+-------+-----+----------------+
264 | Binary | Host | Zone | Status | State | Updated_at | 274 | Binary | Host |Zone| Status|State| Updated_at |
265 +------------------+-------------------------------+------+---------+-------+-----------------+ 275 +----------------+-----------------------------+----+-------+-----+----------------+
266 | cinder-backup | node-9.domain.tld | nova | enabled | up | 2016-07-19T11:44| 276 |cinder-backup | node-9.domain.tld |nova|enabled|up |2016-07-19T11:44|
267 | cinder-scheduler | node-6.domain.tld | nova | enabled | up | 2016-07-19T11:43| 277 |cinder-scheduler| node-6.domain.tld |nova|enabled|up |2016-07-19T11:43|
268 | cinder-scheduler | node-7.domain.tld | nova | enabled | down | 2016-07-19T11:43| 278 |cinder-scheduler| node-7.domain.tld |nova|enabled|down |2016-07-19T11:43|
269 | cinder-scheduler | node-8.domain.tld | nova | enabled | up | 2016-07-19T11:44| 279 |cinder-scheduler| node-8.domain.tld |nova|enabled|up |2016-07-19T11:44|
270 | cinder-volume | node-9.domain.tld@LVM-backend | nova | enabled | up | 2016-07-19T11:44| 280 |cinder-volume |node-9.domain.tld@LVM-backend|nova|enabled|up |2016-07-19T11:44|
271 +------------------+-------------------------------+------+---------+-------+-----------------+ 281 +----------------+-----------------------------+----+-------+-----+----------------+
272 282
273#. Remove the services and/or agents that are reported failed on that node: 283#. Remove the services and/or agents that are reported failed on that node:
274 284
diff --git a/doc/user/source/install.rst b/doc/user/source/install.rst
index 80dd25c..ebd3de7 100644
--- a/doc/user/source/install.rst
+++ b/doc/user/source/install.rst
@@ -45,10 +45,10 @@ customize the plugin.
45.. note:: Running a Fuel plugin that you built yourself is at your own risk 45.. note:: Running a Fuel plugin that you built yourself is at your own risk
46 and will not be supported. 46 and will not be supported.
47 47
48To install the StackLight Collector Plugin from source, first prepare 48To install the StackLight Collector Plugin from source, first prepare an
49an environement to build the RPM file. The recommended approach is to 49environment to build the RPM file. The recommended approach is to build the
50build the RPM file directly onto the Fuel Master node so that you 50RPM file directly onto the Fuel Master node so that you will not have to copy
51will not have to copy that file later on. 51that file later on.
52 52
53**To prepare an environment and build the plugin:** 53**To prepare an environment and build the plugin:**
54 54
diff --git a/doc/user/source/intro.rst b/doc/user/source/intro.rst
index 21b6720..6f64ec2 100644
--- a/doc/user/source/intro.rst
+++ b/doc/user/source/intro.rst
@@ -19,7 +19,7 @@ The Collector is the key component of the so-called
19 19
20.. image:: ../../images/toolchain_map.png 20.. image:: ../../images/toolchain_map.png
21 :align: center 21 :align: center
22 :width: 80% 22 :width: 440pt
23 23
24The Collector is installed on every node of your OpenStack environment. Each 24The Collector is installed on every node of your OpenStack environment. Each
25Collector is individually responsible for supporting all the monitoring 25Collector is individually responsible for supporting all the monitoring
@@ -39,7 +39,7 @@ The main building blocks of the Collector are as follows:
39 plugins. Some of them are standard collectd plugins while others are 39 plugins. Some of them are standard collectd plugins while others are
40 purpose-built plugins written in Python to perform various OpenStack 40 purpose-built plugins written in Python to perform various OpenStack
41 services checks. 41 services checks.
42* **Heka**, `a golang data-processing multifunctional tool by Mozilla 42* **Heka**, `a Golang data-processing multifunctional tool by Mozilla
43 <https://github.com/mozilla-services/heka>`_. Heka supports a number of 43 <https://github.com/mozilla-services/heka>`_. Heka supports a number of
44 standard input and output plugins that allows to ingest data from a variety 44 standard input and output plugins that allows to ingest data from a variety
45 of sources including collectd, log files, and RabbitMQ, as well as to 45 of sources including collectd, log files, and RabbitMQ, as well as to