Skip to content

Support secret to sign requests to reporting client #53

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 1 commit into from
Jun 25, 2025
Merged

Support secret to sign requests to reporting client #53

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 1 addition & 1 deletion RELEASE_NOTES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

## Upgrading

<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
- The reporting API client version is updated to `>= 0.18.0, < 0.19.0`.

## New Features

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ classifiers = [
requires-python = ">= 3.11, < 4"
dependencies = [
"typing-extensions >= 4.6.1, < 5",
"frequenz-client-reporting>=0.13.0, < 1",
"frequenz-client-reporting >= 0.18.0, < 0.19.0",
"frequenz-client-common >= 0.3.0, < 0.4",
]
dynamic = ["version"]
Expand Down
26 changes: 13 additions & 13 deletions src/frequenz/reporting/_reporting.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

from frequenz.client.common.metric import Metric
from frequenz.client.reporting import ReportingApiClient
from frequenz.client.reporting._client import MetricSample
from frequenz.client.reporting._types import MetricSample

CumulativeEnergy = namedtuple(
"CumulativeEnergy", ["start_time", "end_time", "consumption", "production"]
Expand Down Expand Up @@ -49,11 +49,11 @@ async def cumulative_energy(

metric_samples = [
sample
async for sample in client.list_microgrid_components_data(
async for sample in client.receive_microgrid_components_data(
microgrid_components=[(microgrid_id, [component_id])],
metrics=metric,
start_dt=start_time,
end_dt=end_time,
start_time=start_time,
end_time=end_time,
resampling_period=resampling_period,
)
]
Expand Down Expand Up @@ -101,22 +101,22 @@ async def cumulative_energy(
# Fetch energy consumption and production metrics separately
consumption_samples = [
sample
async for sample in client.list_microgrid_components_data(
async for sample in client.receive_microgrid_components_data(
microgrid_components=[(microgrid_id, [component_id])],
metrics=Metric.AC_ACTIVE_ENERGY_CONSUMED,
start_dt=start_time,
end_dt=end_time,
start_time=start_time,
end_time=end_time,
resampling_period=resampling_period,
)
]

production_samples = [
sample
async for sample in client.list_microgrid_components_data(
async for sample in client.receive_microgrid_components_data(
microgrid_components=[(microgrid_id, [component_id])],
metrics=Metric.AC_ACTIVE_ENERGY_DELIVERED,
start_dt=start_time,
end_dt=end_time,
start_time=start_time,
end_time=end_time,
resampling_period=resampling_period,
)
]
Expand Down Expand Up @@ -350,11 +350,11 @@ async def _fetch_component_data(
"""
return [
sample
async for sample in client.list_microgrid_components_data(
async for sample in client.receive_microgrid_components_data(
microgrid_components=microgrid_components,
metrics=metrics,
start_dt=start_time,
end_dt=end_time,
start_time=start_time,
end_time=end_time,
resampling_period=resampling_period,
include_states=include_states,
include_bounds=include_bounds,
Expand Down
46 changes: 23 additions & 23 deletions tests/test_frequenz_reporting.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
from typing import Any

import pytest
from frequenz.client.reporting._client import MetricSample
from frequenz.client.reporting._types import MetricSample

from frequenz.reporting import delete_me
from frequenz.reporting._reporting import extract_state_durations
Expand All @@ -23,8 +23,8 @@
{
"description": "No matching metrics",
"samples": [
MetricSample(datetime(2023, 1, 1, 0, 0), 1, 101, "temperature", 25),
MetricSample(datetime(2023, 1, 1, 1, 0), 1, 101, "humidity", 60),
MetricSample(datetime(2023, 1, 1, 0, 0), 1, "101", "temperature", 25),
MetricSample(datetime(2023, 1, 1, 1, 0), 1, "101", "humidity", 60),
],
"alert_states": [1],
"include_warnings": True,
Expand All @@ -34,23 +34,23 @@
{
"description": "Single state change",
"samples": [
MetricSample(datetime(2023, 1, 1, 0, 0), 1, 101, "state", 0),
MetricSample(datetime(2023, 1, 1, 1, 0), 1, 101, "state", 1),
MetricSample(datetime(2023, 1, 1, 0, 0), 1, "101", "state", 0),
MetricSample(datetime(2023, 1, 1, 1, 0), 1, "101", "state", 1),
],
"alert_states": [1],
"include_warnings": True,
"expected_all_states": [
{
"microgrid_id": 1,
"component_id": 101,
"component_id": "101",
"state_type": "state",
"state_value": 0,
"start_time": datetime(2023, 1, 1, 0, 0),
"end_time": datetime(2023, 1, 1, 1, 0),
},
{
"microgrid_id": 1,
"component_id": 101,
"component_id": "101",
"state_type": "state",
"state_value": 1,
"start_time": datetime(2023, 1, 1, 1, 0),
Expand All @@ -60,7 +60,7 @@
"expected_alert_records": [
{
"microgrid_id": 1,
"component_id": 101,
"component_id": "101",
"state_type": "state",
"state_value": 1,
"start_time": datetime(2023, 1, 1, 1, 0),
Expand All @@ -71,26 +71,26 @@
{
"description": "Warnings and errors included",
"samples": [
MetricSample(datetime(2023, 1, 2, 0, 0), 3, 303, "state", 0),
MetricSample(datetime(2023, 1, 2, 0, 30), 3, 303, "warning", "W1"),
MetricSample(datetime(2023, 1, 2, 1, 0), 3, 303, "state", 1),
MetricSample(datetime(2023, 1, 2, 1, 30), 3, 303, "error", "E1"),
MetricSample(datetime(2023, 1, 2, 0, 0), 3, "303", "state", 0),
MetricSample(datetime(2023, 1, 2, 0, 30), 3, "303", "warning", 10),
MetricSample(datetime(2023, 1, 2, 1, 0), 3, "303", "state", 1),
MetricSample(datetime(2023, 1, 2, 1, 30), 3, "303", "error", 20),
],
"alert_states": [1],
"include_warnings": True,
"expected_all_states": [
# State transitions
{
"microgrid_id": 3,
"component_id": 303,
"component_id": "303",
"state_type": "state",
"state_value": 0,
"start_time": datetime(2023, 1, 2, 0, 0),
"end_time": datetime(2023, 1, 2, 1, 0),
},
{
"microgrid_id": 3,
"component_id": 303,
"component_id": "303",
"state_type": "state",
"state_value": 1,
"start_time": datetime(2023, 1, 2, 1, 0),
Expand All @@ -99,43 +99,43 @@
# Warning transitions
{
"microgrid_id": 3,
"component_id": 303,
"component_id": "303",
"state_type": "warning",
"state_value": "W1",
"state_value": 10,
"start_time": datetime(2023, 1, 2, 0, 30),
"end_time": None,
},
# Error transitions
{
"microgrid_id": 3,
"component_id": 303,
"component_id": "303",
"state_type": "error",
"state_value": "E1",
"state_value": 20,
"start_time": datetime(2023, 1, 2, 1, 30),
"end_time": None,
},
],
"expected_alert_records": [
{
"microgrid_id": 3,
"component_id": 303,
"component_id": "303",
"state_type": "warning",
"state_value": "W1",
"state_value": 10,
"start_time": datetime(2023, 1, 2, 0, 30),
"end_time": None,
},
{
"microgrid_id": 3,
"component_id": 303,
"component_id": "303",
"state_type": "error",
"state_value": "E1",
"state_value": 20,
"start_time": datetime(2023, 1, 2, 1, 30),
"end_time": None,
},
# State alert
{
"microgrid_id": 3,
"component_id": 303,
"component_id": "303",
"state_type": "state",
"state_value": 1,
"start_time": datetime(2023, 1, 2, 1, 0),
Expand Down
Loading