Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document the unit for every metric in the Metric enum #279

Open
tiyash-basu-frequenz opened this issue Jan 13, 2025 · 0 comments
Open

Document the unit for every metric in the Metric enum #279

tiyash-basu-frequenz opened this issue Jan 13, 2025 · 0 comments
Assignees
@tiyash-basu-frequenz
Labels
part:docs Affects the documentation part:❓ We need to figure out which part is affected priority:❓ We need to figure out how soon this should be addressed type:enhancement New feature or enhancement visitble to users
Milestone
v1.0.0

Comments

@tiyash-basu-frequenz
Copy link
Contributor

tiyash-basu-frequenz commented Jan 13, 2025 •
edited
Loading

What's needed?

The Metric enum variants do not have their units documented. This will cause confusions and bugs.

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 in metric_sample.proto, the units of the metrics are unchanged.

Additional context

No response
@tiyash-basu-frequenz tiyash-basu-frequenz added part:docs Affects the documentation part:❓ We need to figure out which part is affected priority:❓ We need to figure out how soon this should be addressed type:enhancement New feature or enhancement visitble to users labels Jan 13, 2025
@tiyash-basu-frequenz tiyash-basu-frequenz added this to the v1.0.0 milestone Jan 13, 2025
@tiyash-basu-frequenz tiyash-basu-frequenz self-assigned this Jan 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@tiyash-basu-frequenz tiyash-basu-frequenz

Labels
part:docs Affects the documentation part:❓ We need to figure out which part is affected priority:❓ We need to figure out how soon this should be addressed type:enhancement New feature or enhancement visitble to users
Projects
None yet
Milestone
v1.0.0
Development

No branches or pull requests
1 participant
@tiyash-basu-frequenz