You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Oct 3, 2023. It is now read-only.
Copy file name to clipboardExpand all lines: metrics/Gauge.md
+9-8Lines changed: 9 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,14 +8,14 @@ The `Gauge` values can be negative. This document describes the key types and th
8
8
The value that is published for gauges is an instantaneous measurement of an `int64` or `double` value. This API is useful when you want to manually increase and decrease values as per service requirements.
9
9
10
10
The following general operations MUST be provided by the API:
11
+
11
12
* Defining a `name`, `description`, `unit`, `labelKeys`, `resource` and `constantLabels` which are fixed labels that always apply to a gauge. This should give back the gauge object to get or create time series, remove time series and clear all time series.
12
-
* `name`: a string describing the name of the metric, e.g. "vm_cpu_cycles" or "queue_size". Names MUST be unique within the library. It is recommended to use names compatible with the intended end usage.
13
-
* `description`: an optional string describing the metric, e.g."Virtual cycles executed on VM". The default is set to "".
14
-
* `unit`: an optional string describing the unit used for the metric. Follows the format described by
15
-
[Unified Code for Units of Measure](http://unitsofmeasure.org/ucum.html). The default set to "1".
16
-
* `labelKeys`: an optional list of the label keys to track different types of metric. The default is set to empty list.
17
-
* `constantLabels`: an optional map of label keys and label values. The default is set to empty map.
18
-
* `resource`: an optional associated monitored resource information.
13
+
* `name`: same as above name.
14
+
* `description`: same as above description.
15
+
* `unit`: same as above unit.
16
+
* `labelKeys`: same as above labelKeys.
17
+
* `constantLabels`: same as above constantLabels.
18
+
* `resource`: same as above resource.
19
19
* Add a new time series with label values, which returns a `Point` (which is part of the `TimeSeries`). Each point represents an instantaneous measurement of a varying gauge value. Each Gauge Metric has one or more time series for a single metric.
20
20
* `labelValues`: the list of label values. The number of label values must be the same to that of the label keys.
21
21
* The `Point` class should provide functionalities to manually increment/decrement values. Example: `add(long amt)`, `set(long value)`.
LongPoint point = gauge.getOrCreateTimeSeries(labelValues);
46
-
46
+
47
47
void doSomeWork() {
48
48
point.set(15);
49
49
}
@@ -55,6 +55,7 @@ It is recommended to keep a reference of a point for manual operations instead o
55
55
The value that is published for gauges is an instantaneous measurement of an `int64` or `double` value. This gauge is self sufficient once created, so users should never need to interact with it. The value of the gauge is observed from the `object` and a `callback function`. The callback function is invoked whenever metrics are collected, meaning the reported value is up-to-date.
56
56
57
57
The following general operations MUST be provided by the API:
58
+
58
59
* Defining a `name`, `description`, `unit`, `labelKeys`, `resource` and `constantLabels` which are fixed labels that always apply to a gauge. This should give back gauge object to add new time series, remove time series and clear all time series.
59
60
* `name`: a string describing the name of the metric, e.g. "vm_cpu_cycles". Names MUST be unique within the library. It is recommended to use names compatible with the intended end usage.
60
61
* `description`: an optional string describing the metric, e.g."Virtual cycles executed on VM". The default is set to "".
0 commit comments