From af9eaf5dea322c2a6962e33aa7f098dd7ca8ddbd Mon Sep 17 00:00:00 2001 From: Simon Pasquier Date: Thu, 17 Mar 2016 16:22:38 +0100 Subject: [PATCH] Fix typos and bad links in the documentation Change-Id: Iddf8e545a93934ae2acbd3180328a8ac6d1155c7 --- doc/source/installation.rst | 2 +- doc/source/overview.rst | 18 +++++++++--------- doc/source/user.rst | 20 ++++++++++++-------- 3 files changed, 22 insertions(+), 18 deletions(-) diff --git a/doc/source/installation.rst b/doc/source/installation.rst index 2ebb743..2ac5a8b 100644 --- a/doc/source/installation.rst +++ b/doc/source/installation.rst @@ -37,7 +37,7 @@ configuration or implement your own customization. But note that running a Fuel plugin that you have built yourself is at your own risk. To install the LMA Infrastructure Alerting Plugin from source, you first need to prepare an -environement to build the RPM file. +environment to build the RPM file. The recommended approach is to build the RPM file directly onto the Fuel Master node so that you won't have to copy that file later on. diff --git a/doc/source/overview.rst b/doc/source/overview.rst index c20d98f..1728f0f 100644 --- a/doc/source/overview.rst +++ b/doc/source/overview.rst @@ -25,21 +25,21 @@ Requirements | | system, 10GB for the logs and 20GB for Nagios™. As a result, the installation | | | of the plugin will fail if there is less than 45GB of disk space available on the node. | +------------------------+------------------------------------------------------------------------------------------+ -| Fuel | Mirantis OpenStack 8.0 | -+------------------------+------------------------------------------------------------------------------------------+ -| The LMA Collector | v 0.9 | -| Fuel Plugin | | -+------------------------+------------------------------------------------------------------------------------------+ -| The LMA InfluxDB | v 0.9 | -| Grafana Fuel Plugin | This is optional and only needed if you want to create alarms in Nagios™ for | -| | time-series stored in InfluxDB. | -+------------------------+------------------------------------------------------------------------------------------+ | Hardware configuration | The hardware configuration (RAM, CPU, disk) required by this plugin depends on the size | | | of your cloud environment and other parameters like the retention period of the data. | | | | | | A typical setup would at least require a quad-core server with 8GB of RAM and fast disks | | | (ideally, SSDs). | +------------------------+------------------------------------------------------------------------------------------+ +| Mirantis OpenStack | 8.0 | ++------------------------+------------------------------------------------------------------------------------------+ +| The LMA Collector | 0.9 | +| Fuel Plugin | | ++------------------------+------------------------------------------------------------------------------------------+ +| The LMA InfluxDB | 0.9 | +| Grafana Fuel Plugin | This is optional and only needed if you want to create alarms in Nagios™ for | +| | time-series stored in InfluxDB. | ++------------------------+------------------------------------------------------------------------------------------+ Limitations ----------- diff --git a/doc/source/user.rst b/doc/source/user.rst index d601394..c78dd75 100644 --- a/doc/source/user.rst +++ b/doc/source/user.rst @@ -26,7 +26,7 @@ To configure your plugin, you need to follow these steps: as indicated below. a. Change the Nagios web interface password (recommended). - #. Check the boxes corresponding to the type of notification you would. + #. Check the boxes corresponding to the type of notification you would like to be alerted for by email (*CRITICAL*, *WARNING*, *UNKNOWN*, *RECOVERY*). #. Specify the recipient email address for the alerts. #. Specify the sender email address for the alerts. @@ -53,7 +53,7 @@ To configure your plugin, you need to follow these steps: it is possible to add or remove a node with the *Infrastructure_Alerting* role after deployment. -#. Clik on **Apply Changes**. +#. Click on **Apply Changes**. #. Adjust the disk configuration if necessary (see the `Fuel User Guide `_ @@ -139,9 +139,9 @@ those clusters in the OpenStack environment. Configuring service checks on InfluxDB metrics ---------------------------------------------- -You could configure addtional alarms (other than those already defined in the +You can configure additional alarms (other than those already defined in the *LMA Collector*) based on the metrics stored in the InfluxDB database. You -could, for example, define an alert to be notified when the CPU activity for a +can, for example, define an alert to be notified when the CPU activity for a particular process crosses a particular threshold. Say for example, you would like to set a 'warning' alarm at 30% of system CPU usage and a 'criticial' alarm at 50% system CPU usage for the @@ -192,12 +192,12 @@ The steps to define those alarms in Nagios would be as follow: #. Go the Nagios dashboard and verify that the service check has been added. -From there, you could define additional service checks for different hosts or +From there, you can define additional service checks for different hosts or host groups using the same ``check_influx`` command. You will just need to provide these three required arguments for defining new service checks: * A valid InfluxDB query that should return only one row with a single value. - Check the `InfluxDB documentation `_ + Check the `InfluxDB documentation `_ to learn how to use the InfluxDB's query language. * A range specification for the warning threshold. * A range specification for the critical threshold. @@ -290,12 +290,16 @@ If you cannot access the Nagios UI, follow these troubleshooting tips. [root@node-13 ~]# /etc/init.d/apache2 start +#. Look for errors in the Nagios log file (located at /var/log/nagios3/nagios.log). + +#. Look for errors in the Apache log file (located at /var/log/apache2/nagios_error.log). + Finally, Nagios may report a host or service state as *UNKNOWN*. Two cases can be distinguished: * 'UNKNOWN: No datapoint have been received ever', * 'UNKNOWN: No datapoint have been received over the last X seconds'. - + Both cases indicate that Nagios doesn't receive regular passive checks from the *LMA Collector*. This may be due to different problems: @@ -304,5 +308,5 @@ the *LMA Collector*. This may be due to different problems: * One or several alarm rules are misconfigured. To remedy to the above situations, follow the `troubleshooting tips -`_ +`_ of the *LMA Collector Plugin User Guide*.