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

Commit 8a3d560

Browse files
committed
Fix review comment
1 parent 5cdf8f3 commit 8a3d560

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

metrics/Gauge.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
# Gauge API Overview
2-
A `Gauge` is used to record already aggregated metrics, or metrics that can go up and down. Typical examples of gauges would be the number of jobs/entries in a queue or number of threads in a running state.
1+
# Gauge Overview
2+
A `Gauge` is used to record aggregated metrics that can go up and down. Typical examples of gauges would be the number of jobs/entries in a queue, number of threads in a running state or current memory usage etc.
33

44
The `Gauge` values can be negative. This document describes the key types and the overall bahavior of API.
55

@@ -8,7 +8,7 @@ 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-
* Defining a `name`, `description`, `unit`, `labelKeys` and `constantLabels` which are fixed labels that always apply to a gauge. This should give back the gauge object to getOrcreate time series, remove time series and clear all time series.
11+
* Defining a `name`, `description`, `unit`, `labelKeys` 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.
1212
* `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.
1313
* `description`: a string describing the metric, e.g."Virtual cycles executed on VM".
1414
* `unit`: a string describing the unit used for the metric. Follows the format described by

0 commit comments

Comments
 (0)