StackLight 0.10 documentation updates
Change-Id: I9cee3e6dfcf9eaada7bd6ee21a8d33a44ae58b07
This commit is contained in:
Patrick Petit
parent
24c6782d0a
commit
84de7734b9
|
|
@ -10,68 +10,77 @@ Plugin configuration
|
|||
|
||||
To configure your plugin, you need to follow these steps:
|
||||
|
||||
1. `Create a new environment <http://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#launch-wizard-to-create-new-environment>`_ with the Fuel web user interface.
|
||||
1. Create a new environment following the `instructions
|
||||
<http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/create-environment/start-create-env.html>`__
|
||||
of the Fuel User Guide.
|
||||
|
||||
2. Click on the 'Settings' tab of the Fuel web UI and select the 'Other' category.
|
||||
2. Click on the *Settings* tab of the Fuel web UI and select the *Other* category.
|
||||
|
||||
3. Scroll down through the settings until you find the 'The Logging, Monitoring and
|
||||
Alerting (LMA) Collector Plugin' section. You should see a page like this.
|
||||
3. Scroll down through the settings until you find the StackLight Collector
|
||||
Plugin section. You should see a page like this.
|
||||
|
||||
.. image:: ../../images/collector_settings.png
|
||||
:width: 350pt
|
||||
:alt: The LMA Collector settings
|
||||
:alt: The StackLight Collector Plugin settings
|
||||
:align: center
|
||||
|
||||
4. Tick the 'The Logging, Monitoring and Alerting (LMA) Collector Plugin' box and
|
||||
4. Tick the StackLight Collector Plugin box and
|
||||
fill-in the required fields as indicated below.
|
||||
|
||||
a. Provide an 'Environment Label' of your choice to tag your data (optional).
|
||||
b. For the 'Events Analytics' destination, select 'Local node' if you plan to use the
|
||||
Elasticsearch-Kibana Plugin in this environment. Otherwise, select 'Remote server'
|
||||
a. Provide an *Environment Label* of your choice to tag your data (optional).
|
||||
b. For the *Events Analytics* destination, select *Local node* if you plan to use the
|
||||
Elasticsearch-Kibana Plugin in the environment. Otherwise, select *Remote server*
|
||||
and specify the fully qualified name or IP address of an external Elasticsearch server.
|
||||
c. For the 'Metrics Analytics' destination, select 'Local node' if you plan to use the
|
||||
InfluxDB-Grafana Plugin in this environment. Otherwise, select 'Remote server' and specify
|
||||
c. For the *Metrics Analytics* destination, select *Local node* if you plan to use the
|
||||
InfluxDB-Grafana Plugin in the environment. Otherwise, select *Remote server* and specify
|
||||
the fully qualified name or IP address of an external InfluxDB server. Then, specify the
|
||||
InfluxDB database name you want to use, a username and password that has read and write
|
||||
InfluxDB database name you want to use, a username and password that have read and write
|
||||
access permissions.
|
||||
d. For 'Alerting', select 'Alerts sent by email' if you want to receive alerts sent by email
|
||||
from the Collector. Otherwise, select 'Alerts sent to a local cluster' if you plan to
|
||||
use the Infrastructure Alerting Plugin in this environment.
|
||||
Alternatively, you can select 'Alerts sent to a remote Nagios server'.
|
||||
e. For 'Alerts sent by email', you can specify the SMTP authentication method you want to use. Then,
|
||||
d. For *Alerting*, select *Alerts sent by email* if you want to receive alerts sent by email
|
||||
from the Collector. Otherwise, select *Alerts sent to a local cluster* if you plan to
|
||||
use the Infrastructure Alerting Plugin (Nagios) in the environment.
|
||||
Alternatively, you can select *Alerts sent to a remote Nagios server*.
|
||||
e. For *Alerts sent by email*, you can specify the SMTP authentication method you want to use. Then,
|
||||
specify the SMTP server fully qualified name or IP address, the SMTP username and password who
|
||||
have the permissions to send emails.
|
||||
f. Finally, specify the Nagios server URL, username and password if you have chosen to send
|
||||
alerts to an external Nagios server.
|
||||
|
||||
5. `Configure your environment <http://docs.mirantis.com/openstack/fuel/fuel-8.0/user-guide.html#configure-your-environment>`_ as needed.
|
||||
5. Configure your environment following the `instructions
|
||||
<http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/configure-environment.html>`__
|
||||
of the Fuel User Guide.
|
||||
|
||||
6. `Assign roles to the nodes <http://docs.mirantis.com/openstack/fuel/fuel-8.0/user-guide.html#assign-a-role-or-roles-to-each-node-server>`_ for the environment.
|
||||
.. note:: By default, StackLight is configured to use the *management network*,
|
||||
of the so called *default node network group* created by Fuel.
|
||||
While this default setup may be appropriate for small deployments or
|
||||
evaluation purposes, it is recommended not to use the default *management network*
|
||||
for StackLight but instead create a dedicated network when configuring your environement.
|
||||
This will improve the performance of both OpenStack and StackLight overall and facilitate
|
||||
the access to the Kibana and Grafana analytics.
|
||||
Please refer to the `StackLight Planning Guide <>`_ for further information about
|
||||
that subject.
|
||||
|
||||
7. `Verify networks <http://docs.mirantis.com/openstack/fuel/fuel-8.0/user-guide.html#verify-networks>`_ on the Networks tab of the Fuel web UI.
|
||||
6. Deploy your environment following the `instructions
|
||||
<http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/deploy-environment.html>`__
|
||||
of the Fuel User Guide.
|
||||
|
||||
8. `Deploy <http://docs.mirantis.com/openstack/fuel/fuel-8.0/user-guide.html#deploy-changes>`_ your changes.
|
||||
|
||||
.. note:: The *LMA Collector Plugin* is a *hot-pluggable* plugin which means
|
||||
that it is possible to install and deploy the *LMA Collector* in an
|
||||
environment that is already deployed. After the installation of the *LMA
|
||||
Collector* plugin, you need to configure the plugin and run the command
|
||||
below from the *Fuel master node* for every OpenStack node of the current
|
||||
deployment, starting with the controller nodes::
|
||||
.. note:: The StackLight Collector Plugin is a *hot-pluggable* plugin which means
|
||||
that it is possible to install and deploy the *collector* in an
|
||||
environment that is already deployed. After the installation of the StackLight
|
||||
Collector Plugin, you will need to define the settings of the plugin and then
|
||||
run the command shown below from the *Fuel master node* for every node of
|
||||
your deployment. You need to start with *the controller node(s)*::
|
||||
|
||||
[root@nailgun ~]# fuel nodes --env <env_id> --node <node_id> --start \
|
||||
post_deployment_start
|
||||
|
||||
If you want to deploy new nodes at the same time (for instance to run
|
||||
InfluxDB, Elasticsearch and/or Nagios), you should deploy them first.
|
||||
post_deployment_start --tasks hiera
|
||||
|
||||
.. _plugin_verification:
|
||||
|
||||
Plugin verification
|
||||
-------------------
|
||||
|
||||
Once the OpenStack environment is ready, you may want to check that both
|
||||
the 'collectd' and 'hekad' processes are running on the OpenStack nodes::
|
||||
Once the OpenStack environment is ready, you should check that both
|
||||
the *collectd* and *hekad* processes are running on the OpenStack nodes::
|
||||
|
||||
[root@node-1 ~]# pidof hekad
|
||||
5568
|
||||
|
|
@ -79,14 +88,19 @@ the 'collectd' and 'hekad' processes are running on the OpenStack nodes::
|
|||
[root@node-1 ~]# pidof collectd
|
||||
5684
|
||||
|
||||
.. note:: Starting with StackLight version 0.10, there is not one but two *hekad* processes
|
||||
running. One is used to collect and process the logs and the notifications, the
|
||||
other one is used to process the metrics.
|
||||
|
||||
.. _troubleshooting:
|
||||
|
||||
Troubleshooting
|
||||
---------------
|
||||
|
||||
If you see no data in the Kibana and/or Grafana dashboards, use the instructions below to troubleshoot the problem:
|
||||
If you see no data in the Kibana and/or Grafana dashboards,
|
||||
use the instructions below to troubleshoot the problem:
|
||||
|
||||
1. Check if LMA Collector services are up and running::
|
||||
1. Check that the *collector* services are up and running::
|
||||
|
||||
# On the controller node(s)
|
||||
[root@node-1 ~]# crm resource status metric_collector
|
||||
|
|
@ -96,7 +110,7 @@ If you see no data in the Kibana and/or Grafana dashboards, use the instructions
|
|||
[root@node-2 ~]# status log_collector
|
||||
[root@node-2 ~]# status metric_collector
|
||||
|
||||
2. If one of the LMA Collectors is down, restart it::
|
||||
2. If a *collector* is down, restart it::
|
||||
|
||||
# On the controller node(s)
|
||||
[root@node-1 ~]# crm resource start log_collector
|
||||
|
|
@ -106,10 +120,10 @@ If you see no data in the Kibana and/or Grafana dashboards, use the instructions
|
|||
[root@node-2 ~]# start log_collector
|
||||
[root@node-2 ~]# start metric_collector
|
||||
|
||||
3. Look for errors in the LMA Collector log file (located at /var/log/log_collector.log and /var/log/metric_collector.log)
|
||||
on the different nodes.
|
||||
3. Look for errors in the log file of the *collectors*
|
||||
(located at /var/log/log_collector.log and /var/log/metric_collector.log).
|
||||
|
||||
4. Look for errors in the collectd log file (located at /var/log/collectd.log) on the different nodes.
|
||||
4. Look for errors in the log file of *collectd* (located at /var/log/collectd.log).
|
||||
|
||||
5. Check if the nodes are able to connect to the Elasticsearch server on port 9200.
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue