x/fuel-plugin-lma-collector
Code Issues Proposed changes

Update documentation

Browse Source 
To reflect the current state of the project.

Change-Id: I9ea622714d47e0050d691ba399e24e24ab445d93
This commit is contained in:
Simon Pasquier
2015-03-10 11:43:30 +01:00
parent ee6032234d
commit 8576e9c083
2 changed files with 18 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
doc/source/common_message_format.rst
View File

@@ -31,17 +31,24 @@ Field Format
Every message (either originating from logs, metrics or notifications) is
populated with a set of predefined fields:
* **deployment_mode** (string), the deployment of the Fuel environment (either
'multinode' or 'ha_compact').
Attributes in **bold** are always present in the messages while attributes in
*italic* are optional.
* **os_environment** (string), the name of the OpenStack environment.
* **deployment_mode** (string), the deployment mode of the Fuel environment
(either 'multinode' or 'ha_compact').
* **os_region** (string), the name of the OpenStack region.
* **deployment_id** (number), the deployment identifier of the Fuel
environment.
* **os_release** (string), the name of the OpenStack release.
* **openstack_region** (string), the name of the OpenStack region.
* **os_roles** (string), a comma-separated list of the node's roles (eg
'controller', 'compute,storage').
* **openstack_release** (string), the name of the OpenStack release.
* **openstack_roles** (string), a comma-separated list of the node's roles (eg
'controller', 'compute,cinder').
* *environment_label* (string), the label assigned to the OpenStack
environment.
.. note:: All date/time fields represented as string are formatted according
to the `RFC3339 <http://tools.ietf.org/html/rfc3339>`_ document.

4
doc/source/logs.rst
View File

@@ -8,10 +8,14 @@ The Heka collector service is configured to tail the following log files:
* System logs.
* ``/var/log/syslog``
* ``/var/log/messages``
* ``/var/log/debug``
* ``/var/log/auth.log``
* ``/var/log/cron.log``
* ``/var/log/daemon.log``
* ``/var/log/kern.log``
* ``/var/log/pacemaker.log``
* MySQL server logs (for controller nodes).