Browse Source

[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)
tags/0.10.0^0
Maria Zlatkova 2 years ago
parent
commit
944d7da664

BIN
doc/images/collector_settings.png View File


+ 74
- 64
doc/user/source/configure_plugin.rst View File

@@ -15,7 +15,7 @@ Plugin configuration
15 15
    Plugin section. You should see a page like this:
16 16
 
17 17
    .. image:: ../../images/collector_settings.png
18
-      :width: 350pt
18
+      :width: 400pt
19 19
       :alt: The StackLight Collector Plugin settings
20 20
 
21 21
 #. Select :guilabel:`The Logging, Monitoring and Alerting (LMA) Collector
@@ -44,8 +44,6 @@ Plugin configuration
44 44
       method you want to use. Then, specify the SMTP server fully qualified
45 45
       name or IP address, the SMTP username and password to have the
46 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 48
 #. Configure your environment as described in `Configure your environment
51 49
    <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/configure-environment.html>`__.
@@ -106,25 +104,37 @@ Troubleshooting
106 104
 If you see no data in the Kibana and/or Grafana dashboards, follow the
107 105
 instructions 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)
112
-    [root@node-1 ~]# crm resource status metric_collector
113
-    [root@node-1 ~]# crm resource status log_collector
109
+   * On the controller nodes:
114 110
 
115
-    # On non controller nodes
116
-    [root@node-2 ~]# status log_collector
117
-    [root@node-2 ~]# status metric_collector
111
+     .. code-block:: console
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)
122
-    [root@node-1 ~]# crm resource start log_collector
123
-    [root@node-1 ~]# crm resource start metric_collector
116
+   * On non-controller nodes:
124 117
 
125
-    # On non controller nodes
126
-    [root@node-2 ~]# start log_collector
127
-    [root@node-2 ~]# start metric_collector
118
+     .. code-block:: console
119
+   
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 139
 #. Look for errors in the log file of the *collectors* located at
130 140
    ``/var/log/log_collector.log`` and ``/var/log/metric_collector.log``.
@@ -222,53 +232,53 @@ these services manually.
222 232
 
223 233
    .. code-block:: console
224 234
 
225
-      root@node-6:~# source ./openrc
226
-      root@node-6:~# neutron agent-list
227
-      +--------------+-------------------+-------------------+-------------------+-------+
228
-      | id           | agent_type        | host              | availability_zone | alive |
229
-      +--------------+-------------------+-------------------+-------------------+-------+
230
-      | 08a69bad-... | Metadata agent    | node-8.domain.tld |                   | :-)   |
231
-      | 11b6dca6-... | Metadata agent    | node-7.domain.tld |                   | xxx   |
232
-      | 22ea82e3-... | DHCP agent        | node-6.domain.tld | nova              | :-)   |
233
-      | 2d82849e-... | L3 agent          | node-6.domain.tld | nova              | :-)   |
234
-      | 3221ec18-... | Open vSwitch agent| node-6.domain.tld |                   | :-)   |
235
-      | 84bfd240-... | Open vSwitch agent| node-7.domain.tld |                   | xxx   |
236
-      | 9452e8f0-... | Open vSwitch agent| node-9.domain.tld |                   | :-)   |
237
-      | 97136b09-... | Open vSwitch agent| node-8.domain.tld |                   | :-)   |
238
-      | c198bc94-... | DHCP agent        | node-7.domain.tld | nova              | xxx   |
239
-      | c76c4ed4-... | L3 agent          | node-7.domain.tld | nova              | xxx   |
240
-      | d0fd8bb5-... | L3 agent          | node-8.domain.tld | nova              | :-)   |
241
-      | d21f9cea-... | DHCP agent        | node-8.domain.tld | nova              | :-)   |
242
-      | f6f871b7-... | Metadata agent    | node-6.domain.tld |                   | :-)   |
243
-      +--------------+-------------------+-------------------+-------------------+-------+
244
-      root@node-6:~# nova service-list
245
-      +----+------------------+-------------------+----------+---------+-------+-----------------+
246
-      | Id | Binary           | Host              | Zone     | Status  | State |   Updated_at    |
247
-      +----+------------------+-------------------+----------+---------+-------+-----------------+
248
-      | 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|
250
-      | 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|
252
-      | 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|
254
-      | 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|
256
-      | 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|
258
-      | 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|
260
-      | 64 | nova-compute     | node-9.domain.tld | nova     | enabled | up    | 2016-07-19T11:42|
261
-      +----+------------------+-------------------+----------+---------+-------+-----------------+
262
-      root@node-6:~# cinder service-list
263
-      +------------------+-------------------------------+------+---------+-------+-----------------+
264
-      |      Binary      |              Host             | Zone |  Status | State |   Updated_at    |
265
-      +------------------+-------------------------------+------+---------+-------+-----------------+
266
-      |  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|
268
-      | 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|
270
-      |  cinder-volume   | node-9.domain.tld@LVM-backend | nova | enabled | up    | 2016-07-19T11:44|
271
-      +------------------+-------------------------------+------+---------+-------+-----------------+
235
+    root@node-6:~# source ./openrc
236
+    root@node-6:~# neutron agent-list
237
+    +--------------+-------------------+-------------------+-------------------+-------+
238
+    | id           | agent_type        | host              | availability_zone | alive |
239
+    +--------------+-------------------+-------------------+-------------------+-------+
240
+    | 08a69bad-... | Metadata agent    | node-8.domain.tld |                   | :-)   |
241
+    | 11b6dca6-... | Metadata agent    | node-7.domain.tld |                   | xxx   |
242
+    | 22ea82e3-... | DHCP agent        | node-6.domain.tld | nova              | :-)   |
243
+    | 2d82849e-... | L3 agent          | node-6.domain.tld | nova              | :-)   |
244
+    | 3221ec18-... | Open vSwitch agent| node-6.domain.tld |                   | :-)   |
245
+    | 84bfd240-... | Open vSwitch agent| node-7.domain.tld |                   | xxx   |
246
+    | 9452e8f0-... | Open vSwitch agent| node-9.domain.tld |                   | :-)   |
247
+    | 97136b09-... | Open vSwitch agent| node-8.domain.tld |                   | :-)   |
248
+    | c198bc94-... | DHCP agent        | node-7.domain.tld | nova              | xxx   |
249
+    | c76c4ed4-... | L3 agent          | node-7.domain.tld | nova              | xxx   |
250
+    | d0fd8bb5-... | L3 agent          | node-8.domain.tld | nova              | :-)   |
251
+    | d21f9cea-... | DHCP agent        | node-8.domain.tld | nova              | :-)   |
252
+    | f6f871b7-... | Metadata agent    | node-6.domain.tld |                   | :-)   |
253
+    +--------------+-------------------+-------------------+-------------------+-------+
254
+    root@node-6:~# nova service-list
255
+    +--+----------------+-----------------+---------+--------+-------+-----------------+
256
+    |Id|Binary          |Host             | Zone    | Status | State |   Updated_at    |
257
+    +--+----------------+-----------------+---------+--------+-------+-----------------+
258
+    |1 |nova-consoleauth|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|
260
+    |7 |nova-cert       |node-6.domain.tld| internal| enabled| up    | 2016-07-19T11:43|
261
+    |10|nova-conductor  |node-6.domain.tld| internal| enabled| up    | 2016-07-19T11:42|
262
+    |22|nova-cert       |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|
264
+    |28|nova-scheduler  |node-7.domain.tld| internal| enabled| down  | 2016-07-19T11:43|
265
+    |31|nova-cert       |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|
267
+    |37|nova-conductor  |node-7.domain.tld| internal| enabled| down  | 2016-07-19T11:42|
268
+    |43|nova-scheduler  |node-8.domain.tld| internal| enabled| up    | 2016-07-19T11:43|
269
+    |49|nova-conductor  |node-8.domain.tld| internal| enabled| up    | 2016-07-19T11:42|
270
+    |64|nova-compute    |node-9.domain.tld| nova    | enabled| up    | 2016-07-19T11:42|
271
+    +--+----------------+-----------------+---------+--------+-------+-----------------+
272
+    root@node-6:~# cinder service-list
273
+    +----------------+-----------------------------+----+-------+-----+----------------+
274
+    |    Binary      |            Host             |Zone| Status|State|   Updated_at   |
275
+    +----------------+-----------------------------+----+-------+-----+----------------+
276
+    |cinder-backup   |       node-9.domain.tld     |nova|enabled|up   |2016-07-19T11:44|
277
+    |cinder-scheduler|       node-6.domain.tld     |nova|enabled|up   |2016-07-19T11:43|
278
+    |cinder-scheduler|       node-7.domain.tld     |nova|enabled|down |2016-07-19T11:43|
279
+    |cinder-scheduler|       node-8.domain.tld     |nova|enabled|up   |2016-07-19T11:44|
280
+    |cinder-volume   |node-9.domain.tld@LVM-backend|nova|enabled|up   |2016-07-19T11:44|
281
+    +----------------+-----------------------------+----+-------+-----+----------------+
272 282
 
273 283
 #. Remove the services and/or agents that are reported failed on that node:
274 284
 

+ 4
- 4
doc/user/source/install.rst View File

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

+ 2
- 2
doc/user/source/intro.rst View File

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

Loading…
Cancel
Save