Skip to content
This repository has been archived by the owner on Aug 13, 2024. It is now read-only.

Update comments to the current MetricType #12

Merged
merged 1 commit into from
Feb 4, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 11 additions & 13 deletions proto/signalfx_metrics.proto
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i don't even know what will happen if an enum is sent in... i don't think this is actually implemented.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No idea, I've tried to document it, if you think I should remove it I am happy to do it.

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;
}

Expand Down