From 09105f463b3ad41dd16b6226498c0bcfbc590f98 Mon Sep 17 00:00:00 2001 From: Bogdan Drutu Date: Tue, 1 Feb 2022 14:36:39 -0800 Subject: [PATCH] Update comments to the current MetricType Signed-off-by: Bogdan Drutu --- proto/signalfx_metrics.proto | 24 +++++++++++------------- 1 file changed, 11 insertions(+), 13 deletions(-) diff --git a/proto/signalfx_metrics.proto b/proto/signalfx_metrics.proto index 420a6f0..9616089 100644 --- a/proto/signalfx_metrics.proto +++ b/proto/signalfx_metrics.proto @@ -17,22 +17,20 @@ option (gogoproto.sizer_all) = true; option (gogoproto.goproto_registration) = true; enum MetricType { - /** - * Numerical: Periodic, instantaneous measurement of some state. - */ + // Periodic, instantaneous numerical measurement of some state. GAUGE = 0; - /** - * Numerical: Count of occurrences. Generally non-negative integers. - */ + + // Counts of occurrences since last report. Generally non-negative integers. COUNTER = 1; - /** - * String: Used for non-continuous quantities (that is, measurements where there is a fixed - * set of meaningful values). This is essentially a special case of gauge. - */ + + // Used for non-continuous quantities (that is, measurements where there is a fixed + // set of meaningful values). This is essentially a special case of gauge that reports a string value. ENUM = 2; - /** - * Tracks a value that increases over time, where only the difference is important. - */ + + // Tracks a value that increases over time, where only the difference is important. + // + // Counts of occurrences since since a fixed start time. This means that the current value + // depends on all previous measurements since the start time. CUMULATIVE_COUNTER = 3; }