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

Commit 07a6f74

Browse files
author
Bogdan Drutu
authored
Make clear that cumulative int/float can go only up. (#75)
* Make clear that cumulative int/float can go only up. * Add a message about distribution count to only go up. * Update names to CUMULATIVE.
1 parent 5524008 commit 07a6f74

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

opencensus/proto/metrics/metrics.proto

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -59,26 +59,30 @@ message MetricDescriptor {
5959
// A gauge is an instantaneous measurement of a value.
6060
//
6161
// A cumulative measurement is a value accumulated over a time interval. In
62-
// a time series, cumulative measurements should have the same start time and
63-
// increasing end times, until an event resets the cumulative value to zero
64-
// and sets a new start time for the following points.
62+
// a time series, cumulative measurements should have the same start time,
63+
// increasing values and increasing end times, until an event resets the
64+
// cumulative value to zero and sets a new start time for the following
65+
// points.
6566
enum Type {
6667
// Do not use this default value.
6768
UNSPECIFIED = 0;
6869

69-
// Integer gauge.
70+
// Integer gauge. The value can go both up and down.
7071
GAUGE_INT64 = 1;
7172

72-
// Floating point gauge.
73+
// Floating point gauge. The value can go both up and down.
7374
GAUGE_DOUBLE = 2;
7475

75-
// Integer cumulative measurement.
76+
// Integer cumulative measurement. The value can only go up, if resets then
77+
// the start_time should also be reset.
7678
CUMULATIVE_INT64 = 3;
7779

78-
// Floating point cumulative measurement.
80+
// Floating point cumulative measurement. The value can only go up, if
81+
// resets then the start_time should also be reset.
7982
CUMULATIVE_DOUBLE = 4;
8083

81-
// Distribution cumulative measurement.
84+
// Distribution cumulative measurement. The count can only go up, if resets
85+
// then the start_time should also be reset.
8286
CUMULATIVE_DISTRIBUTION = 5;
8387
}
8488
Type type = 4;

0 commit comments

Comments
 (0)