Skip to content

Rename metric variants to follow a consistent naming scheme #367

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

Merged
merged 1 commit into from
Jun 13, 2025
Merged

Rename metric variants to follow a consistent naming scheme #367

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 10 additions & 0 deletions RELEASE_NOTES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,16 @@
* `MetricSample.source` to `MetricSample.connection`
* `MetricSample.sampled_at` to `sample_time`

+ `metrics.Metric`:

* The enum variants to follow a more consistent naming scheme of core-concept to modifier.
* `METRIC_AC_APPARENT_POWER*` to `METRIC_AC_POWER_APPARENT*`
* `METRIC_AC_ACTIVE_POWER*` to `METRIC_AC_POWER_ACTIVE*`
* `METRIC_AC_REACTIVE_POWER*` to `METRIC_AC_POWER_REACTIVE*`
* `METRIC_AC_APPARENT_ENERGY*` to `METRIC_AC_ENERGY_APPARENT*`
* `METRIC_AC_ACTIVE_ENERGY*` to `METRIC_AC_ENERGY_ACTIVE*`
* `METRIC_AC_REACTIVE_ENERGY*` to `METRIC_AC_ENERGY_REACTIVE*`

- Renumbered some enum values to remove unnecessary gaps:

+ `microgrid.components.ComponentCategory` (`microgrid.electrical_components.ElectricalComponentCategory`)
Expand Down
64 changes: 32 additions & 32 deletions proto/frequenz/api/common/v1/metrics/metrics.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,18 +101,18 @@ enum Metric {
METRIC_AC_CURRENT_PHASE_3 = 21;

// AC power metrics
METRIC_AC_APPARENT_POWER = 22;
METRIC_AC_APPARENT_POWER_PHASE_1 = 23;
METRIC_AC_APPARENT_POWER_PHASE_2 = 24;
METRIC_AC_APPARENT_POWER_PHASE_3 = 25;
METRIC_AC_ACTIVE_POWER = 26;
METRIC_AC_ACTIVE_POWER_PHASE_1 = 27;
METRIC_AC_ACTIVE_POWER_PHASE_2 = 28;
METRIC_AC_ACTIVE_POWER_PHASE_3 = 29;
METRIC_AC_REACTIVE_POWER = 30;
METRIC_AC_REACTIVE_POWER_PHASE_1 = 31;
METRIC_AC_REACTIVE_POWER_PHASE_2 = 32;
METRIC_AC_REACTIVE_POWER_PHASE_3 = 33;
METRIC_AC_POWER_APPARENT = 22;
METRIC_AC_POWER_APPARENT_PHASE_1 = 23;
METRIC_AC_POWER_APPARENT_PHASE_2 = 24;
METRIC_AC_POWER_APPARENT_PHASE_3 = 25;
METRIC_AC_POWER_ACTIVE = 26;
METRIC_AC_POWER_ACTIVE_PHASE_1 = 27;
METRIC_AC_POWER_ACTIVE_PHASE_2 = 28;
METRIC_AC_POWER_ACTIVE_PHASE_3 = 29;
METRIC_AC_POWER_REACTIVE = 30;
METRIC_AC_POWER_REACTIVE_PHASE_1 = 31;
METRIC_AC_POWER_REACTIVE_PHASE_2 = 32;
METRIC_AC_POWER_REACTIVE_PHASE_3 = 33;

// AC Power factor
METRIC_AC_POWER_FACTOR = 40;
Expand All @@ -121,26 +121,26 @@ enum Metric {
METRIC_AC_POWER_FACTOR_PHASE_3 = 43;

// AC energy metrics
METRIC_AC_APPARENT_ENERGY = 50;
METRIC_AC_APPARENT_ENERGY_PHASE_1 = 51;
METRIC_AC_APPARENT_ENERGY_PHASE_2 = 52;
METRIC_AC_APPARENT_ENERGY_PHASE_3 = 53;
METRIC_AC_ACTIVE_ENERGY = 54;
METRIC_AC_ACTIVE_ENERGY_PHASE_1 = 55;
METRIC_AC_ACTIVE_ENERGY_PHASE_2 = 56;
METRIC_AC_ACTIVE_ENERGY_PHASE_3 = 57;
METRIC_AC_ACTIVE_ENERGY_CONSUMED = 58;
METRIC_AC_ACTIVE_ENERGY_CONSUMED_PHASE_1 = 59;
METRIC_AC_ACTIVE_ENERGY_CONSUMED_PHASE_2 = 60;
METRIC_AC_ACTIVE_ENERGY_CONSUMED_PHASE_3 = 61;
METRIC_AC_ACTIVE_ENERGY_DELIVERED = 62;
METRIC_AC_ACTIVE_ENERGY_DELIVERED_PHASE_1 = 63;
METRIC_AC_ACTIVE_ENERGY_DELIVERED_PHASE_2 = 64;
METRIC_AC_ACTIVE_ENERGY_DELIVERED_PHASE_3 = 65;
METRIC_AC_REACTIVE_ENERGY = 66;
METRIC_AC_REACTIVE_ENERGY_PHASE_1 = 67;
METRIC_AC_REACTIVE_ENERGY_PHASE_2 = 68;
METRIC_AC_REACTIVE_ENERGY_PHASE_3 = 69;
METRIC_AC_ENERGY_APPARENT = 50;
METRIC_AC_ENERGY_APPARENT_PHASE_1 = 51;
METRIC_AC_ENERGY_APPARENT_PHASE_2 = 52;
METRIC_AC_ENERGY_APPARENT_PHASE_3 = 53;
METRIC_AC_ENERGY_ACTIVE = 54;
METRIC_AC_ENERGY_ACTIVE_PHASE_1 = 55;
METRIC_AC_ENERGY_ACTIVE_PHASE_2 = 56;
METRIC_AC_ENERGY_ACTIVE_PHASE_3 = 57;
METRIC_AC_ENERGY_ACTIVE_CONSUMED = 58;
METRIC_AC_ENERGY_ACTIVE_CONSUMED_PHASE_1 = 59;
METRIC_AC_ENERGY_ACTIVE_CONSUMED_PHASE_2 = 60;
METRIC_AC_ENERGY_ACTIVE_CONSUMED_PHASE_3 = 61;
METRIC_AC_ENERGY_ACTIVE_DELIVERED = 62;
METRIC_AC_ENERGY_ACTIVE_DELIVERED_PHASE_1 = 63;
METRIC_AC_ENERGY_ACTIVE_DELIVERED_PHASE_2 = 64;
METRIC_AC_ENERGY_ACTIVE_DELIVERED_PHASE_3 = 65;
METRIC_AC_ENERGY_REACTIVE = 66;
METRIC_AC_ENERGY_REACTIVE_PHASE_1 = 67;
METRIC_AC_ENERGY_REACTIVE_PHASE_2 = 68;
METRIC_AC_ENERGY_REACTIVE_PHASE_3 = 69;

// AC harmonics
METRIC_AC_TOTAL_HARMONIC_DISTORTION_CURRENT = 80;
Expand Down
Loading