Browse Source

Document the GSE metrics

Change-Id: I2d81c40d800a23695eb6eb18c41979f383e08e3b
Simon Pasquier 3 years ago
parent
commit
57a8481b53
2 changed files with 49 additions and 4 deletions
  1. 24
    4
      doc/source/dev/metrics.rst
  2. 25
    0
      doc/source/dev/metrics/clusters.rst

+ 24
- 4
doc/source/dev/metrics.rst View File

@@ -24,15 +24,30 @@ Attributes in **bold** are always present in the messages while attributes in
24 24
 * **Logger** (string), the datasource from the Heka's standpoint, it can be
25 25
   ``collectd``, ``notification_processor`` or ``http_log_parser``.
26 26
 
27
-* **Type** (string), either ``metric`` or ``heka.sandbox.metric`` (for metrics
28
-  derived from other messages).
27
+* **Type** (string)
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 47
 * **Fields**
33 48
 
34 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 52
  * **value** (number), the value associated to the metric.
38 53
 
@@ -116,6 +131,11 @@ Pacemaker
116 131
 
117 132
 .. include:: metrics/pacemaker.rst
118 133
 
134
+Clusters
135
+--------
136
+
137
+.. include:: metrics/clusters.rst
138
+
119 139
 LMA self-monitoring
120 140
 -------------------
121 141
 

+ 25
- 0
doc/source/dev/metrics/clusters.rst View File

@@ -0,0 +1,25 @@
1
+.. _cluster_metrics:
2
+
3
+The 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
+
15
+The 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.

Loading…
Cancel
Save