Skip to content

add missing tests to urllib3 after semconv migration #2748

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Jul 30, 2024
Merged

add missing tests to urllib3 after semconv migration #2748

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cef7fcd
add missing tests to urllib3 after semconv migration
emdneto Jul 29, 2024
82c061b
use plain string instead of semconv symbols
emdneto Jul 29, 2024
13c38a6
Merge branch 'main' into patch-urllib3-tests-semconv
shalevr Jul 29, 2024
943cd2d
Merge branch 'main' into patch-urllib3-tests-semconv
lzchen Jul 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
161 changes: 158 additions & 3 deletions instrumentation/opentelemetry-instrumentation-urllib3/tests/test_urllib3_metrics.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,10 @@
_OpenTelemetrySemanticConventionStability,
)
from opentelemetry.instrumentation.urllib3 import URLLib3Instrumentor
from opentelemetry.semconv._incubating.metrics.http_metrics import (
HTTP_CLIENT_REQUEST_BODY_SIZE,
HTTP_CLIENT_RESPONSE_BODY_SIZE,
)
from opentelemetry.semconv.attributes.http_attributes import (
HTTP_REQUEST_METHOD,
HTTP_RESPONSE_STATUS_CODE,
Expand All @@ -37,6 +41,10 @@
SERVER_ADDRESS,
SERVER_PORT,
)
from opentelemetry.semconv.metrics import MetricInstruments
from opentelemetry.semconv.metrics.http_metrics import (
HTTP_CLIENT_REQUEST_DURATION,
)
from opentelemetry.semconv.trace import SpanAttributes
from opentelemetry.test.httptest import HttpTestBase
from opentelemetry.test.test_base import TestBase
Expand Down Expand Up @@ -85,6 +93,7 @@ def test_basic_metrics(self):
response = self.pool.request("GET", self.HTTP_URL)
duration_ms = max(round((default_timer() - start_time) * 1000), 0)
metrics = self.get_sorted_metrics()
self.assertEqual(len(metrics), 3)

(
client_duration,
Expand All @@ -102,7 +111,9 @@ def test_basic_metrics(self):
SpanAttributes.HTTP_SCHEME: "http",
}

self.assertEqual(client_duration.name, "http.client.duration")
self.assertEqual(
client_duration.name, MetricInstruments.HTTP_CLIENT_DURATION
)
self.assert_metric_expected(
client_duration,
[
Expand All @@ -117,7 +128,10 @@ def test_basic_metrics(self):
est_value_delta=40,
)

self.assertEqual(client_request_size.name, "http.client.request.size")
self.assertEqual(
client_request_size.name,
MetricInstruments.HTTP_CLIENT_REQUEST_SIZE,
)
self.assert_metric_expected(
client_request_size,
[
Expand All @@ -133,7 +147,8 @@ def test_basic_metrics(self):

expected_size = len(response.data)
self.assertEqual(
client_response_size.name, "http.client.response.size"
client_response_size.name,
MetricInstruments.HTTP_CLIENT_RESPONSE_SIZE,
)
self.assert_metric_expected(
client_response_size,
Expand All @@ -154,6 +169,7 @@ def test_basic_metrics_new_semconv(self):
duration_s = max(default_timer() - start_time, 0)

metrics = self.get_sorted_metrics()
self.assertEqual(len(metrics), 3)
(
client_request_size,
client_duration,
Expand Down Expand Up @@ -217,6 +233,145 @@ def test_basic_metrics_new_semconv(self):
],
)

def test_basic_metrics_both_semconv(self):
start_time = default_timer()
response = self.pool.request("GET", self.HTTP_URL)
duration_s = max(default_timer() - start_time, 0)
duration = max(round(duration_s * 1000), 0)
expected_size = len(response.data)

metrics = self.get_sorted_metrics()
self.assertEqual(len(metrics), 6)

(
client_duration,
client_request_body_size,
client_request_duration,
client_request_size,
client_response_body_size,
client_response_size,
) = metrics[:6]

attrs_new = {
NETWORK_PROTOCOL_VERSION: "1.1",
SERVER_ADDRESS: "mock",
SERVER_PORT: 80,
HTTP_REQUEST_METHOD: "GET",
HTTP_RESPONSE_STATUS_CODE: 200,
# TODO: add URL_SCHEME to tests when supported in the implementation
}

attrs_old = {
SpanAttributes.HTTP_STATUS_CODE: 200,
SpanAttributes.HTTP_HOST: "mock",
SpanAttributes.NET_PEER_PORT: 80,
SpanAttributes.NET_PEER_NAME: "mock",
SpanAttributes.HTTP_METHOD: "GET",
SpanAttributes.HTTP_FLAVOR: "1.1",
SpanAttributes.HTTP_SCHEME: "http",
}

# assert new semconv metrics
self.assertEqual(
client_request_duration.name, HTTP_CLIENT_REQUEST_DURATION
)
self.assert_metric_expected(
client_request_duration,
[
self.create_histogram_data_point(
count=1,
sum_data_point=duration_s,
max_data_point=duration_s,
min_data_point=duration_s,
attributes=attrs_new,
)
],
est_value_delta=40 / 1000,
)

self.assertEqual(
client_request_body_size.name, HTTP_CLIENT_REQUEST_BODY_SIZE
)
self.assert_metric_expected(
client_request_body_size,
[
self.create_histogram_data_point(
count=1,
sum_data_point=0,
max_data_point=0,
min_data_point=0,
attributes=attrs_new,
)
],
)

self.assertEqual(
client_response_body_size.name, HTTP_CLIENT_RESPONSE_BODY_SIZE
)
self.assert_metric_expected(
client_response_body_size,
[
self.create_histogram_data_point(
count=1,
sum_data_point=expected_size,
max_data_point=expected_size,
min_data_point=expected_size,
attributes=attrs_new,
)
],
)
# assert old semconv metrics
self.assertEqual(
client_duration.name, MetricInstruments.HTTP_CLIENT_DURATION
)
self.assert_metric_expected(
client_duration,
[
self.create_histogram_data_point(
count=1,
sum_data_point=duration,
max_data_point=duration,
min_data_point=duration,
attributes=attrs_old,
)
],
est_value_delta=40,
)

self.assertEqual(
client_request_size.name,
MetricInstruments.HTTP_CLIENT_REQUEST_SIZE,
)
self.assert_metric_expected(
client_request_size,
[
self.create_histogram_data_point(
count=1,
sum_data_point=0,
max_data_point=0,
min_data_point=0,
attributes=attrs_old,
)
],
)

self.assertEqual(
client_response_size.name,
MetricInstruments.HTTP_CLIENT_RESPONSE_SIZE,
)
self.assert_metric_expected(
client_response_size,
[
self.create_histogram_data_point(
count=1,
sum_data_point=expected_size,
max_data_point=expected_size,
min_data_point=expected_size,
attributes=attrs_old,
)
],
)

@mock.patch("httpretty.http.HttpBaseClass.METHODS", ("NONSTANDARD",))
def test_basic_metrics_nonstandard_http_method(self):
httpretty.register_uri(
Expand Down
Loading