Add metric instrumentation for urllib #1553
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -14,3 +14,5 @@ | |
|
|
||
|
|
||
| _instruments = tuple() | ||
|
|
||
| _supports_metrics = True | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,246 @@ | ||
| # Copyright The OpenTelemetry Authors | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
|
|
||
| from timeit import default_timer | ||
| from typing import Optional, Union | ||
| from urllib import request | ||
| from urllib.parse import urlencode | ||
|
|
||
| import httpretty | ||
|
|
||
| from opentelemetry.instrumentation.urllib import ( # pylint: disable=no-name-in-module,import-error | ||
| URLLibInstrumentor, | ||
| ) | ||
| from opentelemetry.sdk.metrics._internal.point import Metric | ||
| from opentelemetry.sdk.metrics.export import ( | ||
| HistogramDataPoint, | ||
| NumberDataPoint, | ||
| ) | ||
| from opentelemetry.semconv.metrics import MetricInstruments | ||
| from opentelemetry.test.test_base import TestBase | ||
|
|
||
|
|
||
| class TestRequestsIntegration(TestBase): | ||
| URL = "http://httpbin.org/status/200" | ||
| URL_POST = "http://httpbin.org/post" | ||
|
|
||
| def setUp(self): | ||
| super().setUp() | ||
| URLLibInstrumentor().instrument() | ||
| httpretty.enable() | ||
| httpretty.register_uri(httpretty.GET, self.URL, body=b"Hello!") | ||
| httpretty.register_uri( | ||
| httpretty.POST, self.URL_POST, body=b"Hello World!" | ||
| ) | ||
|
|
||
| def tearDown(self): | ||
| super().tearDown() | ||
| URLLibInstrumentor().uninstrument() | ||
| httpretty.disable() | ||
|
|
||
| def get_sorted_metrics(self): | ||
| resource_metrics = ( | ||
| self.memory_metrics_reader.get_metrics_data().resource_metrics | ||
| ) | ||
|
|
||
| all_metrics = [] | ||
| for metrics in resource_metrics: | ||
| for scope_metrics in metrics.scope_metrics: | ||
| all_metrics.extend(scope_metrics.metrics) | ||
|
|
||
| return self.sorted_metrics(all_metrics) | ||
|
|
||
| @staticmethod | ||
| def sorted_metrics(metrics): | ||
| """ | ||
| Sorts metrics by metric name. | ||
| """ | ||
| return sorted( | ||
| metrics, | ||
| key=lambda m: m.name, | ||
| ) | ||
|
|
||
| def assert_metric_expected( | ||
|
There was a problem hiding this comment. I used utils function for metrics assert There was a problem hiding this comment. I have some reservations about the PR on the main repo. I will leave a review there about it. |
||
| self, | ||
| metric: Metric, | ||
| expected_value: Union[int, float], | ||
| expected_attributes: dict, | ||
| est_delta: Optional[float] = None, | ||
| ): | ||
| data_point = next(iter(metric.data.data_points)) | ||
|
|
||
| if isinstance(data_point, HistogramDataPoint): | ||
| self.assertEqual( | ||
| data_point.count, | ||
| 1, | ||
| ) | ||
| if est_delta is None: | ||
| self.assertEqual( | ||
| data_point.sum, | ||
| expected_value, | ||
| ) | ||
| else: | ||
| self.assertAlmostEqual( | ||
| data_point.sum, | ||
| expected_value, | ||
| delta=est_delta, | ||
| ) | ||
| elif isinstance(data_point, NumberDataPoint): | ||
| self.assertEqual( | ||
| data_point.value, | ||
| expected_value, | ||
| ) | ||
|
|
||
| self.assertDictEqual( | ||
| expected_attributes, | ||
| dict(data_point.attributes), | ||
| ) | ||
|
|
||
| def test_basic_metric(self): | ||
| start_time = default_timer() | ||
| with request.urlopen(self.URL) as result: | ||
| client_duration_estimated = (default_timer() - start_time) * 1000 | ||
|
|
||
| metrics = self.get_sorted_metrics() | ||
| self.assertEqual(len(metrics), 3) | ||
|
|
||
| ( | ||
| client_duration, | ||
| client_request_size, | ||
| client_response_size, | ||
| ) = metrics[:3] | ||
|
|
||
| self.assertEqual( | ||
| client_duration.name, MetricInstruments.HTTP_CLIENT_DURATION | ||
| ) | ||
| self.assert_metric_expected( | ||
| client_duration, | ||
| client_duration_estimated, | ||
| { | ||
| "http.status_code": str(result.code), | ||
| "http.method": "GET", | ||
| "http.url": str(result.url), | ||
| "http.flavor": "1.1", | ||
| }, | ||
| est_delta=200, | ||
| ) | ||
|
|
||
| # net.peer.name | ||
|
|
||
| self.assertEqual( | ||
| client_request_size.name, | ||
| MetricInstruments.HTTP_CLIENT_REQUEST_SIZE, | ||
| ) | ||
| self.assert_metric_expected( | ||
| client_request_size, | ||
| 0, | ||
| { | ||
| "http.status_code": str(result.code), | ||
| "http.method": "GET", | ||
| "http.url": str(result.url), | ||
| "http.flavor": "1.1", | ||
| }, | ||
| ) | ||
|
|
||
| self.assertEqual( | ||
| client_response_size.name, | ||
| MetricInstruments.HTTP_CLIENT_RESPONSE_SIZE, | ||
| ) | ||
| self.assert_metric_expected( | ||
| client_response_size, | ||
| result.length, | ||
| { | ||
| "http.status_code": str(result.code), | ||
| "http.method": "GET", | ||
| "http.url": str(result.url), | ||
| "http.flavor": "1.1", | ||
| }, | ||
| ) | ||
|
|
||
| def test_basic_metric_request_not_empty(self): | ||
| data = {"header1": "value1", "header2": "value2"} | ||
| data_encoded = urlencode(data).encode() | ||
|
|
||
| start_time = default_timer() | ||
| with request.urlopen(self.URL_POST, data=data_encoded) as result: | ||
| client_duration_estimated = (default_timer() - start_time) * 1000 | ||
|
|
||
| metrics = self.get_sorted_metrics() | ||
| self.assertEqual(len(metrics), 3) | ||
|
|
||
| ( | ||
| client_duration, | ||
| client_request_size, | ||
| client_response_size, | ||
| ) = metrics[:3] | ||
|
|
||
| self.assertEqual( | ||
| client_duration.name, MetricInstruments.HTTP_CLIENT_DURATION | ||
| ) | ||
| self.assert_metric_expected( | ||
| client_duration, | ||
| client_duration_estimated, | ||
| { | ||
| "http.status_code": str(result.code), | ||
| "http.method": "POST", | ||
| "http.url": str(result.url), | ||
| "http.flavor": "1.1", | ||
| }, | ||
| est_delta=200, | ||
| ) | ||
|
|
||
| self.assertEqual( | ||
| client_request_size.name, | ||
| MetricInstruments.HTTP_CLIENT_REQUEST_SIZE, | ||
| ) | ||
| self.assert_metric_expected( | ||
| client_request_size, | ||
| len(data_encoded), | ||
| { | ||
| "http.status_code": str(result.code), | ||
| "http.method": "POST", | ||
| "http.url": str(result.url), | ||
| "http.flavor": "1.1", | ||
| }, | ||
| ) | ||
|
|
||
| self.assertEqual( | ||
| client_response_size.name, | ||
| MetricInstruments.HTTP_CLIENT_RESPONSE_SIZE, | ||
| ) | ||
| self.assert_metric_expected( | ||
| client_response_size, | ||
| result.length, | ||
| { | ||
| "http.status_code": str(result.code), | ||
| "http.method": "POST", | ||
| "http.url": str(result.url), | ||
| "http.flavor": "1.1", | ||
| }, | ||
| ) | ||
|
|
||
| def test_metric_uninstrument(self): | ||
| with request.urlopen(self.URL): | ||
| metrics = self.get_sorted_metrics() | ||
| self.assertEqual(len(metrics), 3) | ||
|
|
||
| URLLibInstrumentor().uninstrument() | ||
| with request.urlopen(self.URL): | ||
| metrics = self.get_sorted_metrics() | ||
| self.assertEqual(len(metrics), 3) | ||
|
|
||
| for metric in metrics: | ||
| for point in list(metric.data.data_points): | ||
| self.assertEqual(point.count, 1) | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Will this be a compressed size? Does data always return an iterable?
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.
#1399
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.
Thanks for the comment, I checked this issue while I wrote the code and the difference is the urllib api works only with bytes, and urllib3 works with bytes and IO(like BytesIO)