Skip to content
This repository was archived by the owner on Oct 3, 2023. It is now read-only.

Commit 4ed76d9

Browse files
committed
Fix review comments
1 parent 4af1cdb commit 4ed76d9

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

metrics/Gauge.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,14 @@ The `Gauge` values can be negative. This document describes the key types and th
88
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.
99

1010
The following general operations MUST be provided by the API:
11+
1112
* 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.
1919
* 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.
2020
* `labelValues`: the list of label values. The number of label values must be the same to that of the label keys.
2121
* The `Point` class should provide functionalities to manually increment/decrement values. Example: `add(long amt)`, `set(long value)`.
@@ -43,7 +43,7 @@ LongGauge gauge = metricRegistry.longGaugeBuilder()
4343
.build();
4444

4545
LongPoint point = gauge.getOrCreateTimeSeries(labelValues);
46-
46+
4747
void doSomeWork() {
4848
point.set(15);
4949
}
@@ -55,6 +55,7 @@ It is recommended to keep a reference of a point for manual operations instead o
5555
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.
5656

5757
The following general operations MUST be provided by the API:
58+
5859
* 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.
5960
* `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.
6061
* `description`: an optional string describing the metric, e.g."Virtual cycles executed on VM". The default is set to "".

0 commit comments

Comments
 (0)