Expose resampling option (#52)

Addressing issue #22 by exposing the resampling option as an optional
input.

Author: flora-hofmann-frequenz

RELEASE_NOTES.md

@@ -10,7 +10,8 @@
 
 ## New Features
 
-<!-- Here goes the main new features and examples or instructions on how to use them -->
+* The `ReportingApiClient` exposes the resampling option of the data, with its 
+resolution represented in second and its default set to `None.
 
 ## Bug Fixes
 

examples/client.py

@@ -49,6 +49,7 @@ def main() -> None:
         help="End datetime in YYYY-MM-DDTHH:MM:SS format",
         required=True,
     )
+    parser.add_argument("--resolution", type=int, help="Resolution", default=None)
     parser.add_argument("--psize", type=int, help="Page size", default=100)
     parser.add_argument(
         "--display", choices=["iter", "df", "dict"], help="Display format", default="df"
@@ -61,20 +62,22 @@ def main() -> None:
             args.metrics,
             args.start,
             args.end,
+            args.resolution,
             page_size=args.psize,
             service_address=args.url,
             display=args.display,
         )
     )
 
 
-# pylint: disable=too-many-arguments
+# pylint: disable=too-many-arguments, too-many-locals
 async def run(
     microgrid_id: int,
     component_id: int,
     metric_names: list[str],
     start_dt: datetime,
     end_dt: datetime,
+    resolution: int,
     page_size: int,
     service_address: str,
     display: str,
@@ -87,6 +90,7 @@ async def run(
         metric_names: list of metric names
         start_dt: start datetime
         end_dt: end datetime
+        resolution: resampling resolution in sec
         page_size: page size
         service_address: service address
         display: display format
@@ -112,6 +116,7 @@ def data_iter() -> AsyncIterator[MetricSample]:
             metrics=metrics,
             start_dt=start_dt,
             end_dt=end_dt,
+            resolution=resolution,
             page_size=page_size,
         )
 

src/frequenz/client/reporting/_client.py

@@ -24,6 +24,9 @@
 from frequenz.api.reporting.v1.reporting_pb2 import (
     ListMicrogridComponentsDataResponse as PBListMicrogridComponentsDataResponse,
 )
+from frequenz.api.reporting.v1.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.client.common.metric import Metric
@@ -130,6 +133,7 @@ async def list_single_component_data(
         metrics: Metric | list[Metric],
         start_dt: datetime,
         end_dt: datetime,
+        resolution: int | None,
         page_size: int = 1000,
     ) -> AsyncIterator[MetricSample]:
         """Iterate over the data for a single metric.
@@ -140,6 +144,7 @@ async def list_single_component_data(
             metrics: The metric name or list of metric names.
             start_dt: The start date and time.
             end_dt: The end date and time.
+            resolution: The resampling resolution for the data, represented in seconds.
             page_size: The page size.
 
         Yields:
@@ -152,6 +157,7 @@ async def list_single_component_data(
             metrics=[metrics] if isinstance(metrics, Metric) else metrics,
             start_dt=start_dt,
             end_dt=end_dt,
+            resolution=resolution,
             page_size=page_size,
         ):
             for entry in page:
@@ -165,6 +171,7 @@ async def list_microgrid_components_data(
         metrics: Metric | list[Metric],
         start_dt: datetime,
         end_dt: datetime,
+        resolution: int | None,
         page_size: int = 1000,
     ) -> AsyncIterator[MetricSample]:
         """Iterate over the data for multiple microgrids and components.
@@ -175,6 +182,7 @@ async def list_microgrid_components_data(
             metrics: The metric name or list of metric names.
             start_dt: The start date and time.
             end_dt: The end date and time.
+            resolution: The resampling resolution for the data, represented in seconds.
             page_size: The page size.
 
         Yields:
@@ -190,6 +198,7 @@ async def list_microgrid_components_data(
             metrics=[metrics] if isinstance(metrics, Metric) else metrics,
             start_dt=start_dt,
             end_dt=end_dt,
+            resolution=resolution,
             page_size=page_size,
         ):
             for entry in page:
@@ -203,7 +212,8 @@ async def _list_microgrid_components_data_pages(
         metrics: list[Metric],
         start_dt: datetime,
         end_dt: datetime,
-        page_size: int = 1000,
+        resolution: int | None,
+        page_size: int,
     ) -> AsyncIterator[ComponentsDataPage]:
         """Iterate over the pages of microgrid components data.
 
@@ -215,6 +225,7 @@ async def _list_microgrid_components_data_pages(
             metrics: A list of metrics.
             start_dt: The start date and time.
             end_dt: The end date and time.
+            resolution: The resampling resolution for the data, represented in seconds.
             page_size: The page size.
 
         Yields:
@@ -237,6 +248,7 @@ def dt2ts(dt: datetime) -> PBTimestamp:
 
         list_filter = PBListMicrogridComponentsDataRequest.ListFilter(
             time_filter=time_filter,
+            resampling_options=PBResamplingOptions(resolution=resolution),
         )
 
         metrics_pb = [metric.to_proto() for metric in metrics]