summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSimon Pasquier <spasquier@mirantis.com>2015-11-25 15:29:56 +0100
committerSimon Pasquier <spasquier@mirantis.com>2015-11-26 17:18:13 +0000
commit389b5043be4357e51cd3f7814655cf57706a0d9e (patch)
tree4a37c56d3ece0cc15acb5ae57d7409b4dc837c47
parent1dabef971256820b3f7e32d56fbd135a72b6bd06 (diff)
Document the GSE metricsshow0.8.0rc2
Notes
Notes (review): Verified+2: Jenkins Code-Review+2: Simon Pasquier <spasquier@mirantis.com> Workflow+1: Simon Pasquier <spasquier@mirantis.com> Verified+1: Plugins CI <plugins.ci@mirantis.com> Submitted-by: Jenkins Submitted-at: Thu, 26 Nov 2015 17:24:14 +0000 Reviewed-on: https://review.openstack.org/250503 Project: openstack/fuel-plugin-lma-collector Branch: refs/heads/stable/0.8
-rw-r--r--doc/source/dev/metrics.rst28
-rw-r--r--doc/source/dev/metrics/clusters.rst25
2 files changed, 49 insertions, 4 deletions
diff --git a/doc/source/dev/metrics.rst b/doc/source/dev/metrics.rst
index 3db6dae..a49283a 100644
--- a/doc/source/dev/metrics.rst
+++ b/doc/source/dev/metrics.rst
@@ -24,15 +24,30 @@ Attributes in **bold** are always present in the messages while attributes in
24* **Logger** (string), the datasource from the Heka's standpoint, it can be 24* **Logger** (string), the datasource from the Heka's standpoint, it can be
25 ``collectd``, ``notification_processor`` or ``http_log_parser``. 25 ``collectd``, ``notification_processor`` or ``http_log_parser``.
26 26
27* **Type** (string), either ``metric`` or ``heka.sandbox.metric`` (for metrics 27* **Type** (string)
28 derived from other messages).
29 28
30* **Severity** (number), it is always equal to 6 (eg INFO). 29 * ``metric`` or ``heka.sandbox.metric`` for the single-value metrics.
30
31 * ``heka.sandbox.multivalue_metric`` for the multi-valued metrics (eg annotations).
32
33 * ``heka.sandbox.bulk_metric`` for the metrics sent by bulk.
34
35 * ``heka.sandbox.afd_service_metric`` for the AFD service metrics.
36
37 * ``heka.sandbox.afd_node_metric`` for the AFD node metrics.
38
39 * ``heka.sandbox.gse_service_cluster_metric`` for the GSE service cluster metrics.
40
41 * ``heka.sandbox.gse_node_cluster_metric`` for the GSE node cluster metrics.
42
43 * ``heka.sandbox.gse_cluster_metric`` for the GSE global cluster metrics.
44
45* **Severity** (number), it is always equal to 6 (INFO).
31 46
32* **Fields** 47* **Fields**
33 48
34 * **name** (string), the name of the metric. See :ref:`metric_list` for the 49 * **name** (string), the name of the metric. See :ref:`metric_list` for the
35 current metrics names that are emitted. 50 current metric names that are emitted.
36 51
37 * **value** (number), the value associated to the metric. 52 * **value** (number), the value associated to the metric.
38 53
@@ -116,6 +131,11 @@ Pacemaker
116 131
117.. include:: metrics/pacemaker.rst 132.. include:: metrics/pacemaker.rst
118 133
134Clusters
135--------
136
137.. include:: metrics/clusters.rst
138
119LMA self-monitoring 139LMA self-monitoring
120------------------- 140-------------------
121 141
diff --git a/doc/source/dev/metrics/clusters.rst b/doc/source/dev/metrics/clusters.rst
new file mode 100644
index 0000000..9759018
--- /dev/null
+++ b/doc/source/dev/metrics/clusters.rst
@@ -0,0 +1,25 @@
1.. _cluster_metrics:
2
3The cluster metrics are emitted by the GSE plugins (See the :ref:`alarm_guide` for details).
4
5* ``cluster_service_status``, the status of the service cluster.
6 The metric contains a ``cluster_name`` field that identifies the service cluster.
7
8* ``cluster_node_status``, the status of the node cluster.
9 The metric contains a ``cluster_name`` field that identifies the node cluster.
10
11* ``cluster_status``, the status of the global cluster.
12 The metric contains a ``cluster_name`` field that identifies the global cluster.
13
14
15The supported values for these metrics are:
16
17* `0` for the *Okay* status.
18
19* `1` for the *Warning* status.
20
21* `2` for the *Unknown* status.
22
23* `3` for the *Critical* status.
24
25* `4` for the *Down* status.