-
Notifications
You must be signed in to change notification settings - Fork 624
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix exception in Urllib3 when dealing with filelike body.
Showing
4 changed files
with
290 additions
and
141 deletions.
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
270 changes: 270 additions & 0 deletions
270
instrumentation/opentelemetry-instrumentation-urllib3/tests/test_urllib3_metrics.py
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,270 @@ | ||
# 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. | ||
|
||
import io | ||
from timeit import default_timer | ||
|
||
import httpretty | ||
import urllib3 | ||
import urllib3.exceptions | ||
from urllib3.request import encode_multipart_formdata | ||
|
||
from opentelemetry.instrumentation.urllib3 import URLLib3Instrumentor | ||
from opentelemetry.sdk.metrics.export import ( | ||
HistogramDataPoint, | ||
NumberDataPoint, | ||
) | ||
from opentelemetry.test.httptest import HttpTestBase | ||
from opentelemetry.test.test_base import TestBase | ||
|
||
|
||
class TestURLLib3InstrumentorMetric(HttpTestBase, TestBase): | ||
HTTP_URL = "http://httpbin.org/status/200" | ||
|
||
def setUp(self): | ||
super().setUp() | ||
URLLib3Instrumentor().instrument() | ||
httpretty.enable(allow_net_connect=False) | ||
httpretty.register_uri(httpretty.GET, self.HTTP_URL, body="Hello!") | ||
httpretty.register_uri(httpretty.POST, self.HTTP_URL, body="Hello!") | ||
self.pool = urllib3.PoolManager() | ||
|
||
def tearDown(self): | ||
super().tearDown() | ||
self.pool.clear() | ||
URLLib3Instrumentor().uninstrument() | ||
|
||
httpretty.disable() | ||
httpretty.reset() | ||
|
||
def get_sorted_metrics(self): | ||
resource_metrics = ( | ||
self.memory_metrics_reader.get_metrics_data().resource_metrics | ||
) | ||
for metrics in resource_metrics: | ||
for scope_metrics in metrics.scope_metrics: | ||
all_metrics = list(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( | ||
self, metric, expected_value, expected_attributes | ||
): | ||
data_point = next(metric.data.data_points) | ||
|
||
if isinstance(data_point, HistogramDataPoint): | ||
self.assertEqual( | ||
data_point.sum, | ||
expected_value, | ||
) | ||
elif isinstance(data_point, NumberDataPoint): | ||
self.assertEqual( | ||
data_point.value, | ||
expected_value, | ||
) | ||
|
||
self.assertDictEqual( | ||
expected_attributes, | ||
dict(data_point.attributes), | ||
) | ||
|
||
def assert_duration_metric_expected( | ||
self, metric, duration_estimated, expected_attributes | ||
): | ||
data_point = next(metric.data.data_points) | ||
|
||
self.assertAlmostEqual( | ||
data_point.sum, | ||
duration_estimated, | ||
delta=200, | ||
) | ||
|
||
self.assertDictEqual( | ||
expected_attributes, | ||
dict(data_point.attributes), | ||
) | ||
|
||
def test_basic_metrics(self): | ||
start_time = default_timer() | ||
response = self.pool.request("GET", self.HTTP_URL) | ||
client_duration_estimated = (default_timer() - start_time) * 1000 | ||
|
||
metrics = self.get_sorted_metrics() | ||
|
||
( | ||
client_duration, | ||
client_request_size, | ||
client_response_size, | ||
) = metrics | ||
|
||
self.assertEqual(client_duration.name, "http.client.duration") | ||
self.assert_duration_metric_expected( | ||
client_duration, | ||
client_duration_estimated, | ||
{ | ||
"http.flavor": "1.1", | ||
"http.host": "httpbin.org", | ||
"http.method": "GET", | ||
"http.scheme": "http", | ||
"http.status_code": 200, | ||
"net.peer.name": "httpbin.org", | ||
"net.peer.port": 80, | ||
}, | ||
) | ||
|
||
self.assertEqual(client_request_size.name, "http.client.request.size") | ||
self.assert_metric_expected( | ||
client_request_size, | ||
0, | ||
{ | ||
"http.flavor": "1.1", | ||
"http.host": "httpbin.org", | ||
"http.method": "GET", | ||
"http.scheme": "http", | ||
"http.status_code": 200, | ||
"net.peer.name": "httpbin.org", | ||
"net.peer.port": 80, | ||
}, | ||
) | ||
|
||
self.assertEqual( | ||
client_response_size.name, "http.client.response.size" | ||
) | ||
self.assert_metric_expected( | ||
client_response_size, | ||
len(response.data), | ||
{ | ||
"http.flavor": "1.1", | ||
"http.host": "httpbin.org", | ||
"http.method": "GET", | ||
"http.scheme": "http", | ||
"http.status_code": 200, | ||
"net.peer.name": "httpbin.org", | ||
"net.peer.port": 80, | ||
}, | ||
) | ||
|
||
def test_str_request_body_size_metrics(self): | ||
self.pool.request("POST", self.HTTP_URL, body="foobar") | ||
|
||
metrics = self.get_sorted_metrics() | ||
(_, client_request_size, _) = metrics | ||
|
||
self.assertEqual(client_request_size.name, "http.client.request.size") | ||
self.assert_metric_expected( | ||
client_request_size, | ||
6, | ||
{ | ||
"http.flavor": "1.1", | ||
"http.host": "httpbin.org", | ||
"http.method": "POST", | ||
"http.scheme": "http", | ||
"http.status_code": 200, | ||
"net.peer.name": "httpbin.org", | ||
"net.peer.port": 80, | ||
}, | ||
) | ||
|
||
def test_bytes_request_body_size_metrics(self): | ||
self.pool.request("POST", self.HTTP_URL, body=b"foobar") | ||
|
||
metrics = self.get_sorted_metrics() | ||
(_, client_request_size, _) = metrics | ||
|
||
self.assertEqual(client_request_size.name, "http.client.request.size") | ||
self.assert_metric_expected( | ||
client_request_size, | ||
6, | ||
{ | ||
"http.flavor": "1.1", | ||
"http.host": "httpbin.org", | ||
"http.method": "POST", | ||
"http.scheme": "http", | ||
"http.status_code": 200, | ||
"net.peer.name": "httpbin.org", | ||
"net.peer.port": 80, | ||
}, | ||
) | ||
|
||
def test_fields_request_body_size_metrics(self): | ||
self.pool.request("POST", self.HTTP_URL, fields={"foo": "bar"}) | ||
|
||
metrics = self.get_sorted_metrics() | ||
(_, client_request_size, _) = metrics | ||
|
||
self.assertEqual(client_request_size.name, "http.client.request.size") | ||
self.assert_metric_expected( | ||
client_request_size, | ||
len(encode_multipart_formdata({"foo": "bar"})[0]), | ||
{ | ||
"http.flavor": "1.1", | ||
"http.host": "httpbin.org", | ||
"http.method": "POST", | ||
"http.scheme": "http", | ||
"http.status_code": 200, | ||
"net.peer.name": "httpbin.org", | ||
"net.peer.port": 80, | ||
}, | ||
) | ||
|
||
def test_bytesio_request_body_size_metrics(self): | ||
self.pool.request("POST", self.HTTP_URL, body=io.BytesIO(b"foobar")) | ||
|
||
metrics = self.get_sorted_metrics() | ||
(_, client_request_size, _) = metrics | ||
|
||
self.assertEqual(client_request_size.name, "http.client.request.size") | ||
self.assert_metric_expected( | ||
client_request_size, | ||
6, | ||
{ | ||
"http.flavor": "1.1", | ||
"http.host": "httpbin.org", | ||
"http.method": "POST", | ||
"http.scheme": "http", | ||
"http.status_code": 200, | ||
"net.peer.name": "httpbin.org", | ||
"net.peer.port": 80, | ||
}, | ||
) | ||
|
||
def test_generator_request_body_size_metrics(self): | ||
self.pool.request( | ||
"POST", self.HTTP_URL, body=(b for b in (b"foo", b"bar")) | ||
) | ||
|
||
metrics = self.get_sorted_metrics() | ||
self.assertEqual(len(metrics), 2) | ||
self.assertNotIn("http.client.request.size", [m.name for m in metrics]) | ||
|
||
def test_metric_uninstrument(self): | ||
self.pool.request("GET", self.HTTP_URL) | ||
URLLib3Instrumentor().uninstrument() | ||
self.pool.request("GET", self.HTTP_URL) | ||
|
||
metrics_list = self.memory_metrics_reader.get_metrics_data() | ||
for resource_metric in metrics_list.resource_metrics: | ||
for scope_metric in resource_metric.scope_metrics: | ||
for metric in scope_metric.metrics: | ||
for point in list(metric.data.data_points): | ||
self.assertEqual(point.count, 1) |