-
Notifications
You must be signed in to change notification settings - Fork 14
Document the unit for every metric in the Metric enum #279
Copy link
Copy link
Open
Labels
part:docsAffects the documentationAffects the documentationpart:❓We need to figure out which part is affectedWe need to figure out which part is affectedpriority:❓We need to figure out how soon this should be addressedWe need to figure out how soon this should be addressedtype:enhancementNew feature or enhancement visitble to usersNew feature or enhancement visitble to users
Milestone
Metadata
Metadata
Assignees
Labels
part:docsAffects the documentationAffects the documentationpart:❓We need to figure out which part is affectedWe need to figure out which part is affectedpriority:❓We need to figure out how soon this should be addressedWe need to figure out how soon this should be addressedtype:enhancementNew feature or enhancement visitble to usersNew feature or enhancement visitble to users
What's needed?
The
Metricenum variants do not have their units documented. This will cause confusions and bugs.For reference, we stick to using base SI units for these metrics. So,
Proposed solution
We need to document every variant here, and specify their units.
Use cases
No response
Alternatives and workarounds
Until this issue is resolved, the units can be referred to from
electrical.proto. While the data structures in this file are very different from those inmetric_sample.proto, the units of the metrics are unchanged.Additional context
No response