Skip to content

Renamed sampled_at timestamps to origin_time #345

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 4 commits into from
May 22, 2025
Merged

Renamed sampled_at timestamps to origin_time #345

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fe88fd1
Renamed `sampled_at` timestamps for states to `origin_time`
tiyash-basu-frequenz May 21, 2025
badade0
Rename `sampled_at` to `sample_time` in metrics and sensor metrics
tiyash-basu-frequenz May 22, 2025
89de32d
Update documentation for `origin_time` field in proto files
tiyash-basu-frequenz May 22, 2025
de13b82
Rename snapshot_time to origin_time in communication component state
tiyash-basu-frequenz May 22, 2025
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
2 changes: 2 additions & 0 deletions RELEASE_NOTES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@
- Renamed field `ElectricalComponent.category_type` to `ElectricalComponent.category_specific_info` to better reflect its purpose.
- Renamed `ElectricalComponentState` to `ElectricalComponentStateSnapshot` to better reflect its purpose.
- Renamed `SensorState` to `SensorStateSnapshot` to better reflect its purpose.
- Renamed `sampled_at` timestamps for state snapshots to `origin_time`.
- Renamed `sampled_at` timestamps for metric samples to `sample_time`.

## Bug Fixes

Expand Down
2 changes: 1 addition & 1 deletion 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 @@ -186,7 +186,7 @@ enum Metric {
// command, clients need to request current values within the bounds.
message MetricSample {
// The UTC timestamp of when the metric was sampled.
google.protobuf.Timestamp sampled_at = 1;
google.protobuf.Timestamp sample_time = 1;

// The metric that was sampled.
Metric metric = 2;
Expand Down
4 changes: 2 additions & 2 deletions .../frequenz/api/common/v1/microgrid/communication_components/communication_components.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,8 +173,8 @@ message CommunicationComponentDiagnostic {
// in time, so there is only a single `snapshot_time`. any parallel reads
// happening to produce this data are collapsed under that timestamp.
message CommunicationComponentStateSnapshot {
// the UTC time when this snapshot was taken.
google.protobuf.Timestamp snapshot_time = 1;
// The UTC time when the state was originally captured.
google.protobuf.Timestamp origin_time = 1;

// one or more high-level state codes active at snapshot_time.
//
Expand Down
12 changes: 6 additions & 6 deletions proto/frequenz/api/common/v1/microgrid/electrical_components/electrical_components.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -475,8 +475,8 @@ message ElectricalComponentDiagnostic {

// Representation of a component state, warnings, and errors.
message ElectricalComponentStateSnapshot {
// The time at which the state was sampled.
google.protobuf.Timestamp sampled_at = 1;
// The UTC time when the state was originally captured.
google.protobuf.Timestamp origin_time = 1;


// List of operational states currently active for the component.
Expand Down Expand Up @@ -524,13 +524,13 @@ message ElectricalComponentStateSnapshot {
// metric_samples: [
// /* list of metrics for multiple timestamps */
// {
// sampled_at: "2023-10-01T00:00:00Z",
// sample_time: "2023-10-01T00:00:00Z",
// metric: "DC_VOLTAGE_V",
// value: {},
// bounds: {},
// },
// {
// sampled_at: "2023-10-01T00:00:00Z",
// sample_time: "2023-10-01T00:00:00Z",
// metric: "DC_VOLTAGE_V",
// value: {},
// bounds: {},
Expand All @@ -539,13 +539,13 @@ message ElectricalComponentStateSnapshot {
// states: [
// /* list of states for multiple timestamps */
// {
// sampled_at: "2023-10-01T00:00:00Z",
// sample_time: "2023-10-01T00:00:00Z",
// states: [],
// warnings: [],
// errors: [],
// },
// {
// sampled_at: "2023-10-01T00:00:00Z",
// sample_time: "2023-10-01T00:00:00Z",
// states: [],
// warnings: [],
// errors: [],
Expand Down
12 changes: 6 additions & 6 deletions proto/frequenz/api/common/v1/microgrid/sensors/sensors.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,8 +169,8 @@ message SensorDiagnostic {

// Representation of a sensor state and errors.
message SensorStateSnapshot {
// The time at which the state was sampled.
google.protobuf.Timestamp sampled_at = 1;
// The UTC time when the state was originally captured.
google.protobuf.Timestamp origin_time = 1;

// List of states of the microgrid sensor.
//
Expand Down Expand Up @@ -210,7 +210,7 @@ message SensorStateSnapshot {
// Representation of a sampled sensor metric along with its value.
message SensorMetricSample {
// The UTC timestamp of when the metric was sampled.
google.protobuf.Timestamp sampled_at = 1;
google.protobuf.Timestamp sample_time = 1;

// The metric that was sampled.
frequenz.api.common.v1.metrics.Metric metric = 2;
Expand All @@ -230,19 +230,19 @@ message SensorMetricSample {
// metric_samples: [
// /* list of metrics for multiple timestamps */
// {
// sampled_at: "2023-10-01T00:00:00Z",
// sample_time: "2023-10-01T00:00:00Z",
// metric: "METRIC_SENSOR_TEMPERATURE",
// value: metric_value_variant: {simple_metric: {value: 23.5},
// },
// {
// sampled_at: "2023-10-01T00:00:00Z",
// sample_time: "2023-10-01T00:00:00Z",
// metric: "METRIC_SENSOR_RELATIVE_HUMIDITY",
// value: metric_value_variant: {simple_metric: {value: 23.5},
// }
// ],
// states: [
// {
// sampled_at: "2023-10-01T00:00:00Z",
// sample_time: "2023-10-01T00:00:00Z",
// states: [],
// errors: [],
// },
Expand Down
Loading