Skip to content

Update to reporting API v1alpha10 #240

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
cwasicki merged 6 commits into from
Nov 27, 2025
Merged

Update to reporting API v1alpha10 #240

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f79486b
Update reporting API dependency to v0.10.x
cwasicki Nov 3, 2025
953e725
Update client common dependency version to v0.3.7+
cwasicki Nov 24, 2025
3221ce2
Use new metrics package from common client
cwasicki Nov 24, 2025
ffa29cf
Switch to reporting API v1alpha10
cwasicki Nov 24, 2025
9687614
Update release notes
cwasicki Nov 27, 2025
f492944
Use from_proto functions from client common
cwasicki Nov 27, 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
5 changes: 3 additions & 2 deletions RELEASE_NOTES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,12 @@

## Summary

<!-- Here goes a general summary of what this release is about -->
> **Warning:** This client is compatible *only* with Reporting API `v1alpha10` or later.
> Using with services that use an older API version **will cause failures**.

## Upgrading

<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
* Breaking change to reporting API v1alpha10.
Copy link
Contributor

@llucax llucax Nov 27, 2025

Choose a reason for hiding this comment

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

Maybe it is worth mentioning the switch from metric to metrics, as it involves a few breaking changes too.

Copy link
Contributor Author

@cwasicki cwasicki Nov 27, 2025

Choose a reason for hiding this comment

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

#241


## New Features

Expand Down
8 changes: 4 additions & 4 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,12 @@ classifiers = [
]
requires-python = ">= 3.11, < 4"
dependencies = [
"typing_extensions >= 4.6.1, < 5",
"typing_extensions >= 4.13.0, < 5",
"grpc-stubs == 1.53.0.6",
"frequenz-api-reporting >= 0.8.0, < 0.9",
"frequenz-client-common >= 0.3.0, < 0.4",
"frequenz-api-reporting >= 0.10.0, < 0.11",
"frequenz-client-common >= 0.3.7, < 0.4",
"grpcio >=1.72.1, < 2",
"protobuf >=6.31.1, < 7",
"protobuf >=6.33.1, < 7",
"frequenz-client-base >= 0.11.0, < 0.12.0",
]
dynamic = ["version"]
Expand Down
42 changes: 22 additions & 20 deletions src/frequenz/client/reporting/_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,48 +8,50 @@
from typing import cast

# pylint: disable=no-name-in-module
from frequenz.api.common.v1.microgrid.microgrid_pb2 import (
MicrogridComponentIDs as PBMicrogridComponentIDs,
from frequenz.api.common.v1alpha8.microgrid.microgrid_pb2 import (
MicrogridElectricalComponentIDs as PBMicrogridComponentIDs,
)
from frequenz.api.common.v1.microgrid.microgrid_pb2 import (
from frequenz.api.common.v1alpha8.microgrid.microgrid_pb2 import (
MicrogridSensorIDs as PBMicrogridSensorIDs,
)
from frequenz.api.reporting.v1.reporting_pb2 import (
from frequenz.api.reporting.v1alpha10.reporting_pb2 import (
AggregationConfig as PBAggregationConfig,
)
from frequenz.api.reporting.v1.reporting_pb2 import FilterOption as PBFilterOption
from frequenz.api.reporting.v1.reporting_pb2 import (
from frequenz.api.reporting.v1alpha10.reporting_pb2 import (
FilterOption as PBFilterOption,
)
from frequenz.api.reporting.v1alpha10.reporting_pb2 import (
MetricConnections as PBMetricConnections,
)
from frequenz.api.reporting.v1.reporting_pb2 import (
from frequenz.api.reporting.v1alpha10.reporting_pb2 import (
ReceiveAggregatedMicrogridComponentsDataStreamRequest as PBAggregatedStreamRequest,
)
from frequenz.api.reporting.v1.reporting_pb2 import (
from frequenz.api.reporting.v1alpha10.reporting_pb2 import (
ReceiveAggregatedMicrogridComponentsDataStreamResponse as PBAggregatedStreamResponse,
)
from frequenz.api.reporting.v1.reporting_pb2 import (
from frequenz.api.reporting.v1alpha10.reporting_pb2 import (
ReceiveMicrogridComponentsDataStreamRequest as PBReceiveMicrogridComponentsDataStreamRequest,
)
from frequenz.api.reporting.v1.reporting_pb2 import (
from frequenz.api.reporting.v1alpha10.reporting_pb2 import (
ReceiveMicrogridComponentsDataStreamResponse as PBReceiveMicrogridComponentsDataStreamResponse,
)
from frequenz.api.reporting.v1.reporting_pb2 import (
from frequenz.api.reporting.v1alpha10.reporting_pb2 import (
ReceiveMicrogridSensorsDataStreamRequest as PBReceiveMicrogridSensorsDataStreamRequest,
)
from frequenz.api.reporting.v1.reporting_pb2 import (
from frequenz.api.reporting.v1alpha10.reporting_pb2 import (
ReceiveMicrogridSensorsDataStreamResponse as PBReceiveMicrogridSensorsDataStreamResponse,
)
from frequenz.api.reporting.v1.reporting_pb2 import (
from frequenz.api.reporting.v1alpha10.reporting_pb2 import (
ResamplingOptions as PBResamplingOptions,
)
from frequenz.api.reporting.v1.reporting_pb2 import TimeFilter as PBTimeFilter
from frequenz.api.reporting.v1.reporting_pb2_grpc import ReportingStub
from frequenz.api.reporting.v1alpha10.reporting_pb2 import TimeFilter as PBTimeFilter
from frequenz.api.reporting.v1alpha10.reporting_pb2_grpc import ReportingStub
from frequenz.channels import Receiver
from frequenz.client.base.channel import ChannelOptions
from frequenz.client.base.client import BaseApiClient
from frequenz.client.base.exception import ClientNotConnected
from frequenz.client.base.streaming import GrpcStreamBroadcaster
from frequenz.client.common.metric import Metric
from frequenz.client.common.metrics import Metric
from google.protobuf.timestamp_pb2 import Timestamp as PBTimestamp

from ._batch_unroll_receiver import BatchUnrollReceiver
Expand Down Expand Up @@ -250,7 +252,7 @@ def _receive_microgrid_components_data_batch(
or not self._components_data_streams[stream_key].is_running
):
microgrid_components_pb = [
PBMicrogridComponentIDs(microgrid_id=mid, component_ids=cids)
PBMicrogridComponentIDs(microgrid_id=mid, electrical_component_ids=cids)
for mid, cids in microgrid_components
]

Expand Down Expand Up @@ -294,7 +296,7 @@ def dt2ts(dt: datetime) -> PBTimestamp:
)

metric_conns_pb = [
PBMetricConnections(metric=metric.to_proto(), connections=[])
PBMetricConnections(metric=metric.value, connections=[])
for metric in metrics
]

Expand Down Expand Up @@ -477,7 +479,7 @@ def dt2ts(dt: datetime) -> PBTimestamp:

metric_conns_pb = [
PBMetricConnections(
metric=metric.to_proto(),
metric=metric.value,
connections=[],
)
for metric in metrics
Expand Down Expand Up @@ -556,7 +558,7 @@ def receive_aggregated_data(

aggregation_config = PBAggregationConfig(
microgrid_id=microgrid_id,
metric=metric.to_proto(),
metric=metric.value,
aggregation_formula=aggregation_formula,
)

Expand Down
28 changes: 15 additions & 13 deletions src/frequenz/client/reporting/_types.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,23 @@

from collections.abc import Iterable, Iterator
from dataclasses import dataclass
from datetime import datetime, timezone
from datetime import datetime
from typing import Any, NamedTuple

# pylint: disable=no-name-in-module
from frequenz.api.reporting.v1.reporting_pb2 import (
from frequenz.api.reporting.v1alpha10.reporting_pb2 import (
ReceiveAggregatedMicrogridComponentsDataStreamResponse as PBAggregatedStreamResponse,
)
from frequenz.api.reporting.v1.reporting_pb2 import (
from frequenz.api.reporting.v1alpha10.reporting_pb2 import (
ReceiveMicrogridComponentsDataStreamResponse as PBReceiveMicrogridComponentsDataStreamResponse,
)
from frequenz.api.reporting.v1.reporting_pb2 import (
from frequenz.api.reporting.v1alpha10.reporting_pb2 import (
ReceiveMicrogridSensorsDataStreamResponse as PBReceiveMicrogridSensorsDataStreamResponse,
)

# pylint: enable=no-name-in-module
from frequenz.client.common.metric import Metric
from frequenz.client.common.metrics import Metric
from frequenz.client.common.proto import datetime_from_proto, enum_from_proto


class MetricSample(NamedTuple):
Expand Down Expand Up @@ -92,8 +93,8 @@ def __iter__(self) -> Iterator[MetricSample]:
for item in items:
cid = getattr(item, self.id_attr)
for sample in getattr(item, "metric_samples", []):
ts = sample.sampled_at.ToDatetime().replace(tzinfo=timezone.utc)
met = Metric.from_proto(sample.metric).name
ts = datetime_from_proto(sample.sample_time)
met = enum_from_proto(sample.metric, Metric, allow_invalid=False).name

# Handle simple_metric
if sample.value.HasField("simple_metric"):
Expand Down Expand Up @@ -126,8 +127,8 @@ def __iter__(self) -> Iterator[MetricSample]:
ts, mid, cid, f"{met}_bound_{i}_upper", bound.upper
)

for state in getattr(item, "states", []):
ts = state.sampled_at.ToDatetime().replace(tzinfo=timezone.utc)
for state in getattr(item, "state_snapshots", []):
ts = datetime_from_proto(state.origin_time)
for category, category_items in {
"state": getattr(state, "states", []),
"warning": getattr(state, "warnings", []),
Expand All @@ -150,7 +151,10 @@ def __init__(self, data_pb: PBReceiveMicrogridComponentsDataStreamResponse):
data_pb: The underlying protobuf message.
"""
super().__init__(
data_pb, id_attr="component_id", items_attr="components", has_bounds=True
data_pb,
id_attr="electrical_component_id",
items_attr="components",
has_bounds=True,
)


Expand All @@ -177,9 +181,7 @@ class AggregatedMetric:
def sample(self) -> MetricSample:
"""Return the aggregated metric sample."""
return MetricSample(
timestamp=self._data_pb.sample.sample_time.ToDatetime().replace(
tzinfo=timezone.utc
),
timestamp=datetime_from_proto(self._data_pb.sample.sample_time),
microgrid_id=self._data_pb.aggregation_config.microgrid_id,
component_id=self._data_pb.aggregation_config.aggregation_formula,
metric=Metric(self._data_pb.aggregation_config.metric).name,
Expand Down
2 changes: 1 addition & 1 deletion src/frequenz/client/reporting/cli/__main__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
from datetime import datetime, timedelta
from typing import AsyncIterator

from frequenz.client.common.metric import Metric
from frequenz.client.common.metrics import Metric

from frequenz.client.reporting import ReportingApiClient
from frequenz.client.reporting._types import MetricSample
Expand Down
2 changes: 1 addition & 1 deletion tests/test_client_reporting.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
from unittest.mock import MagicMock, patch

import pytest
from frequenz.api.reporting.v1.reporting_pb2_grpc import ReportingStub
from frequenz.api.reporting.v1alpha10.reporting_pb2_grpc import ReportingStub
from frequenz.client.base.channel import ChannelOptions
from frequenz.client.base.client import BaseApiClient

Expand Down