-
Notifications
You must be signed in to change notification settings - Fork 889
feat(exporter/prometheus): add default_aggregation parameter to PrometheusMetricReader #5117
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.
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
base: main
Are you sure you want to change the base?
Changes from all commits
c6c9fb6
7496e21
a3a346d
43ac409
9c9e127
82e50d2
4b05eb8
09e73f4
ad456a7
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -105,6 +105,9 @@ | |||||
| MetricsData, | ||||||
| Sum, | ||||||
| ) | ||||||
| from opentelemetry.sdk.metrics.view import ( | ||||||
| Aggregation, | ||||||
| ) | ||||||
| from opentelemetry.semconv._incubating.attributes.otel_attributes import ( | ||||||
| OtelComponentTypeValues, | ||||||
| ) | ||||||
|
|
@@ -135,7 +138,10 @@ class PrometheusMetricReader(MetricReader): | |||||
| """Prometheus metric exporter for OpenTelemetry.""" | ||||||
|
|
||||||
| def __init__( | ||||||
| self, disable_target_info: bool = False, prefix: str = "" | ||||||
| self, | ||||||
| disable_target_info: bool = False, | ||||||
| prefix: str = "", | ||||||
| preferred_aggregation: dict[type, Aggregation] | None = None, | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
We should follow the preferred naming in the spec here. |
||||||
| ) -> None: | ||||||
| super().__init__( | ||||||
| preferred_temporality={ | ||||||
|
|
@@ -146,6 +152,7 @@ def __init__( | |||||
| ObservableUpDownCounter: AggregationTemporality.CUMULATIVE, | ||||||
| ObservableGauge: AggregationTemporality.CUMULATIVE, | ||||||
| }, | ||||||
| preferred_aggregation=preferred_aggregation, | ||||||
| otel_component_type=OtelComponentTypeValues.PROMETHEUS_HTTP_TEXT_METRIC_EXPORTER, | ||||||
| ) | ||||||
| self._collector = _CustomCollector( | ||||||
|
|
||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -28,6 +28,7 @@ | |
| _CustomCollector, | ||
| ) | ||
| from opentelemetry.metrics import NoOpMeterProvider | ||
| from opentelemetry.sdk.metrics import Histogram as HistogramInstrument | ||
| from opentelemetry.sdk.metrics import MeterProvider | ||
| from opentelemetry.sdk.metrics.export import ( | ||
| AggregationTemporality, | ||
|
|
@@ -38,6 +39,7 @@ | |
| ResourceMetrics, | ||
| ScopeMetrics, | ||
| ) | ||
| from opentelemetry.sdk.metrics.view import ExplicitBucketHistogramAggregation | ||
| from opentelemetry.sdk.resources import Resource | ||
| from opentelemetry.test.metrictestutil import ( | ||
| _generate_gauge, | ||
|
|
@@ -47,6 +49,7 @@ | |
| ) | ||
|
|
||
|
|
||
| # pylint: disable=too-many-public-methods | ||
| class TestPrometheusMetricReader(TestCase): | ||
| def setUp(self): | ||
| self._mock_registry_register = Mock() | ||
|
|
@@ -719,3 +722,30 @@ def test_multiple_data_points_with_different_label_sets(self): | |
| """ | ||
| ), | ||
| ) | ||
|
|
||
| def test_preferred_aggregation(self): | ||
| """Test that preferred_aggregation parameter is passed to MetricReader.""" | ||
| custom_aggregation = { | ||
| HistogramInstrument: ExplicitBucketHistogramAggregation( | ||
| boundaries=[1.0, 5.0, 10.0] | ||
| ) | ||
| } | ||
| reader = PrometheusMetricReader( | ||
| preferred_aggregation=custom_aggregation | ||
| ) | ||
| provider = MeterProvider(metric_readers=[reader]) | ||
| meter = provider.get_meter("test") | ||
| histogram = meter.create_histogram("test_histogram") | ||
| histogram.record(5) | ||
| result = list(reader._collector.collect()) | ||
| self.assertTrue(len(result) > 0) | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can we do some additional verification here to actually verify that the boundaries specified above are respected?
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Done! Added verification to check that the custom boundaries [1.0, 5.0, 10.0] are present in the Prometheus output. Thanks for the suggestion. |
||
| prometheus_metric = result[1] | ||
| bucket_bounds = [ | ||
| sample.labels["le"] | ||
| for sample in prometheus_metric.samples | ||
| if "le" in sample.labels | ||
| ] | ||
| self.assertIn("1.0", bucket_bounds) | ||
| self.assertIn("5.0", bucket_bounds) | ||
| self.assertIn("10.0", bucket_bounds) | ||
| reader.shutdown() | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Likewise, this needs to be changed to a changelog fragment following the latest conventions.