Document the GSE metrics

Change-Id: I2d81c40d800a23695eb6eb18c41979f383e08e3b
This commit is contained in:
Simon Pasquier 2015-11-25 15:29:56 +01:00
parent 13c2ccf5d5
commit 57a8481b53
2 changed files with 49 additions and 4 deletions

View File

@ -24,15 +24,30 @@ Attributes in **bold** are always present in the messages while attributes in
* **Logger** (string), the datasource from the Heka's standpoint, it can be * **Logger** (string), the datasource from the Heka's standpoint, it can be
``collectd``, ``notification_processor`` or ``http_log_parser``. ``collectd``, ``notification_processor`` or ``http_log_parser``.
* **Type** (string), either ``metric`` or ``heka.sandbox.metric`` (for metrics * **Type** (string)
derived from other messages).
* **Severity** (number), it is always equal to 6 (eg INFO). * ``metric`` or ``heka.sandbox.metric`` for the single-value metrics.
* ``heka.sandbox.multivalue_metric`` for the multi-valued metrics (eg annotations).
* ``heka.sandbox.bulk_metric`` for the metrics sent by bulk.
* ``heka.sandbox.afd_service_metric`` for the AFD service metrics.
* ``heka.sandbox.afd_node_metric`` for the AFD node metrics.
* ``heka.sandbox.gse_service_cluster_metric`` for the GSE service cluster metrics.
* ``heka.sandbox.gse_node_cluster_metric`` for the GSE node cluster metrics.
* ``heka.sandbox.gse_cluster_metric`` for the GSE global cluster metrics.
* **Severity** (number), it is always equal to 6 (INFO).
* **Fields** * **Fields**
* **name** (string), the name of the metric. See :ref:`metric_list` for the * **name** (string), the name of the metric. See :ref:`metric_list` for the
current metrics names that are emitted. current metric names that are emitted.
* **value** (number), the value associated to the metric. * **value** (number), the value associated to the metric.
@ -116,6 +131,11 @@ Pacemaker
.. include:: metrics/pacemaker.rst .. include:: metrics/pacemaker.rst
Clusters
--------
.. include:: metrics/clusters.rst
LMA self-monitoring LMA self-monitoring
------------------- -------------------

View File

@ -0,0 +1,25 @@
.. _cluster_metrics:
The cluster metrics are emitted by the GSE plugins (See the :ref:`alarm_guide` for details).
* ``cluster_service_status``, the status of the service cluster.
The metric contains a ``cluster_name`` field that identifies the service cluster.
* ``cluster_node_status``, the status of the node cluster.
The metric contains a ``cluster_name`` field that identifies the node cluster.
* ``cluster_status``, the status of the global cluster.
The metric contains a ``cluster_name`` field that identifies the global cluster.
The supported values for these metrics are:
* `0` for the *Okay* status.
* `1` for the *Warning* status.
* `2` for the *Unknown* status.
* `3` for the *Critical* status.
* `4` for the *Down* status.