Rename *Data messages to *Telemetry
#351
Merged
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
This message holds two different types of data: metric samples and state snapshots, which when combined into a single message, represent the telemetry data of a component. The name change reflects this purpose more accurately. Signed-off-by: Tiyash Basu <[email protected]>
This message holds two different types of data: metric samples and state snapshots, which when combined into a single message, represent the telemetry data of a component. The name change reflects this purpose more accurately. Signed-off-by: Tiyash Basu <[email protected]>
github-actions
bot
added
part:docs
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR renames telemetry-related messages for clarity, replacing the generic *Data suffix with *Telemetry.
- Renamed
SensorDatatoSensorTelemetryin sensor definitions. - Renamed
ElectricalComponentDatatoElectricalComponentTelemetryin component definitions. - Updated release notes to reflect these renamings.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| proto/frequenz/api/common/v1/microgrid/sensors/sensors.proto | Updated comment and message name from SensorData to SensorTelemetry |
| proto/frequenz/api/common/v1/microgrid/electrical_components/electrical_components.proto | Updated comment and message name from ElectricalComponentData to ElectricalComponentTelemetry |
| RELEASE_NOTES.md | Added entries for renamed messages |
Comments suppressed due to low confidence (1)
proto/frequenz/api/common/v1/microgrid/sensors/sensors.proto:206
- Typo: 'sensors' should be singular to match the
sensor_idfield. Consider changing 'microgrid sensors' to 'microgrid sensor'.
// The ID of the microgrid sensors.
llucax
approved these changes
May 23, 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.
These messages holds two different types of data: metric samples and state snapshots, which when combined into a single message, represent the telemetry data of a component/sensor. The name change reflects this purpose more accurately.