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

Commit

Permalink
Fix review comment
Browse files Browse the repository at this point in the history
  • Loading branch information
mayurkale22 committed Mar 15, 2019
1 parent 5cdf8f3 commit 8a3d560
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions metrics/Gauge.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Gauge API Overview
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.
# Gauge Overview
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.

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

Expand All @@ -8,7 +8,7 @@ The `Gauge` values can be negative. This document describes the key types and th
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.

The following general operations MUST be provided by the API:
* 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.
* 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.
* `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.
* `description`: a string describing the metric, e.g."Virtual cycles executed on VM".
* `unit`: a string describing the unit used for the metric. Follows the format described by
Expand Down

0 comments on commit 8a3d560

Please sign in to comment.