Merge pull request #45 from stefan-brus-frequenz/sources

Add metric source options message

Author: stefan-brus-frequenz

RELEASE_NOTES.md

@@ -2,15 +2,17 @@
 
 ## Summary
 
-- Add time filter options to the streaming request, to allow for streaming of historical data.
+- Metric source options
 
 ## Upgrading
 
 <!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
 
 ## New Features
 
-- The streaming requests now contain optional `TimeFilter` objects for streaming historical data.
+- A new field, `MetricSourceOptions` has been added to the `StreamFilter` message, allowing users to give specific sources for a given metric.
+  Multiples of the same metric can exist, in which case they are "tagged" with the source they come from. The metric source options allows
+  the user to specify one or multiple tags.
 
 ## Bug Fixes
 

proto/frequenz/api/reporting/v1/reporting.proto

@@ -182,6 +182,18 @@ message SimpleAggregatedMetricValue {
   frequenz.api.common.v1.metrics.SimpleMetricValue sample = 2;
 }
 
+// Filter for sources for metrics, specified for a single metric at a time.
+// Specifying a metric here will only stream data for that metric where data
+// can be found tagged with the given source names.
+message MetricSourceOptions {
+  // The metric for which sources will be filtered.
+  frequenz.api.common.v1.metrics.Metric metric = 1;
+
+  // A list of sources to allow for the specified metric.
+  // If this list is empty, then no data for this metric is streamed.
+  repeated string metric_sources = 2;
+}
+
 // Message defining the request format for fetching historical metrics, such as electrical
 // measurements, and other information for individual microgrid components.
 //
@@ -312,6 +324,14 @@ message ReceiveMicrogridComponentsDataStreamRequest {
     // Optional time-based filter criteria.
     // If omitted, data will start streaming from the timestamp that the request was received.
     TimeFilter time_filter = 3;
+
+    // List of metric source filters
+    // For the metrics present in this list, the data from only the specified
+    // sources will be returned. If no sources are provided for a metric in this
+    // list, then no data will be returned for the said metric.
+    // For the metrics not present in this list, data from all of their sources will
+    // be returned.
+    repeated MetricSourceOptions metric_sources = 4;
   }
 
   // Encapsulates the microgrid ID and the component IDs within that microgrid for which