Skip to content

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

@tiyash-basu-frequenz

Description

@tiyash-basu-frequenz

What's needed?

The Metric enum 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,

  • voltage: V
  • current: A
  • DC/AC-active power: W
  • AC-reactive power: VAr
  • AC-apparent power: VA
  • energy: Wh, VArh, VAh

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

Metadata

Metadata

Labels

part:docsAffects the documentationpart:❓We need to figure out which part is affectedpriority:❓We need to figure out how soon this should be addressedtype:enhancementNew feature or enhancement visitble to users

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions