x/fuel-plugin-lma-collector
Code Issues Proposed changes
60b2ffac25
fuel-plugin-lma-collector/README.md
Simon Pasquier c728ab6810 Bump version to 0.8.0 
Change-Id: If6c4292ff7016902f75cf8c2d8c0df68862bdca2
2015-07-08 18:35:37 +02:00

4.8 KiB
Raw Blame History

Logging, Monitoring and Alerting (LMA) Collector Plugin for Fuel

Overview

The Logging, Monitoring & Alerting (LMA) collector is a service running on each OpenStack node that collects logs, OpenStack notifications and metrics.

  • Logs and notifications are sent to an Elasticsearch server for diagnostic, troubleshooting and alerting purposes.
  • Metrics are sent to an InfluxDB server for usage and performance analysis as well as alerting purposes.

Requirements

Requirement Version/Comment
Mirantis OpenStack compatility 6.1 or higher
A running Elasticsearch server 1.4 or higher, the RESTful API must be enabled over port 9200
A running InfluxDB server 0.8.8, the RESTful API must be enabled over port 8086

Limitations

The plugin is only compatible with OpenStack environments deployed with Neutron for networking.

Installation Guide

Prior to installing the LMA Collector Plugin, you may want to install its dependencies:

  • Elasticsearch and Kibana
  • InfluxDB and Grafana

To install them automatically using Fuel, you can refer to the Elasticsearch-Kibana Fuel Plugin and InfluxDB-Grafana Fuel Plugin .

You can install Elasticsearch/Kibana and InfluxDB/Grafana outside of Fuel as long as your installation meets the LMA Collector plugin's requirements defined above.

LMA collector plugin installation

To install the LMA Collector plugin, follow these steps:

  1. Download the plugin from the Fuel Plugins Catalog.

  2. Copy the plugin file to the Fuel Master node.

    scp lma_collector-0.8-0.8.0-0.noarch.rpm root@<Fuel Master node IP address>:

  3. Install the plugin using the fuel command line:

    fuel plugins --install lma_collector-0.8-0.8.0-0.noarch.rpm

  4. Verify that the plugin is installed correctly:

    fuel plugins --list

Please refer to the Fuel Plugins wiki if you want to build the plugin by yourself, version 2.0.0 (or higher) of the Fuel Plugin Builder is required.

User Guide

LMA collector plugin configuration

  1. Create a new environment with the Fuel UI wizard.
  2. Click on the Settings tab of the Fuel web UI.
  3. Scroll down the page, select the LMA collector plugin checkbox and fill-in the required fields.

Exploring the data

Refer to the Elasticsearch/Kibana plugin for exploring and visualizing the collected logs and notifications and refer to the InfluxDB-Grafana Fuel Plugin for monitoring your cloud.

Troubleshooting

If you see no data in the Elasticsearch and/or InfluxDB servers, check the following:

  1. The LMA collector service is running

    # On CentOS
/etc/init.d/lma_collector status
# On Ubuntu
status lma_collector

  2. Look for errors in the LMA collector log file (located at /var/log/lma_collector.log) on the different nodes.

  3. Nodes are able to connect to the Elasticsearch server on port 9200.

  4. Nodes are able to connect to the InfluxDB server on port 8086.

Known issues

None

Release Notes

0.8.0

  • Monitoring of the LMA collector.

0.7.0

  • Initial release of the plugin. This is a beta version.

Development

The OpenStack Development Mailing List is the preferred way to communicate, emails should be sent to openstack-dev@lists.openstack.org with the subject prefixed by [fuel][plugins][lma].

Reporting Bugs

Bugs should be filled on the Launchpad fuel-plugins project (not GitHub) with the tag lma.

Contributing

If you would like to contribute to the development of this Fuel plugin you must follow the OpenStack development workflow.

Patch reviews take place on the OpenStack gerrit system.

Contributors