This initial version of the reporting API client offers focused functionality to retrieve historical data for a single metric from a single component.
Features of this version:
Pagination Handling: Seamlessly request time series data of a single metric from a single component, with integrated pagination management.
Data Transformation: Utilize a wrapper data class that retains the raw protobuf response while offering transformation capabilities. A generator function is provided for iterating over individual page values.
Structured Data: Streamline data representation through named tuples for timestamp and value pairs, eliminating ambiguity for single component and metric scenarios.
Usage Examples: Code examples demonstrate usage, along with experimental code for upcoming features (considered for removal).
Unit Testing: Basic unit tests are included.
Limitations of this version:
Single Metric Focus: Initially supporting queries for individual metrics to support most common use cases, with an extensible design for multiple metrics/components in future. ->
States and bounds: In line with focus on widely used functionalities, the approach to integrating states and bounds within the data structures is still under exploration. ->
Streaming: Functions not yet available (service-side). Current generator implementations on pages and entries can be aligned with streaming output in future. ->
This initial version of the reporting API client offers focused functionality to retrieve historical data for a single metric from a single component.
Features of this version:
Limitations of this version:
SimpleMetricSampleexclusively, with decision on how to integrateAggregatedMetricSamplepending. ->