Rename MetricSample.source to MetricSample.connection
#347
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
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR renames the MetricSample.source field to MetricSample.connection to make it clear that it refers to the connection point for the metric.
- Rename the
sourcefield inMetricSampletoconnectionand update its documentation. - Update example snippets in sensor and electrical component protos to use
connectioninstead ofsource. - Add a release note entry for this breaking change.
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| proto/frequenz/api/common/v1/microgrid/sensors/sensors.proto | Updated example comments: source → connection; added sensor-specific note. |
| proto/frequenz/api/common/v1/microgrid/electrical_components/electrical_components.proto | Added connection entries in snapshot examples. |
| proto/frequenz/api/common/v1/metrics/metrics.proto | Renamed source field to connection and rewrote its doc. |
| RELEASE_NOTES.md | Added release note for renaming source → connection. |
Comments suppressed due to low confidence (1)
proto/frequenz/api/common/v1/metrics/metrics.proto:246
- Ensure you update or add serialization/deserialization tests for the renamed
connectionfield, replacing references tosourceto verify metric samples are properly handled.
optional string connection = 5;
This commit renames the `source` field in the `MetricSample` message to `connection`. This change is made to clarify the purpose of the field, as it specifically refers to the connection point from which the metric was obtained, rather than a generic source. Signed-off-by: Tiyash Basu <[email protected]>
Signed-off-by: Tiyash Basu <[email protected]>
tiyash-basu-frequenz
force-pushed
the
260_source_connection
branch
from
e1d0d1d to
cf9c939
Compare
llucax
approved these changes
May 22, 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 renames the
sourcefield in theMetricSamplemessage toconnection. This change is made to clarify the purpose of the field, as it specifically refers to the connection point from which the metric was obtained, rather than a generic source.closes #260