From a01f115365638da65669e9e8d68e60c982ea83ef Mon Sep 17 00:00:00 2001 From: "anshul.asawa" Date: Mon, 18 Jul 2022 14:36:38 +0530 Subject: [PATCH 01/12] add metric instrumentation changes I --- .../instrumentation/asgi/__init__.py | 51 ++++++++++++++++++- 1 file changed, 50 insertions(+), 1 deletion(-) diff --git a/instrumentation/opentelemetry-instrumentation-asgi/src/opentelemetry/instrumentation/asgi/__init__.py b/instrumentation/opentelemetry-instrumentation-asgi/src/opentelemetry/instrumentation/asgi/__init__.py index d2e42450a0..f788fc2950 100644 --- a/instrumentation/opentelemetry-instrumentation-asgi/src/opentelemetry/instrumentation/asgi/__init__.py +++ b/instrumentation/opentelemetry-instrumentation-asgi/src/opentelemetry/instrumentation/asgi/__init__.py @@ -150,10 +150,12 @@ def client_response_hook(span: Span, message: dict): import urllib from functools import wraps from typing import Tuple +from timeit import default_timer from asgiref.compatibility import guarantee_single_callable from opentelemetry import context, trace +from opentelemetry.metrics import get_meter from opentelemetry.instrumentation.asgi.version import __version__ # noqa from opentelemetry.instrumentation.propagators import ( get_global_response_propagator, @@ -179,6 +181,25 @@ def client_response_hook(span: Span, message: dict): _ClientRequestHookT = typing.Optional[typing.Callable[[Span, dict], None]] _ClientResponseHookT = typing.Optional[typing.Callable[[Span, dict], None]] +# List of recommended attributes +_duration_attrs = [ + SpanAttributes.HTTP_METHOD, + SpanAttributes.HTTP_HOST, + SpanAttributes.HTTP_SCHEME, + SpanAttributes.HTTP_STATUS_CODE, + SpanAttributes.HTTP_FLAVOR, + SpanAttributes.HTTP_SERVER_NAME, + SpanAttributes.NET_HOST_NAME, + SpanAttributes.NET_HOST_PORT, +] + +_active_requests_count_attrs = [ + SpanAttributes.HTTP_METHOD, + SpanAttributes.HTTP_HOST, + SpanAttributes.HTTP_SCHEME, + SpanAttributes.HTTP_FLAVOR, + SpanAttributes.HTTP_SERVER_NAME, +] class ASGIGetter(Getter[dict]): def get( @@ -360,6 +381,20 @@ def get_default_span_details(scope: dict) -> Tuple[str, dict]: return span_name, {} +def parse_active_request_count_attrs(req_attrs): + active_requests_count_attrs = {} + for attr_key in _active_requests_count_attrs: + if req_attrs.get(attr_key) is not None: + active_requests_count_attrs[attr_key] = req_attrs[attr_key] + return active_requests_count_attrs + +def parse_duration_attrs(req_attrs): + duration_attrs = {} + for attr_key in _duration_attrs: + if req_attrs.get(attr_key) is not None: + duration_attrs[attr_key] = req_attrs[attr_key] + return duration_attrs + class OpenTelemetryMiddleware: """The ASGI application middleware. @@ -391,9 +426,21 @@ def __init__( client_request_hook: _ClientRequestHookT = None, client_response_hook: _ClientResponseHookT = None, tracer_provider=None, + meter_provider=None, ): self.app = guarantee_single_callable(app) self.tracer = trace.get_tracer(__name__, __version__, tracer_provider) + self.meter = get_meter(__name__, __version__, meter_provider) + self.duration_histogram = self.meter.create_histogram( + name="http.server.duration", + unit="ms", + description="measures the duration of the inbound HTTP request", + ) + self.active_requests_counter = self.meter.create_up_down_counter( + name="http.server.active_requests", + unit="requests", + description="measures the number of concurrent HTTP requests that are currently in-flight", + ) self.excluded_urls = excluded_urls self.default_span_details = ( default_span_details or get_default_span_details @@ -426,7 +473,7 @@ async def __call__(self, scope, receive, send): context_carrier=scope, context_getter=asgi_getter, ) - + start = default_timer() try: with trace.use_span(span, end_on_exit=True) as current_span: if current_span.is_recording(): @@ -434,6 +481,8 @@ async def __call__(self, scope, receive, send): attributes.update(additional_attributes) for key, value in attributes.items(): current_span.set_attribute(key, value) + active_requests_count_attrs = parse_active_request_count_attrs(attributes) + duration_attrs = parse_duration_attrs(attributes) if current_span.kind == trace.SpanKind.SERVER: custom_attributes = ( From 1cbf9ebd3f4a32248ccb7ce43dcfcf7dd874f2ad Mon Sep 17 00:00:00 2001 From: "anshul.asawa" Date: Tue, 19 Jul 2022 16:30:14 +0530 Subject: [PATCH 02/12] add metric instrumentation in asgi --- .../instrumentation/asgi/__init__.py | 20 ++++++--- .../tests/test_asgi_middleware.py | 44 +++++++++++++++++++ 2 files changed, 57 insertions(+), 7 deletions(-) diff --git a/instrumentation/opentelemetry-instrumentation-asgi/src/opentelemetry/instrumentation/asgi/__init__.py b/instrumentation/opentelemetry-instrumentation-asgi/src/opentelemetry/instrumentation/asgi/__init__.py index f788fc2950..ffa4e632ec 100644 --- a/instrumentation/opentelemetry-instrumentation-asgi/src/opentelemetry/instrumentation/asgi/__init__.py +++ b/instrumentation/opentelemetry-instrumentation-asgi/src/opentelemetry/instrumentation/asgi/__init__.py @@ -381,14 +381,14 @@ def get_default_span_details(scope: dict) -> Tuple[str, dict]: return span_name, {} -def parse_active_request_count_attrs(req_attrs): +def _parse_active_request_count_attrs(req_attrs): active_requests_count_attrs = {} for attr_key in _active_requests_count_attrs: if req_attrs.get(attr_key) is not None: active_requests_count_attrs[attr_key] = req_attrs[attr_key] return active_requests_count_attrs -def parse_duration_attrs(req_attrs): +def _parse_duration_attrs(req_attrs): duration_attrs = {} for attr_key in _duration_attrs: if req_attrs.get(attr_key) is not None: @@ -473,16 +473,17 @@ async def __call__(self, scope, receive, send): context_carrier=scope, context_getter=asgi_getter, ) + attributes = collect_request_attributes(scope) + attributes.update(additional_attributes) + active_requests_count_attrs = _parse_active_request_count_attrs(attributes) + duration_attrs = _parse_duration_attrs(attributes) start = default_timer() + self.active_requests_counter.add(1, active_requests_count_attrs) try: with trace.use_span(span, end_on_exit=True) as current_span: if current_span.is_recording(): - attributes = collect_request_attributes(scope) - attributes.update(additional_attributes) for key, value in attributes.items(): current_span.set_attribute(key, value) - active_requests_count_attrs = parse_active_request_count_attrs(attributes) - duration_attrs = parse_duration_attrs(attributes) if current_span.kind == trace.SpanKind.SERVER: custom_attributes = ( @@ -503,10 +504,14 @@ async def __call__(self, scope, receive, send): span_name, scope, send, + duration_attrs, ) await self.app(scope, otel_receive, otel_send) finally: + duration = max(round((default_timer() - start) * 1000), 0) + self.duration_histogram.record(duration, duration_attrs) + self.active_requests_counter.add(-1, active_requests_count_attrs) if token: context.detach(token) @@ -527,7 +532,7 @@ async def otel_receive(): return otel_receive - def _get_otel_send(self, server_span, server_span_name, scope, send): + def _get_otel_send(self, server_span, server_span_name, scope, send, duration_attrs): @wraps(send) async def otel_send(message): with self.tracer.start_as_current_span( @@ -538,6 +543,7 @@ async def otel_send(message): if send_span.is_recording(): if message["type"] == "http.response.start": status_code = message["status"] + duration_attrs[SpanAttributes.HTTP_STATUS_CODE] = status_code set_status_code(server_span, status_code) set_status_code(send_span, status_code) elif message["type"] == "websocket.send": diff --git a/instrumentation/opentelemetry-instrumentation-asgi/tests/test_asgi_middleware.py b/instrumentation/opentelemetry-instrumentation-asgi/tests/test_asgi_middleware.py index 3a1e8424a8..df6b413445 100644 --- a/instrumentation/opentelemetry-instrumentation-asgi/tests/test_asgi_middleware.py +++ b/instrumentation/opentelemetry-instrumentation-asgi/tests/test_asgi_middleware.py @@ -35,7 +35,19 @@ OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_REQUEST, OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_RESPONSE, ) +from opentelemetry.sdk.metrics.export import ( + HistogramDataPoint, + NumberDataPoint, +) +_expected_metric_names = [ + "http.server.active_requests", + "http.server.duration", +] +_recommended_attrs = { + "http.server.active_requests": otel_asgi._active_requests_count_attrs, + "http.server.duration": otel_asgi._duration_attrs, +} async def http_app(scope, receive, send): message = await receive() @@ -523,6 +535,38 @@ def update_expected_hook_results(expected): outputs, modifiers=[update_expected_hook_results] ) + def test_asgi_metrics(self): + app = otel_asgi.OpenTelemetryMiddleware(simple_asgi) + self.seed_app(app) + self.send_default_request() + self.seed_app(app) + self.send_default_request() + self.seed_app(app) + self.send_default_request() + metrics_list = self.memory_metrics_reader.get_metrics_data() + number_data_point_seen = False + histogram_data_point_seen = False + self.assertTrue(len(metrics_list.resource_metrics) != 0) + for resource_metric in metrics_list.resource_metrics: + self.assertTrue(len(resource_metric.scope_metrics) != 0) + for scope_metric in resource_metric.scope_metrics: + self.assertTrue(len(scope_metric.metrics) != 0) + for metric in scope_metric.metrics: + self.assertIn(metric.name, _expected_metric_names) + data_points = list(metric.data.data_points) + self.assertEqual(len(data_points), 1) + for point in data_points: + if isinstance(point, HistogramDataPoint): + self.assertEqual(point.count, 3) + histogram_data_point_seen = True + if isinstance(point, NumberDataPoint): + number_data_point_seen = True + for attr in point.attributes: + self.assertIn( + attr, _recommended_attrs[metric.name] + ) + self.assertTrue(number_data_point_seen and histogram_data_point_seen) + class TestAsgiAttributes(unittest.TestCase): def setUp(self): From 8a452c0eb297a618b90aa31f61174be1fbfc7cda Mon Sep 17 00:00:00 2001 From: "anshul.asawa" Date: Tue, 19 Jul 2022 16:38:45 +0530 Subject: [PATCH 03/12] add change log --- CHANGELOG.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 20cdb6cb5f..c1350b27fd 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,6 +13,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - `opentelemetry-instrumentation-redis` add support to instrument RedisCluster clients ([#1177](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1177)) - `opentelemetry-instrumentation-sqlalchemy` Added span for the connection phase ([#1133](https://github.com/open-telemetry/opentelemetry-python-contrib/issues/1133)) +- Add metric instrumentation in asgi + ([#1197](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1197)) ## [1.12.0rc2-0.32b0](https://github.com/open-telemetry/opentelemetry-python/releases/tag/v1.12.0rc2-0.32b0) - 2022-07-01 From 5bf7fb9e54473130b338fccbe912408aa9ff3b26 Mon Sep 17 00:00:00 2001 From: "anshul.asawa" Date: Tue, 19 Jul 2022 16:43:20 +0530 Subject: [PATCH 04/12] fix lint --- .../instrumentation/asgi/__init__.py | 19 ++++++++++++++----- .../tests/test_asgi_middleware.py | 9 +++++---- 2 files changed, 19 insertions(+), 9 deletions(-) diff --git a/instrumentation/opentelemetry-instrumentation-asgi/src/opentelemetry/instrumentation/asgi/__init__.py b/instrumentation/opentelemetry-instrumentation-asgi/src/opentelemetry/instrumentation/asgi/__init__.py index ffa4e632ec..28f5b642bd 100644 --- a/instrumentation/opentelemetry-instrumentation-asgi/src/opentelemetry/instrumentation/asgi/__init__.py +++ b/instrumentation/opentelemetry-instrumentation-asgi/src/opentelemetry/instrumentation/asgi/__init__.py @@ -149,13 +149,12 @@ def client_response_hook(span: Span, message: dict): import typing import urllib from functools import wraps -from typing import Tuple from timeit import default_timer +from typing import Tuple from asgiref.compatibility import guarantee_single_callable from opentelemetry import context, trace -from opentelemetry.metrics import get_meter from opentelemetry.instrumentation.asgi.version import __version__ # noqa from opentelemetry.instrumentation.propagators import ( get_global_response_propagator, @@ -164,6 +163,7 @@ def client_response_hook(span: Span, message: dict): _start_internal_or_server_span, http_status_to_status_code, ) +from opentelemetry.metrics import get_meter from opentelemetry.propagators.textmap import Getter, Setter from opentelemetry.semconv.trace import SpanAttributes from opentelemetry.trace import Span, set_span_in_context @@ -201,6 +201,7 @@ def client_response_hook(span: Span, message: dict): SpanAttributes.HTTP_SERVER_NAME, ] + class ASGIGetter(Getter[dict]): def get( self, carrier: dict, key: str @@ -381,6 +382,7 @@ def get_default_span_details(scope: dict) -> Tuple[str, dict]: return span_name, {} + def _parse_active_request_count_attrs(req_attrs): active_requests_count_attrs = {} for attr_key in _active_requests_count_attrs: @@ -388,6 +390,7 @@ def _parse_active_request_count_attrs(req_attrs): active_requests_count_attrs[attr_key] = req_attrs[attr_key] return active_requests_count_attrs + def _parse_duration_attrs(req_attrs): duration_attrs = {} for attr_key in _duration_attrs: @@ -475,7 +478,9 @@ async def __call__(self, scope, receive, send): ) attributes = collect_request_attributes(scope) attributes.update(additional_attributes) - active_requests_count_attrs = _parse_active_request_count_attrs(attributes) + active_requests_count_attrs = _parse_active_request_count_attrs( + attributes + ) duration_attrs = _parse_duration_attrs(attributes) start = default_timer() self.active_requests_counter.add(1, active_requests_count_attrs) @@ -532,7 +537,9 @@ async def otel_receive(): return otel_receive - def _get_otel_send(self, server_span, server_span_name, scope, send, duration_attrs): + def _get_otel_send( + self, server_span, server_span_name, scope, send, duration_attrs + ): @wraps(send) async def otel_send(message): with self.tracer.start_as_current_span( @@ -543,7 +550,9 @@ async def otel_send(message): if send_span.is_recording(): if message["type"] == "http.response.start": status_code = message["status"] - duration_attrs[SpanAttributes.HTTP_STATUS_CODE] = status_code + duration_attrs[ + SpanAttributes.HTTP_STATUS_CODE + ] = status_code set_status_code(server_span, status_code) set_status_code(send_span, status_code) elif message["type"] == "websocket.send": diff --git a/instrumentation/opentelemetry-instrumentation-asgi/tests/test_asgi_middleware.py b/instrumentation/opentelemetry-instrumentation-asgi/tests/test_asgi_middleware.py index df6b413445..2c82ba545c 100644 --- a/instrumentation/opentelemetry-instrumentation-asgi/tests/test_asgi_middleware.py +++ b/instrumentation/opentelemetry-instrumentation-asgi/tests/test_asgi_middleware.py @@ -24,6 +24,10 @@ set_global_response_propagator, ) from opentelemetry.sdk import resources +from opentelemetry.sdk.metrics.export import ( + HistogramDataPoint, + NumberDataPoint, +) from opentelemetry.semconv.trace import SpanAttributes from opentelemetry.test.asgitestutil import ( AsgiTestBase, @@ -35,10 +39,6 @@ OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_REQUEST, OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_RESPONSE, ) -from opentelemetry.sdk.metrics.export import ( - HistogramDataPoint, - NumberDataPoint, -) _expected_metric_names = [ "http.server.active_requests", @@ -49,6 +49,7 @@ "http.server.duration": otel_asgi._duration_attrs, } + async def http_app(scope, receive, send): message = await receive() assert scope["type"] == "http" From d2df8b179835e2153d444048056d15d49ef4bba5 Mon Sep 17 00:00:00 2001 From: "anshul.asawa" Date: Wed, 27 Jul 2022 12:58:10 +0530 Subject: [PATCH 05/12] change time duration start time position for metric --- .../src/opentelemetry/instrumentation/asgi/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/instrumentation/opentelemetry-instrumentation-asgi/src/opentelemetry/instrumentation/asgi/__init__.py b/instrumentation/opentelemetry-instrumentation-asgi/src/opentelemetry/instrumentation/asgi/__init__.py index 28f5b642bd..3e41f739f1 100644 --- a/instrumentation/opentelemetry-instrumentation-asgi/src/opentelemetry/instrumentation/asgi/__init__.py +++ b/instrumentation/opentelemetry-instrumentation-asgi/src/opentelemetry/instrumentation/asgi/__init__.py @@ -482,7 +482,6 @@ async def __call__(self, scope, receive, send): attributes ) duration_attrs = _parse_duration_attrs(attributes) - start = default_timer() self.active_requests_counter.add(1, active_requests_count_attrs) try: with trace.use_span(span, end_on_exit=True) as current_span: @@ -511,6 +510,7 @@ async def __call__(self, scope, receive, send): send, duration_attrs, ) + start = default_timer() await self.app(scope, otel_receive, otel_send) finally: From f4b89621738c09c3d57e4ec9f6c405c34837bb51 Mon Sep 17 00:00:00 2001 From: "anshul.asawa" Date: Thu, 28 Jul 2022 14:06:20 +0530 Subject: [PATCH 06/12] add basic success test --- .../tests/test_asgi_middleware.py | 36 +++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/instrumentation/opentelemetry-instrumentation-asgi/tests/test_asgi_middleware.py b/instrumentation/opentelemetry-instrumentation-asgi/tests/test_asgi_middleware.py index 2c82ba545c..4965394772 100644 --- a/instrumentation/opentelemetry-instrumentation-asgi/tests/test_asgi_middleware.py +++ b/instrumentation/opentelemetry-instrumentation-asgi/tests/test_asgi_middleware.py @@ -568,6 +568,42 @@ def test_asgi_metrics(self): ) self.assertTrue(number_data_point_seen and histogram_data_point_seen) + def test_basic_metric_success(self): + app = otel_asgi.OpenTelemetryMiddleware(simple_asgi) + self.seed_app(app) + self.send_default_request() + expected_duration_attributes = { + "http.method": "GET", + "http.host": "127.0.0.1", + "http.scheme": "http", + "http.flavor": "1.0", + "net.host.port": 80, + "http.status_code": 200, + } + expected_requests_count_attributes = { + "http.method": "GET", + "http.host": "127.0.0.1", + "http.scheme": "http", + "http.flavor": "1.0", + } + metrics_list = self.memory_metrics_reader.get_metrics_data() + for resource_metric in metrics_list.resource_metrics: + for scope_metrics in resource_metric.scope_metrics: + for metric in scope_metrics.metrics: + for point in list(metric.data.data_points): + if isinstance(point, HistogramDataPoint): + self.assertDictEqual( + expected_duration_attributes, + dict(point.attributes), + ) + self.assertEqual(point.count, 1) + elif isinstance(point, NumberDataPoint): + self.assertDictEqual( + expected_requests_count_attributes, + dict(point.attributes), + ) + self.assertEqual(point.value, 0) + class TestAsgiAttributes(unittest.TestCase): def setUp(self): From 0874f2365431a6d44f27cb00137e5fd6b7fd8a68 Mon Sep 17 00:00:00 2001 From: "anshul.asawa" Date: Fri, 29 Jul 2022 14:52:46 +0530 Subject: [PATCH 07/12] remove metric instrumentation for websockets --- .../opentelemetry/instrumentation/asgi/__init__.py | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/instrumentation/opentelemetry-instrumentation-asgi/src/opentelemetry/instrumentation/asgi/__init__.py b/instrumentation/opentelemetry-instrumentation-asgi/src/opentelemetry/instrumentation/asgi/__init__.py index 3e41f739f1..b737dad2c8 100644 --- a/instrumentation/opentelemetry-instrumentation-asgi/src/opentelemetry/instrumentation/asgi/__init__.py +++ b/instrumentation/opentelemetry-instrumentation-asgi/src/opentelemetry/instrumentation/asgi/__init__.py @@ -482,7 +482,8 @@ async def __call__(self, scope, receive, send): attributes ) duration_attrs = _parse_duration_attrs(attributes) - self.active_requests_counter.add(1, active_requests_count_attrs) + if scope["type"] == "http": + self.active_requests_counter.add(1, active_requests_count_attrs) try: with trace.use_span(span, end_on_exit=True) as current_span: if current_span.is_recording(): @@ -514,9 +515,12 @@ async def __call__(self, scope, receive, send): await self.app(scope, otel_receive, otel_send) finally: - duration = max(round((default_timer() - start) * 1000), 0) - self.duration_histogram.record(duration, duration_attrs) - self.active_requests_counter.add(-1, active_requests_count_attrs) + if scope["type"] == "http": + duration = max(round((default_timer() - start) * 1000), 0) + self.duration_histogram.record(duration, duration_attrs) + self.active_requests_counter.add( + -1, active_requests_count_attrs + ) if token: context.detach(token) From 1aef36e13995549bb2ff6bcbd52bbc6c85b1952a Mon Sep 17 00:00:00 2001 From: "anshul.asawa" Date: Tue, 2 Aug 2022 13:28:50 +0530 Subject: [PATCH 08/12] add value test and websocket test for metric --- .../tests/test_asgi_middleware.py | 28 +++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/instrumentation/opentelemetry-instrumentation-asgi/tests/test_asgi_middleware.py b/instrumentation/opentelemetry-instrumentation-asgi/tests/test_asgi_middleware.py index 4965394772..0f9669ee57 100644 --- a/instrumentation/opentelemetry-instrumentation-asgi/tests/test_asgi_middleware.py +++ b/instrumentation/opentelemetry-instrumentation-asgi/tests/test_asgi_middleware.py @@ -14,6 +14,7 @@ import sys import unittest +from timeit import default_timer from unittest import mock import opentelemetry.instrumentation.asgi as otel_asgi @@ -571,7 +572,9 @@ def test_asgi_metrics(self): def test_basic_metric_success(self): app = otel_asgi.OpenTelemetryMiddleware(simple_asgi) self.seed_app(app) + start = default_timer() self.send_default_request() + duration = max(round((default_timer() - start) * 1000), 0) expected_duration_attributes = { "http.method": "GET", "http.host": "127.0.0.1", @@ -597,6 +600,9 @@ def test_basic_metric_success(self): dict(point.attributes), ) self.assertEqual(point.count, 1) + self.assertAlmostEqual( + duration, point.sum, delta=5 + ) elif isinstance(point, NumberDataPoint): self.assertDictEqual( expected_requests_count_attributes, @@ -604,6 +610,28 @@ def test_basic_metric_success(self): ) self.assertEqual(point.value, 0) + def test_no_metric_for_websockets(self): + self.scope = { + "type": "websocket", + "http_version": "1.1", + "scheme": "ws", + "path": "/", + "query_string": b"", + "headers": [], + "client": ("127.0.0.1", 32767), + "server": ("127.0.0.1", 80), + } + app = otel_asgi.OpenTelemetryMiddleware(simple_asgi) + self.seed_app(app) + self.send_input({"type": "websocket.connect"}) + self.send_input({"type": "websocket.receive", "text": "ping"}) + self.send_input({"type": "websocket.disconnect"}) + self.get_all_output() + metrics_list = self.memory_metrics_reader.get_metrics_data() + self.assertEqual( + len(metrics_list.resource_metrics[0].scope_metrics), 0 + ) + class TestAsgiAttributes(unittest.TestCase): def setUp(self): From 017319a5eaa9ee85d6e9cf8988905845ba6152a3 Mon Sep 17 00:00:00 2001 From: "anshul.asawa" Date: Fri, 5 Aug 2022 14:03:32 +0530 Subject: [PATCH 09/12] move attributes to utils --- .../instrumentation/asgi/__init__.py | 38 +------------------ .../src/opentelemetry/util/http/__init__.py | 35 +++++++++++++++++ 2 files changed, 37 insertions(+), 36 deletions(-) diff --git a/instrumentation/opentelemetry-instrumentation-asgi/src/opentelemetry/instrumentation/asgi/__init__.py b/instrumentation/opentelemetry-instrumentation-asgi/src/opentelemetry/instrumentation/asgi/__init__.py index b737dad2c8..e3bbf16754 100644 --- a/instrumentation/opentelemetry-instrumentation-asgi/src/opentelemetry/instrumentation/asgi/__init__.py +++ b/instrumentation/opentelemetry-instrumentation-asgi/src/opentelemetry/instrumentation/asgi/__init__.py @@ -171,6 +171,8 @@ def client_response_hook(span: Span, message: dict): from opentelemetry.util.http import ( OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_REQUEST, OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_RESPONSE, + _parse_active_request_count_attrs, + _parse_duration_attrs, get_custom_headers, normalise_request_header_name, normalise_response_header_name, @@ -181,26 +183,6 @@ def client_response_hook(span: Span, message: dict): _ClientRequestHookT = typing.Optional[typing.Callable[[Span, dict], None]] _ClientResponseHookT = typing.Optional[typing.Callable[[Span, dict], None]] -# List of recommended attributes -_duration_attrs = [ - SpanAttributes.HTTP_METHOD, - SpanAttributes.HTTP_HOST, - SpanAttributes.HTTP_SCHEME, - SpanAttributes.HTTP_STATUS_CODE, - SpanAttributes.HTTP_FLAVOR, - SpanAttributes.HTTP_SERVER_NAME, - SpanAttributes.NET_HOST_NAME, - SpanAttributes.NET_HOST_PORT, -] - -_active_requests_count_attrs = [ - SpanAttributes.HTTP_METHOD, - SpanAttributes.HTTP_HOST, - SpanAttributes.HTTP_SCHEME, - SpanAttributes.HTTP_FLAVOR, - SpanAttributes.HTTP_SERVER_NAME, -] - class ASGIGetter(Getter[dict]): def get( @@ -383,22 +365,6 @@ def get_default_span_details(scope: dict) -> Tuple[str, dict]: return span_name, {} -def _parse_active_request_count_attrs(req_attrs): - active_requests_count_attrs = {} - for attr_key in _active_requests_count_attrs: - if req_attrs.get(attr_key) is not None: - active_requests_count_attrs[attr_key] = req_attrs[attr_key] - return active_requests_count_attrs - - -def _parse_duration_attrs(req_attrs): - duration_attrs = {} - for attr_key in _duration_attrs: - if req_attrs.get(attr_key) is not None: - duration_attrs[attr_key] = req_attrs[attr_key] - return duration_attrs - - class OpenTelemetryMiddleware: """The ASGI application middleware. diff --git a/util/opentelemetry-util-http/src/opentelemetry/util/http/__init__.py b/util/opentelemetry-util-http/src/opentelemetry/util/http/__init__.py index aa34fb439a..cd84d46c1b 100644 --- a/util/opentelemetry-util-http/src/opentelemetry/util/http/__init__.py +++ b/util/opentelemetry-util-http/src/opentelemetry/util/http/__init__.py @@ -17,6 +17,7 @@ from re import search from typing import Iterable, List from urllib.parse import urlparse, urlunparse +from opentelemetry.semconv.trace import SpanAttributes OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_REQUEST = ( "OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_REQUEST" @@ -25,6 +26,25 @@ "OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_RESPONSE" ) +# List of recommended metrics attributes +_duration_attrs = [ + SpanAttributes.HTTP_METHOD, + SpanAttributes.HTTP_HOST, + SpanAttributes.HTTP_SCHEME, + SpanAttributes.HTTP_STATUS_CODE, + SpanAttributes.HTTP_FLAVOR, + SpanAttributes.HTTP_SERVER_NAME, + SpanAttributes.NET_HOST_NAME, + SpanAttributes.NET_HOST_PORT, +] + +_active_requests_count_attrs = [ + SpanAttributes.HTTP_METHOD, + SpanAttributes.HTTP_HOST, + SpanAttributes.HTTP_SCHEME, + SpanAttributes.HTTP_FLAVOR, + SpanAttributes.HTTP_SERVER_NAME, +] class ExcludeList: """Class to exclude certain paths (given as a list of regexes) from tracing requests""" @@ -125,3 +145,18 @@ def get_custom_headers(env_var: str) -> List[str]: for custom_headers in custom_headers.split(",") ] return custom_headers + +def _parse_active_request_count_attrs(req_attrs): + active_requests_count_attrs = {} + for attr_key in _active_requests_count_attrs: + if req_attrs.get(attr_key) is not None: + active_requests_count_attrs[attr_key] = req_attrs[attr_key] + return active_requests_count_attrs + + +def _parse_duration_attrs(req_attrs): + duration_attrs = {} + for attr_key in _duration_attrs: + if req_attrs.get(attr_key) is not None: + duration_attrs[attr_key] = req_attrs[attr_key] + return duration_attrs From e04ed38027938853cf9ad00d52b5437c4df61a03 Mon Sep 17 00:00:00 2001 From: "anshul.asawa" Date: Mon, 8 Aug 2022 13:13:29 +0530 Subject: [PATCH 10/12] fix error --- .../tests/test_asgi_middleware.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/instrumentation/opentelemetry-instrumentation-asgi/tests/test_asgi_middleware.py b/instrumentation/opentelemetry-instrumentation-asgi/tests/test_asgi_middleware.py index 0f9669ee57..e6b75d7125 100644 --- a/instrumentation/opentelemetry-instrumentation-asgi/tests/test_asgi_middleware.py +++ b/instrumentation/opentelemetry-instrumentation-asgi/tests/test_asgi_middleware.py @@ -39,6 +39,8 @@ from opentelemetry.util.http import ( OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_REQUEST, OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_RESPONSE, + _active_requests_count_attrs, + _duration_attrs, ) _expected_metric_names = [ @@ -46,8 +48,8 @@ "http.server.duration", ] _recommended_attrs = { - "http.server.active_requests": otel_asgi._active_requests_count_attrs, - "http.server.duration": otel_asgi._duration_attrs, + "http.server.active_requests": _active_requests_count_attrs, + "http.server.duration": _duration_attrs, } From 45c8fb569de5736323ed2ba32709a6a7e2cad87f Mon Sep 17 00:00:00 2001 From: "anshul.asawa" Date: Mon, 8 Aug 2022 13:28:56 +0530 Subject: [PATCH 11/12] fix lint --- .../src/opentelemetry/util/http/__init__.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/util/opentelemetry-util-http/src/opentelemetry/util/http/__init__.py b/util/opentelemetry-util-http/src/opentelemetry/util/http/__init__.py index cd84d46c1b..23552f1681 100644 --- a/util/opentelemetry-util-http/src/opentelemetry/util/http/__init__.py +++ b/util/opentelemetry-util-http/src/opentelemetry/util/http/__init__.py @@ -46,6 +46,7 @@ SpanAttributes.HTTP_SERVER_NAME, ] + class ExcludeList: """Class to exclude certain paths (given as a list of regexes) from tracing requests""" @@ -146,6 +147,7 @@ def get_custom_headers(env_var: str) -> List[str]: ] return custom_headers + def _parse_active_request_count_attrs(req_attrs): active_requests_count_attrs = {} for attr_key in _active_requests_count_attrs: From 25a888f2c26b6975fe628ff6475885a09af9b072 Mon Sep 17 00:00:00 2001 From: "anshul.asawa" Date: Mon, 8 Aug 2022 13:50:06 +0530 Subject: [PATCH 12/12] fix lint --- .../src/opentelemetry/util/http/__init__.py | 1 + 1 file changed, 1 insertion(+) diff --git a/util/opentelemetry-util-http/src/opentelemetry/util/http/__init__.py b/util/opentelemetry-util-http/src/opentelemetry/util/http/__init__.py index 23552f1681..60eafdcd5b 100644 --- a/util/opentelemetry-util-http/src/opentelemetry/util/http/__init__.py +++ b/util/opentelemetry-util-http/src/opentelemetry/util/http/__init__.py @@ -17,6 +17,7 @@ from re import search from typing import Iterable, List from urllib.parse import urlparse, urlunparse + from opentelemetry.semconv.trace import SpanAttributes OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_REQUEST = (