Skip to content

Improve naming for per-phase component metric streams #987

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
Merged
shsms merged 5 commits into from
Jun 26, 2024
Merged

Improve naming for per-phase component metric streams #987

shsms merged 5 commits into from
Jun 26, 2024

Conversation

@shsms
Copy link
Contributor

@shsms shsms commented Jun 26, 2024

Closes #880

@shsms shsms requested a review from a team as a code owner June 26, 2024 13:26
@github-actions github-actions bot added part:tests Affects the unit, integration and performance (benchmarks) tests part:data-pipeline Affects the data pipeline part:actor Affects an actor ot the actors utilities (decorator, etc.) part:microgrid Affects the interactions with the microgrid labels Jun 26, 2024
@shsms shsms self-assigned this Jun 26, 2024
@github-actions github-actions bot added the part:docs Affects the documentation label Jun 26, 2024
@shsms
Improve naming of grid per-phase metrics
51ad897 
Single 3-phase metrics like `power` have had no suffix, and those stay
as they are.

3-phase metrics specified per-phase now use the `per_phase` suffix.

Signed-off-by: Sahas Subramanian <sahas.subramanian@proton.me>
daniel-zullo-frequenz
daniel-zullo-frequenz reviewed Jun 26, 2024
View reviewed changes
Copy link
Contributor

@daniel-zullo-frequenz daniel-zullo-frequenz left a comment

Choose a reason for hiding this comment

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

Just a few minor suggestions about docstrings to check for. LGTM otherwise

shsms added 3 commits June 26, 2024 16:17
@shsms
Rename microgrid.voltage → voltage_per_phase
5a8587c 
Signed-off-by: Sahas Subramanian <sahas.subramanian@proton.me>
@shsms
Rename EVChargerPool.current → current_per_phase
d97ad0b 
Signed-off-by: Sahas Subramanian <sahas.subramanian@proton.me>
@shsms
Update release notes
cfedf5e 
Signed-off-by: Sahas Subramanian <sahas.subramanian@proton.me>
@daniel-zullo-frequenz
Copy link
Contributor

daniel-zullo-frequenz commented Jun 26, 2024

The docs generation failed due to these warnings:

WARNING -  mkdocs_autorefs: reference/frequenz/sdk/timeseries/ev_charger_pool/index.md: Could not find cross-reference target '[frequenz.sdk.timeseries.ev_charger_pool.EVChargerPool.current]'
WARNING -  mkdocs_autorefs: reference/frequenz/sdk/timeseries/formula_engine/index.md: Could not find cross-reference target '[frequenz.sdk.timeseries.grid.Grid.current]'
WARNING -  mkdocs_autorefs: reference/frequenz/sdk/timeseries/formula_engine/index.md: Could not find cross-reference target '[frequenz.sdk.timeseries.ev_charger_pool.EVChargerPool.current]'
WARNING -  mkdocs_autorefs: user-guide/formula-engine.md: Could not find cross-reference target '[frequenz.sdk.timeseries.grid.Grid.current]'
WARNING -  mkdocs_autorefs: user-guide/formula-engine.md: Could not find cross-reference target '[frequenz.sdk.timeseries.ev_charger_pool.EVChargerPool.current]'

@shsms
Fix x-refs in docs for the new metric name changes
f78e8c7 
Signed-off-by: Sahas Subramanian <sahas.subramanian@proton.me>
@shsms
Copy link
Contributor Author

shsms commented Jun 26, 2024

The docs generation failed due to these warnings:

is fixed now.

@shsms shsms added this pull request to the merge queue Jun 26, 2024
Merged via the queue into frequenz-floss:v1.x.x with commit 479bb90 Jun 26, 2024
@shsms shsms deleted the metric-names branch June 26, 2024 18:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@daniel-zullo-frequenz daniel-zullo-frequenz daniel-zullo-frequenz approved these changes

Assignees

@shsms shsms

Labels

part:actor Affects an actor ot the actors utilities (decorator, etc.) part:data-pipeline Affects the data pipeline part:docs Affects the documentation part:microgrid Affects the interactions with the microgrid part:tests Affects the unit, integration and performance (benchmarks) tests

Projects

Python SDK Roadmap
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Name single phase and 3-phase metrics consistently

2 participants

@shsms @daniel-zullo-frequenz