Skip to content

Add and maintain allowlist for message streams from microgrid API #784

@matthias-wende-frequenz

Description

What's needed?

The microgrid API has changed and now the data streaming request sends a list of metrics.
With that change from a product type to a list type it becomes feasible to add filter and the proposed change in the microgrid-api ReceiveComponentDataStream has been suggested.

In the current implementation, using the last stable microgrid api release, a request to a component returns a stream with a full set of metrics that belong to that component category.

In the future the call will need a allowlist of parameters that are should be returned.

Proposed solution

There are several possibilities.

  1. We mimic the old behavior by adding a full set of metrics for a category but leave out unused metrics.

  2. We only request what is needed and issue a new request to the api when a new datastream is established.

Option 2) is closer to the sdk design where we start a data pipeline only on demand to the DataSourcingActor
Furthermore it makes maintenance of the allowlist easier because we only get what has been asked for. If a user asks for a new metric it will seamlessly added to the stream.

Use cases

No response

Alternatives and workarounds

No response

Additional context

No response

Metadata

Metadata

Labels

part:data-pipelineAffects the data pipelinepart:microgridAffects the interactions with the microgridpriority:highAddress this as soon as possibleresolution:duplicateThis issue or pull request already existstype:enhancementNew feature or enhancement visitble to users

Type

No type

Projects

Status

Done

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions