Change type of metrics.MetricSample.connection field
#372
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
part:docs
tiyash-basu-frequenz
force-pushed
the
258_metric_connection_category
branch
from
bef78f0 to
3b5c6cd
Compare
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR refactors the type of the MetricSample.connection field from a simple string to the more expressive MetricConnection message, enabling more detailed categorization of connection types.
- Added MetricConnectionCategory enum for various connection types.
- Introduced MetricConnection message with fields for connection category and name.
- Updated MetricSample to use an optional MetricConnection field for better distinction of connection sources.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| proto/frequenz/api/common/v1/metrics/metrics.proto | Updated MetricSample and added new types for improving connection categorization. |
| RELEASE_NOTES.md | Updated release notes to reflect the change in MetricSample.connection type. |
Comments suppressed due to low confidence (1)
proto/frequenz/api/common/v1/metrics/metrics.proto:293
- The example comment still refers to 'source { ... }' while the field is now 'connection'. Please update the example to reflect the new field name to avoid confusion.
// !!! example
463d860 to
8a3034e
Compare
tiyash-basu-frequenz
force-pushed
the
258_metric_connection_category
branch
from
8a3034e to
591e422
Compare
tiyash-basu-frequenz
force-pushed
the
258_metric_connection_category
branch
from
591e422 to
742af6f
Compare
tiyash-basu-frequenz
force-pushed
the
258_metric_connection_category
branch
2 times, most recently
from
2824489 to
286386d
Compare
This commit changes the type of the `metrics.MetricSample.connection` field from `string` to a new message type `metrics.MetricConnection`. This change allows for better categorization of the connection type, which can be useful in control and monitoring applications. The new `MetricConnection` message includes a `MetricConnectionCategory` enum that categorizes the connection type (e.g., battery, PV array, temperature`s), and a `name` field that can be used to identify the specific connection point from which the metric was obtained. Signed-off-by: Tiyash Basu <[email protected]>
tiyash-basu-frequenz
force-pushed
the
258_metric_connection_category
branch
from
286386d to
930bbcf
Compare
llucax
approved these changes
Jun 13, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit changes the type of the
metrics.MetricSample.connectionfield fromstringto a new message typemetrics.MetricConnection.This change allows for better categorization of the connection type, which can be useful in control and monitoring applications. The new
MetricConnectionmessage includes aMetricConnectionCategoryenum that categorizes the connection type (e.g., battery, PV array, temperatures), and aname` field that can be used to identify the specific connection point from which the metric was obtained.closes #258