fuel-plugin-lma-collector/README.md

94 lines
3.0 KiB
Markdown

The Logging, Monitoring and Alerting (LMA) Collector Plugin for Fuel
====================================================================
The LMA Collector Plugin for Fuel is used to install and configure
the LMA Collector in OpenStack environments deployed by [Fuel](
https://wiki.openstack.org/wiki/Fuel).
The LMA Collector is an advanced monitoring agent solution that should
be installed on each of the OpenStack nodes you want to monitor.
Please check the [LMA Collector Plugin Overview](
http://fuel-plugin-lma-collector.readthedocs.org/en/latest/user/overview.html)
section of the plugin's documentation for additional details.
Release Notes
-------------
The release notes of the LMA Collector Plugin are provided in the
[Release Notes](
http://fuel-plugin-lma-collector.readthedocs.org/en/latest/user/releases.html)
section of the plugin documentation.
Requirements
------------
The LMA Collector Plugin requirements are defined in the [Requirements](
http://fuel-plugin-lma-collector.readthedocs.org/en/latest/user/overview.html#requirements)
section of the plugin documentation.
Known issues
------------
The LMA Toolchain's related issues are listed on [Launchpad](
https://bugs.launchpad.net/lma-toolchain).
Limitations
-----------
The LMA Collector Plugin limitations are described in the [Limitations](
http://fuel-plugin-lma-collector.readthedocs.org/en/latest/user/overview.html#limitations)
section of the plugin documentation.
Installation
------------
The installation instructions of the LMA Collector Plugin are provided
in the [Installation](
http://fuel-plugin-lma-collector.readthedocs.org/en/latest/user/installation.html#installation)
section of the plugin documentation.
User Guide
----------
Instructions for how to configure the plugin and the alarms
are provided in the [Configuration Guide](
http://fuel-plugin-lma-collector.readthedocs.org/en/latest/user/configuration.html)
and [Alarms Configuration Guide](
http://fuel-plugin-lma-collector.readthedocs.org/en/latest/user/alarms.html)
of the plugin documentation.
Communication
-------------
The *OpenStack Development Mailing List* is the preferred way to communicate
with the members of the project.
Emails should be sent to `openstack-dev@lists.openstack.org` with the subject
prefixed by `[fuel][plugins][lma]`.
Reporting Bugs
--------------
Bugs should be filed against the [LMA Toolchain project](
https://launchpad.net/lma-toolchain) on Launchpad (not Github!).
Contributing
------------
If you would like to contribute to the development of this plugin,
you must follow the [OpenStack development workflow](
http://docs.openstack.org/infra/manual/developers.html#development-workflow)
instructions.
Patch reviews take place on the [OpenStack Gerrit](
https://review.openstack.org/#/q/status:open+project:openstack/fuel-plugin-lma-collector,n,z)
system.
Contributors
------------
* Guillaume Thouvenin <gthouvenin@mirantis.com>
* Patrick Petit <ppetit@mirantis.com>
* Simon Pasquier <spasquier@mirantis.com>
* Swann Croiset <scroiset@mirantis.com>