@@ -4,7 +4,7 @@ TODO: Table of contents
44
55## Overview
66
7- The user-facing metrics API supports reporting diagnostic measurements
7+ The user-facing metrics API supports producing diagnostic measurements
88using three basic kinds of instrument. "Metrics" are the thing being
99produced--mathematical, statistical summaries of certain observable
1010behavior in the program. "Instruments" are the devices used by the
@@ -116,12 +116,13 @@ Counters support `Add(value)`. Choose this kind of metric when the
116116value is a quantity, the sum is of primary interest, and the event
117117count and value distribution are not of primary interest.
118118
119- Counters are defined as monotonic by default, meaning that positive
120- values are expected. Monotonic counters are typically used because
121- they can automatically be interpreted as a rate.
119+ Counters are defined as ` Monotonic = true ` by default, meaning that
120+ positive values are expected. ` Monotonic = true ` counters are
121+ typically used because they can automatically be interpreted as a
122+ rate.
122123
123- As an option, counters can be declared as ` NonMonotonic ` , in which
124- case they support positive and negative increments. Non-monotonic
124+ As an option, counters can be declared as ` Monotonic = false ` , in which
125+ case they support positive and negative increments. ` Monotonic = false `
125126counters are useful to report changes in an accounting scheme, such as
126127the number of bytes allocated and deallocated.
127128
@@ -135,12 +136,12 @@ measurement interval is arbitrary. Use this kind of metric when the
135136measurement is not a quantity, and the sum and event count are not of
136137interest.
137138
138- Gauges are defined as non-monotonic by default, meaning that new
139+ Gauges are defined as ` Monotonic = false ` by default, meaning that new
139140values are permitted to make positive or negative changes to the
140141gauge. There is no restriction on the sign of the input for gauges.
141142
142- As an option, gauges can be declared as ` Monotonic ` , in which case
143- successive values are expected to rise monotonically. Monotonic
143+ As an option, gauges can be declared as ` Monotonic = true ` , in which case
144+ successive values are expected to rise monotonically. ` Monotonic = true `
144145gauges are useful in reporting computed cumulative sums, allowing an
145146application to compute a current value and report it, without
146147remembering the last-reported value in order to report an increment.
@@ -163,9 +164,9 @@ count or rate of events is meaningful and either:
163164- The sum is of interest in addition to the count (rate)
164165- Quantile information is of interest.
165166
166- Measures are defined as ` NonNegative ` by default, meaning that
167- negative values are invalid. Non-negative measures are typically used
168- to record absolute values such as durations and sizes.
167+ Measures are defined as ` Absolute = true ` by default, meaning that
168+ negative values are invalid. ` Absolute = true ` measures are typically
169+ used to record absolute values such as durations and sizes.
169170
170- As an option, measures can be declared as ` Signed ` to indicate support
171- for positive and negative values.
171+ As an option, measures can be declared as ` Absolute = false ` to
172+ indicate support for positive and negative values.
0 commit comments