opensource/opentelemetry-python-contrib
1
0
Fork 0
mirror of https://github.com/open-telemetry/opentelemetry-python-contrib.git synced 2025-07-28 20:52:57 +08:00
Code Issues Packages Projects Releases Wiki Activity

Use generated symbols from semantic conventions package (#2611)

Browse Source
This commit is contained in:
Leighton Chen
2024-06-17 09:20:17 -07:00
committed by GitHub
parent daa84a6c63
commit b94c5906fd
8 changed files with 172 additions and 161 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGELOG.md
View File

@ -25,6 +25,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
([#2572](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2572)) ([#2572](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2572))
- `opentelemetry-instrumentation-aiohttp-server`, `opentelemetry-instrumentation-httpx` Ensure consistently use of suppress_instrumentation utils - `opentelemetry-instrumentation-aiohttp-server`, `opentelemetry-instrumentation-httpx` Ensure consistently use of suppress_instrumentation utils
([#2590](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2590)) ([#2590](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2590))
- Reference symbols from generated semantic conventions
([#2611](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2611))
## Version 1.25.0/0.46b0 (2024-05-31) ## Version 1.25.0/0.46b0 (2024-05-31)

8
instrumentation/opentelemetry-instrumentation-flask/src/opentelemetry/instrumentation/flask/__init__.py
View File

@ -251,7 +251,6 @@ from packaging import version as package_version
import opentelemetry.instrumentation.wsgi as otel_wsgi import opentelemetry.instrumentation.wsgi as otel_wsgi
from opentelemetry import context, trace from opentelemetry import context, trace
from opentelemetry.instrumentation._semconv import ( from opentelemetry.instrumentation._semconv import (
_METRIC_ATTRIBUTES_SERVER_DURATION_NAME,
_get_schema_url, _get_schema_url,
_HTTPStabilityMode, _HTTPStabilityMode,
_OpenTelemetrySemanticConventionStability, _OpenTelemetrySemanticConventionStability,
@ -268,6 +267,9 @@ from opentelemetry.instrumentation.propagators import (
from opentelemetry.instrumentation.utils import _start_internal_or_server_span from opentelemetry.instrumentation.utils import _start_internal_or_server_span
from opentelemetry.metrics import get_meter from opentelemetry.metrics import get_meter
from opentelemetry.semconv.metrics import MetricInstruments from opentelemetry.semconv.metrics import MetricInstruments
from opentelemetry.semconv.metrics.http_metrics import (
HTTP_SERVER_REQUEST_DURATION,
)
from opentelemetry.semconv.trace import SpanAttributes from opentelemetry.semconv.trace import SpanAttributes
from opentelemetry.util.http import ( from opentelemetry.util.http import (
get_excluded_urls, get_excluded_urls,
@ -553,7 +555,7 @@ class _InstrumentedFlask(flask.Flask):
duration_histogram_new = None duration_histogram_new = None
if _report_new(_InstrumentedFlask._sem_conv_opt_in_mode): if _report_new(_InstrumentedFlask._sem_conv_opt_in_mode):
duration_histogram_new = meter.create_histogram( duration_histogram_new = meter.create_histogram(
name=_METRIC_ATTRIBUTES_SERVER_DURATION_NAME, name=HTTP_SERVER_REQUEST_DURATION,
unit="s", unit="s",
description="measures the duration of the inbound HTTP request", description="measures the duration of the inbound HTTP request",
) )
@ -684,7 +686,7 @@ class FlaskInstrumentor(BaseInstrumentor):
duration_histogram_new = None duration_histogram_new = None
if _report_new(sem_conv_opt_in_mode): if _report_new(sem_conv_opt_in_mode):
duration_histogram_new = meter.create_histogram( duration_histogram_new = meter.create_histogram(
name=_METRIC_ATTRIBUTES_SERVER_DURATION_NAME, name=HTTP_SERVER_REQUEST_DURATION,
unit="s", unit="s",
description="measures the duration of the inbound HTTP request", description="measures the duration of the inbound HTTP request",
) )

6
instrumentation/opentelemetry-instrumentation-flask/tests/test_programmatic.py
View File

@ -20,7 +20,6 @@ from flask import Flask, request
from opentelemetry import trace from opentelemetry import trace
from opentelemetry.instrumentation._semconv import ( from opentelemetry.instrumentation._semconv import (
_SPAN_ATTRIBUTES_ERROR_TYPE,
OTEL_SEMCONV_STABILITY_OPT_IN, OTEL_SEMCONV_STABILITY_OPT_IN,
_OpenTelemetrySemanticConventionStability, _OpenTelemetrySemanticConventionStability,
_server_active_requests_count_attrs_new, _server_active_requests_count_attrs_new,
@ -40,6 +39,7 @@ from opentelemetry.sdk.metrics.export import (
NumberDataPoint, NumberDataPoint,
) )
from opentelemetry.sdk.resources import Resource from opentelemetry.sdk.resources import Resource
from opentelemetry.semconv.attributes.error_attributes import ERROR_TYPE
from opentelemetry.semconv.trace import SpanAttributes from opentelemetry.semconv.trace import SpanAttributes
from opentelemetry.test.wsgitestutil import WsgiTestBase from opentelemetry.test.wsgitestutil import WsgiTestBase
from opentelemetry.util.http import ( from opentelemetry.util.http import (
@ -379,7 +379,7 @@ class TestProgrammatic(InstrumentationTest, WsgiTestBase):
SpanAttributes.URL_PATH: "/hello/500", SpanAttributes.URL_PATH: "/hello/500",
SpanAttributes.HTTP_ROUTE: "/hello/<int:helloid>", SpanAttributes.HTTP_ROUTE: "/hello/<int:helloid>",
SpanAttributes.HTTP_RESPONSE_STATUS_CODE: 500, SpanAttributes.HTTP_RESPONSE_STATUS_CODE: 500,
_SPAN_ATTRIBUTES_ERROR_TYPE: "500", ERROR_TYPE: "500",
SpanAttributes.URL_SCHEME: "http", SpanAttributes.URL_SCHEME: "http",
} }
) )
@ -405,7 +405,7 @@ class TestProgrammatic(InstrumentationTest, WsgiTestBase):
{ {
SpanAttributes.URL_PATH: "/hello/500", SpanAttributes.URL_PATH: "/hello/500",
SpanAttributes.HTTP_RESPONSE_STATUS_CODE: 500, SpanAttributes.HTTP_RESPONSE_STATUS_CODE: 500,
_SPAN_ATTRIBUTES_ERROR_TYPE: "500", ERROR_TYPE: "500",
SpanAttributes.URL_SCHEME: "http", SpanAttributes.URL_SCHEME: "http",
} }
) )

38
instrumentation/opentelemetry-instrumentation-requests/src/opentelemetry/instrumentation/requests/__init__.py
View File

@ -59,10 +59,6 @@ from requests.sessions import Session
from requests.structures import CaseInsensitiveDict from requests.structures import CaseInsensitiveDict
from opentelemetry.instrumentation._semconv import ( from opentelemetry.instrumentation._semconv import (
_METRIC_ATTRIBUTES_CLIENT_DURATION_NAME,
_SPAN_ATTRIBUTES_ERROR_TYPE,
_SPAN_ATTRIBUTES_NETWORK_PEER_ADDRESS,
_SPAN_ATTRIBUTES_NETWORK_PEER_PORT,
_client_duration_attrs_new, _client_duration_attrs_new,
_client_duration_attrs_old, _client_duration_attrs_old,
_filter_semconv_duration_attrs, _filter_semconv_duration_attrs,
@ -91,7 +87,15 @@ from opentelemetry.instrumentation.utils import (
) )
from opentelemetry.metrics import Histogram, get_meter from opentelemetry.metrics import Histogram, get_meter
from opentelemetry.propagate import inject from opentelemetry.propagate import inject
from opentelemetry.semconv.attributes.error_attributes import ERROR_TYPE
from opentelemetry.semconv.attributes.network_attributes import (
NETWORK_PEER_ADDRESS,
NETWORK_PEER_PORT,
)
from opentelemetry.semconv.metrics import MetricInstruments from opentelemetry.semconv.metrics import MetricInstruments
from opentelemetry.semconv.metrics.http_metrics import (
HTTP_CLIENT_REQUEST_DURATION,
)
from opentelemetry.trace import SpanKind, Tracer, get_tracer from opentelemetry.trace import SpanKind, Tracer, get_tracer
from opentelemetry.trace.span import Span from opentelemetry.trace.span import Span
from opentelemetry.trace.status import StatusCode from opentelemetry.trace.status import StatusCode
@ -191,9 +195,7 @@ def _instrument(
sem_conv_opt_in_mode, sem_conv_opt_in_mode,
) )
# Use semconv library when available # Use semconv library when available
span_attributes[_SPAN_ATTRIBUTES_NETWORK_PEER_ADDRESS] = ( span_attributes[NETWORK_PEER_ADDRESS] = parsed_url.hostname
parsed_url.hostname
)
if parsed_url.port: if parsed_url.port:
_set_http_peer_port_client( _set_http_peer_port_client(
metric_labels, parsed_url.port, sem_conv_opt_in_mode metric_labels, parsed_url.port, sem_conv_opt_in_mode
@ -203,9 +205,7 @@ def _instrument(
span_attributes, parsed_url.port, sem_conv_opt_in_mode span_attributes, parsed_url.port, sem_conv_opt_in_mode
) )
# Use semconv library when available # Use semconv library when available
span_attributes[_SPAN_ATTRIBUTES_NETWORK_PEER_PORT] = ( span_attributes[NETWORK_PEER_PORT] = parsed_url.port
parsed_url.port
)
except ValueError: except ValueError:
pass pass
@ -250,12 +250,8 @@ def _instrument(
_report_new(sem_conv_opt_in_mode) _report_new(sem_conv_opt_in_mode)
and status_code is StatusCode.ERROR and status_code is StatusCode.ERROR
): ):
span_attributes[_SPAN_ATTRIBUTES_ERROR_TYPE] = str( span_attributes[ERROR_TYPE] = str(result.status_code)
result.status_code metric_labels[ERROR_TYPE] = str(result.status_code)
)
metric_labels[_SPAN_ATTRIBUTES_ERROR_TYPE] = str(
result.status_code
)
if result.raw is not None: if result.raw is not None:
version = getattr(result.raw, "version", None) version = getattr(result.raw, "version", None)
@ -278,12 +274,8 @@ def _instrument(
response_hook(span, request, result) response_hook(span, request, result)
if exception is not None and _report_new(sem_conv_opt_in_mode): if exception is not None and _report_new(sem_conv_opt_in_mode):
span.set_attribute( span.set_attribute(ERROR_TYPE, type(exception).__qualname__)
_SPAN_ATTRIBUTES_ERROR_TYPE, type(exception).__qualname__ metric_labels[ERROR_TYPE] = type(exception).__qualname__
)
metric_labels[_SPAN_ATTRIBUTES_ERROR_TYPE] = type(
exception
).__qualname__
if duration_histogram_old is not None: if duration_histogram_old is not None:
duration_attrs_old = _filter_semconv_duration_attrs( duration_attrs_old = _filter_semconv_duration_attrs(
@ -403,7 +395,7 @@ class RequestsInstrumentor(BaseInstrumentor):
duration_histogram_new = None duration_histogram_new = None
if _report_new(semconv_opt_in_mode): if _report_new(semconv_opt_in_mode):
duration_histogram_new = meter.create_histogram( duration_histogram_new = meter.create_histogram(
name=_METRIC_ATTRIBUTES_CLIENT_DURATION_NAME, name=HTTP_CLIENT_REQUEST_DURATION,
unit="s", unit="s",
description="Duration of HTTP client requests.", description="Duration of HTTP client requests.",
) )

100
instrumentation/opentelemetry-instrumentation-requests/tests/test_requests_integration.py
View File

@ -23,9 +23,6 @@ from requests.models import Response
import opentelemetry.instrumentation.requests import opentelemetry.instrumentation.requests
from opentelemetry import trace from opentelemetry import trace
from opentelemetry.instrumentation._semconv import ( from opentelemetry.instrumentation._semconv import (
_SPAN_ATTRIBUTES_ERROR_TYPE,
_SPAN_ATTRIBUTES_NETWORK_PEER_ADDRESS,
_SPAN_ATTRIBUTES_NETWORK_PEER_PORT,
OTEL_SEMCONV_STABILITY_OPT_IN, OTEL_SEMCONV_STABILITY_OPT_IN,
_OpenTelemetrySemanticConventionStability, _OpenTelemetrySemanticConventionStability,
) )
@ -36,6 +33,21 @@ from opentelemetry.instrumentation.utils import (
) )
from opentelemetry.propagate import get_global_textmap, set_global_textmap from opentelemetry.propagate import get_global_textmap, set_global_textmap
from opentelemetry.sdk import resources from opentelemetry.sdk import resources
from opentelemetry.semconv.attributes.error_attributes import ERROR_TYPE
from opentelemetry.semconv.attributes.http_attributes import (
HTTP_REQUEST_METHOD,
HTTP_RESPONSE_STATUS_CODE,
)
from opentelemetry.semconv.attributes.network_attributes import (
NETWORK_PEER_ADDRESS,
NETWORK_PEER_PORT,
NETWORK_PROTOCOL_VERSION,
)
from opentelemetry.semconv.attributes.server_attributes import (
SERVER_ADDRESS,
SERVER_PORT,
)
from opentelemetry.semconv.attributes.url_attributes import URL_FULL
from opentelemetry.semconv.trace import SpanAttributes from opentelemetry.semconv.trace import SpanAttributes
from opentelemetry.test.mock_textmap import MockTextMapPropagator from opentelemetry.test.mock_textmap import MockTextMapPropagator
from opentelemetry.test.test_base import TestBase from opentelemetry.test.test_base import TestBase
@ -176,14 +188,14 @@ class RequestsIntegrationTestBase(abc.ABC):
self.assertEqual( self.assertEqual(
span.attributes, span.attributes,
{ {
SpanAttributes.HTTP_REQUEST_METHOD: "GET", HTTP_REQUEST_METHOD: "GET",
SpanAttributes.URL_FULL: url_with_port, URL_FULL: url_with_port,
SpanAttributes.SERVER_ADDRESS: "mock", SERVER_ADDRESS: "mock",
_SPAN_ATTRIBUTES_NETWORK_PEER_ADDRESS: "mock", NETWORK_PEER_ADDRESS: "mock",
SpanAttributes.HTTP_RESPONSE_STATUS_CODE: 200, HTTP_RESPONSE_STATUS_CODE: 200,
SpanAttributes.NETWORK_PROTOCOL_VERSION: "1.1", NETWORK_PROTOCOL_VERSION: "1.1",
SpanAttributes.SERVER_PORT: 80, SERVER_PORT: 80,
_SPAN_ATTRIBUTES_NETWORK_PEER_PORT: 80, NETWORK_PEER_PORT: 80,
}, },
) )
@ -213,19 +225,19 @@ class RequestsIntegrationTestBase(abc.ABC):
span.attributes, span.attributes,
{ {
SpanAttributes.HTTP_METHOD: "GET", SpanAttributes.HTTP_METHOD: "GET",
SpanAttributes.HTTP_REQUEST_METHOD: "GET", HTTP_REQUEST_METHOD: "GET",
SpanAttributes.HTTP_URL: url_with_port, SpanAttributes.HTTP_URL: url_with_port,
SpanAttributes.URL_FULL: url_with_port, URL_FULL: url_with_port,
SpanAttributes.HTTP_HOST: "mock", SpanAttributes.HTTP_HOST: "mock",
SpanAttributes.SERVER_ADDRESS: "mock", SERVER_ADDRESS: "mock",
_SPAN_ATTRIBUTES_NETWORK_PEER_ADDRESS: "mock", NETWORK_PEER_ADDRESS: "mock",
SpanAttributes.NET_PEER_PORT: 80, SpanAttributes.NET_PEER_PORT: 80,
SpanAttributes.HTTP_STATUS_CODE: 200, SpanAttributes.HTTP_STATUS_CODE: 200,
SpanAttributes.HTTP_RESPONSE_STATUS_CODE: 200, HTTP_RESPONSE_STATUS_CODE: 200,
SpanAttributes.HTTP_FLAVOR: "1.1", SpanAttributes.HTTP_FLAVOR: "1.1",
SpanAttributes.NETWORK_PROTOCOL_VERSION: "1.1", NETWORK_PROTOCOL_VERSION: "1.1",
SpanAttributes.SERVER_PORT: 80, SERVER_PORT: 80,
_SPAN_ATTRIBUTES_NETWORK_PEER_PORT: 80, NETWORK_PEER_PORT: 80,
}, },
) )
@ -328,12 +340,8 @@ class RequestsIntegrationTestBase(abc.ABC):
span = self.assert_span() span = self.assert_span()
self.assertEqual( self.assertEqual(span.attributes.get(HTTP_RESPONSE_STATUS_CODE), 404)
span.attributes.get(SpanAttributes.HTTP_RESPONSE_STATUS_CODE), 404 self.assertEqual(span.attributes.get(ERROR_TYPE), "404")
)
self.assertEqual(
span.attributes.get(_SPAN_ATTRIBUTES_ERROR_TYPE), "404"
)
self.assertIs( self.assertIs(
span.status.status_code, span.status.status_code,
@ -355,12 +363,8 @@ class RequestsIntegrationTestBase(abc.ABC):
self.assertEqual( self.assertEqual(
span.attributes.get(SpanAttributes.HTTP_STATUS_CODE), 404 span.attributes.get(SpanAttributes.HTTP_STATUS_CODE), 404
) )
self.assertEqual( self.assertEqual(span.attributes.get(HTTP_RESPONSE_STATUS_CODE), 404)
span.attributes.get(SpanAttributes.HTTP_RESPONSE_STATUS_CODE), 404 self.assertEqual(span.attributes.get(ERROR_TYPE), "404")
)
self.assertEqual(
span.attributes.get(_SPAN_ATTRIBUTES_ERROR_TYPE), "404"
)
self.assertIs( self.assertIs(
span.status.status_code, span.status.status_code,
@ -527,13 +531,13 @@ class RequestsIntegrationTestBase(abc.ABC):
self.assertEqual( self.assertEqual(
span.attributes, span.attributes,
{ {
SpanAttributes.HTTP_REQUEST_METHOD: "GET", HTTP_REQUEST_METHOD: "GET",
SpanAttributes.URL_FULL: url_with_port, URL_FULL: url_with_port,
SpanAttributes.SERVER_ADDRESS: "mock", SERVER_ADDRESS: "mock",
SpanAttributes.SERVER_PORT: 80, SERVER_PORT: 80,
_SPAN_ATTRIBUTES_NETWORK_PEER_PORT: 80, NETWORK_PEER_PORT: 80,
_SPAN_ATTRIBUTES_NETWORK_PEER_ADDRESS: "mock", NETWORK_PEER_ADDRESS: "mock",
_SPAN_ATTRIBUTES_ERROR_TYPE: "RequestException", ERROR_TYPE: "RequestException",
}, },
) )
self.assertEqual(span.status.status_code, StatusCode.ERROR) self.assertEqual(span.status.status_code, StatusCode.ERROR)
@ -724,11 +728,11 @@ class TestRequestsIntergrationMetric(TestBase):
self.perform_request(self.URL) self.perform_request(self.URL)
expected_attributes = { expected_attributes = {
SpanAttributes.HTTP_RESPONSE_STATUS_CODE: 200, HTTP_RESPONSE_STATUS_CODE: 200,
SpanAttributes.SERVER_ADDRESS: "examplehost", SERVER_ADDRESS: "examplehost",
SpanAttributes.SERVER_PORT: 8000, SERVER_PORT: 8000,
SpanAttributes.HTTP_REQUEST_METHOD: "GET", HTTP_REQUEST_METHOD: "GET",
SpanAttributes.NETWORK_PROTOCOL_VERSION: "1.1", NETWORK_PROTOCOL_VERSION: "1.1",
} }
for ( for (
resource_metrics resource_metrics
@ -760,11 +764,11 @@ class TestRequestsIntergrationMetric(TestBase):
} }
expected_attributes_new = { expected_attributes_new = {
SpanAttributes.HTTP_RESPONSE_STATUS_CODE: 200, HTTP_RESPONSE_STATUS_CODE: 200,
SpanAttributes.SERVER_ADDRESS: "examplehost", SERVER_ADDRESS: "examplehost",
SpanAttributes.SERVER_PORT: 8000, SERVER_PORT: 8000,
SpanAttributes.HTTP_REQUEST_METHOD: "GET", HTTP_REQUEST_METHOD: "GET",
SpanAttributes.NETWORK_PROTOCOL_VERSION: "1.1", NETWORK_PROTOCOL_VERSION: "1.1",
} }
for ( for (

14
instrumentation/opentelemetry-instrumentation-wsgi/src/opentelemetry/instrumentation/wsgi/__init__.py
View File

@ -214,8 +214,6 @@ from timeit import default_timer
from opentelemetry import context, trace from opentelemetry import context, trace
from opentelemetry.instrumentation._semconv import ( from opentelemetry.instrumentation._semconv import (
_METRIC_ATTRIBUTES_SERVER_DURATION_NAME,
_SPAN_ATTRIBUTES_ERROR_TYPE,
_filter_semconv_active_request_count_attr, _filter_semconv_active_request_count_attr,
_filter_semconv_duration_attrs, _filter_semconv_duration_attrs,
_get_schema_url, _get_schema_url,
@ -244,7 +242,11 @@ from opentelemetry.instrumentation.utils import _start_internal_or_server_span
from opentelemetry.instrumentation.wsgi.version import __version__ from opentelemetry.instrumentation.wsgi.version import __version__
from opentelemetry.metrics import get_meter from opentelemetry.metrics import get_meter
from opentelemetry.propagators.textmap import Getter from opentelemetry.propagators.textmap import Getter
from opentelemetry.semconv.attributes.error_attributes import ERROR_TYPE
from opentelemetry.semconv.metrics import MetricInstruments from opentelemetry.semconv.metrics import MetricInstruments
from opentelemetry.semconv.metrics.http_metrics import (
HTTP_SERVER_REQUEST_DURATION,
)
from opentelemetry.semconv.trace import SpanAttributes from opentelemetry.semconv.trace import SpanAttributes
from opentelemetry.trace.status import Status, StatusCode from opentelemetry.trace.status import Status, StatusCode
from opentelemetry.util.http import ( from opentelemetry.util.http import (
@ -573,7 +575,7 @@ class OpenTelemetryMiddleware:
self.duration_histogram_new = None self.duration_histogram_new = None
if _report_new(sem_conv_opt_in_mode): if _report_new(sem_conv_opt_in_mode):
self.duration_histogram_new = self.meter.create_histogram( self.duration_histogram_new = self.meter.create_histogram(
name=_METRIC_ATTRIBUTES_SERVER_DURATION_NAME, name=HTTP_SERVER_REQUEST_DURATION,
unit="s", unit="s",
description="measures the duration of the inbound HTTP request", description="measures the duration of the inbound HTTP request",
) )
@ -670,11 +672,9 @@ class OpenTelemetryMiddleware:
return _end_span_after_iterating(iterable, span, token) return _end_span_after_iterating(iterable, span, token)
except Exception as ex: except Exception as ex:
if _report_new(self._sem_conv_opt_in_mode): if _report_new(self._sem_conv_opt_in_mode):
req_attrs[_SPAN_ATTRIBUTES_ERROR_TYPE] = type(ex).__qualname__ req_attrs[ERROR_TYPE] = type(ex).__qualname__
if span.is_recording(): if span.is_recording():
span.set_attribute( span.set_attribute(ERROR_TYPE, type(ex).__qualname__)
_SPAN_ATTRIBUTES_ERROR_TYPE, type(ex).__qualname__
)
span.set_status(Status(StatusCode.ERROR, str(ex))) span.set_status(Status(StatusCode.ERROR, str(ex)))
span.end() span.end()
if token is not None: if token is not None:

72
instrumentation/opentelemetry-instrumentation-wsgi/tests/test_wsgi_middleware.py
View File

@ -36,6 +36,23 @@ from opentelemetry.sdk.metrics.export import (
NumberDataPoint, NumberDataPoint,
) )
from opentelemetry.sdk.resources import Resource from opentelemetry.sdk.resources import Resource
from opentelemetry.semconv.attributes.http_attributes import (
HTTP_REQUEST_METHOD,
HTTP_RESPONSE_STATUS_CODE,
)
from opentelemetry.semconv.attributes.network_attributes import (
NETWORK_PROTOCOL_VERSION,
)
from opentelemetry.semconv.attributes.server_attributes import (
SERVER_ADDRESS,
SERVER_PORT,
)
from opentelemetry.semconv.attributes.url_attributes import (
URL_FULL,
URL_PATH,
URL_QUERY,
URL_SCHEME,
)
from opentelemetry.semconv.trace import SpanAttributes from opentelemetry.semconv.trace import SpanAttributes
from opentelemetry.test.test_base import TestBase from opentelemetry.test.test_base import TestBase
from opentelemetry.test.wsgitestutil import WsgiTestBase from opentelemetry.test.wsgitestutil import WsgiTestBase
@ -237,11 +254,11 @@ class TestWsgiApplication(WsgiTestBase):
SpanAttributes.NET_HOST_NAME: "127.0.0.1", SpanAttributes.NET_HOST_NAME: "127.0.0.1",
} }
expected_attributes_new = { expected_attributes_new = {
SpanAttributes.SERVER_PORT: 80, SERVER_PORT: 80,
SpanAttributes.SERVER_ADDRESS: "127.0.0.1", SERVER_ADDRESS: "127.0.0.1",
SpanAttributes.NETWORK_PROTOCOL_VERSION: "1.0", NETWORK_PROTOCOL_VERSION: "1.0",
SpanAttributes.HTTP_RESPONSE_STATUS_CODE: 200, HTTP_RESPONSE_STATUS_CODE: 200,
SpanAttributes.URL_SCHEME: "http", URL_SCHEME: "http",
} }
if old_sem_conv: if old_sem_conv:
expected_attributes.update(expected_attributes_old) expected_attributes.update(expected_attributes_old)
@ -253,9 +270,7 @@ class TestWsgiApplication(WsgiTestBase):
if old_sem_conv: if old_sem_conv:
expected_attributes[SpanAttributes.HTTP_METHOD] = http_method expected_attributes[SpanAttributes.HTTP_METHOD] = http_method
if new_sem_conv: if new_sem_conv:
expected_attributes[SpanAttributes.HTTP_REQUEST_METHOD] = ( expected_attributes[HTTP_REQUEST_METHOD] = http_method
http_method
)
self.assertEqual(span_list[0].attributes, expected_attributes) self.assertEqual(span_list[0].attributes, expected_attributes)
def test_basic_wsgi_call(self): def test_basic_wsgi_call(self):
@ -517,13 +532,13 @@ class TestWsgiAttributes(unittest.TestCase):
self.assertDictEqual( self.assertDictEqual(
attrs, attrs,
{ {
SpanAttributes.HTTP_REQUEST_METHOD: "GET", HTTP_REQUEST_METHOD: "GET",
SpanAttributes.SERVER_ADDRESS: "127.0.0.1", SERVER_ADDRESS: "127.0.0.1",
SpanAttributes.SERVER_PORT: 80, SERVER_PORT: 80,
SpanAttributes.NETWORK_PROTOCOL_VERSION: "1.0", NETWORK_PROTOCOL_VERSION: "1.0",
SpanAttributes.URL_PATH: "/", URL_PATH: "/",
SpanAttributes.URL_QUERY: "foo=bar", URL_QUERY: "foo=bar",
SpanAttributes.URL_SCHEME: "http", URL_SCHEME: "http",
}, },
) )
@ -543,11 +558,10 @@ class TestWsgiAttributes(unittest.TestCase):
SpanAttributes.HTTP_SERVER_NAME: parts.hostname, # Not true in the general case, but for all tests. SpanAttributes.HTTP_SERVER_NAME: parts.hostname, # Not true in the general case, but for all tests.
} }
expected_new = { expected_new = {
SpanAttributes.SERVER_PORT: parts.port SERVER_PORT: parts.port or (80 if parts.scheme == "http" else 443),
or (80 if parts.scheme == "http" else 443), SERVER_ADDRESS: parts.hostname,
SpanAttributes.SERVER_ADDRESS: parts.hostname, URL_PATH: parts.path,
SpanAttributes.URL_PATH: parts.path, URL_QUERY: parts.query,
SpanAttributes.URL_QUERY: parts.query,
} }
if old_semconv: if old_semconv:
if raw: if raw:
@ -560,17 +574,15 @@ class TestWsgiAttributes(unittest.TestCase):
expected_old[SpanAttributes.HTTP_HOST] = parts.hostname expected_old[SpanAttributes.HTTP_HOST] = parts.hostname
if new_semconv: if new_semconv:
if raw: if raw:
expected_new[SpanAttributes.URL_PATH] = expected_url.split( expected_new[URL_PATH] = expected_url.split(parts.path, 1)[1]
parts.path, 1
)[1]
if parts.query: if parts.query:
expected_new[SpanAttributes.URL_QUERY] = ( expected_new[URL_QUERY] = expected_url.split(
expected_url.split(parts.query, 1)[1] parts.query, 1
) )[1]
else: else:
expected_new[SpanAttributes.HTTP_URL] = expected_url expected_new[URL_FULL] = expected_url
if has_host: if has_host:
expected_new[SpanAttributes.SERVER_ADDRESS] = parts.hostname expected_new[SERVER_ADDRESS] = parts.hostname
attrs = otel_wsgi.collect_request_attributes(self.environ) attrs = otel_wsgi.collect_request_attributes(self.environ)
self.assertGreaterEqual( self.assertGreaterEqual(
@ -720,8 +732,8 @@ class TestWsgiAttributes(unittest.TestCase):
SpanAttributes.HTTP_TARGET: "http://docs.python.org:80/3/library/urllib.parse.html?highlight=params#url-parsing", SpanAttributes.HTTP_TARGET: "http://docs.python.org:80/3/library/urllib.parse.html?highlight=params#url-parsing",
} }
expected_new = { expected_new = {
SpanAttributes.URL_PATH: "/3/library/urllib.parse.html", URL_PATH: "/3/library/urllib.parse.html",
SpanAttributes.URL_QUERY: "highlight=params", URL_QUERY: "highlight=params",
} }
self.assertGreaterEqual( self.assertGreaterEqual(
otel_wsgi.collect_request_attributes(self.environ).items(), otel_wsgi.collect_request_attributes(self.environ).items(),

93
opentelemetry-instrumentation/src/opentelemetry/instrumentation/_semconv.py
View File

@ -17,16 +17,27 @@ import threading
from enum import Enum from enum import Enum
from opentelemetry.instrumentation.utils import http_status_to_status_code from opentelemetry.instrumentation.utils import http_status_to_status_code
from opentelemetry.semconv.attributes.error_attributes import ERROR_TYPE
from opentelemetry.semconv.attributes.http_attributes import (
HTTP_REQUEST_METHOD,
HTTP_REQUEST_METHOD_ORIGINAL,
HTTP_RESPONSE_STATUS_CODE,
HTTP_ROUTE,
)
from opentelemetry.semconv.attributes.network_attributes import (
NETWORK_PROTOCOL_VERSION,
)
from opentelemetry.semconv.attributes.server_attributes import (
SERVER_ADDRESS,
SERVER_PORT,
)
from opentelemetry.semconv.attributes.url_attributes import (
URL_FULL,
URL_SCHEME,
)
from opentelemetry.semconv.trace import SpanAttributes from opentelemetry.semconv.trace import SpanAttributes
from opentelemetry.trace.status import Status, StatusCode from opentelemetry.trace.status import Status, StatusCode
# TODO: will come through semconv package once updated
_SPAN_ATTRIBUTES_ERROR_TYPE = "error.type"
_SPAN_ATTRIBUTES_NETWORK_PEER_ADDRESS = "network.peer.address"
_SPAN_ATTRIBUTES_NETWORK_PEER_PORT = "network.peer.port"
_METRIC_ATTRIBUTES_CLIENT_DURATION_NAME = "http.client.request.duration"
_METRIC_ATTRIBUTES_SERVER_DURATION_NAME = "http.server.request.duration"
_client_duration_attrs_old = [ _client_duration_attrs_old = [
SpanAttributes.HTTP_STATUS_CODE, SpanAttributes.HTTP_STATUS_CODE,
SpanAttributes.HTTP_HOST, SpanAttributes.HTTP_HOST,
@ -38,14 +49,14 @@ _client_duration_attrs_old = [
] ]
_client_duration_attrs_new = [ _client_duration_attrs_new = [
_SPAN_ATTRIBUTES_ERROR_TYPE, ERROR_TYPE,
SpanAttributes.HTTP_REQUEST_METHOD, HTTP_REQUEST_METHOD,
SpanAttributes.HTTP_RESPONSE_STATUS_CODE, HTTP_RESPONSE_STATUS_CODE,
SpanAttributes.NETWORK_PROTOCOL_VERSION, NETWORK_PROTOCOL_VERSION,
SpanAttributes.SERVER_ADDRESS, SERVER_ADDRESS,
SpanAttributes.SERVER_PORT, SERVER_PORT,
# TODO: Support opt-in for scheme in new semconv # TODO: Support opt-in for scheme in new semconv
# SpanAttributes.URL_SCHEME, # URL_SCHEME,
] ]
_server_duration_attrs_old = [ _server_duration_attrs_old = [
@ -60,12 +71,12 @@ _server_duration_attrs_old = [
] ]
_server_duration_attrs_new = [ _server_duration_attrs_new = [
_SPAN_ATTRIBUTES_ERROR_TYPE, ERROR_TYPE,
SpanAttributes.HTTP_REQUEST_METHOD, HTTP_REQUEST_METHOD,
SpanAttributes.HTTP_RESPONSE_STATUS_CODE, HTTP_RESPONSE_STATUS_CODE,
SpanAttributes.HTTP_ROUTE, HTTP_ROUTE,
SpanAttributes.NETWORK_PROTOCOL_VERSION, NETWORK_PROTOCOL_VERSION,
SpanAttributes.URL_SCHEME, URL_SCHEME,
] ]
_server_active_requests_count_attrs_old = [ _server_active_requests_count_attrs_old = [
@ -79,8 +90,8 @@ _server_active_requests_count_attrs_old = [
] ]
_server_active_requests_count_attrs_new = [ _server_active_requests_count_attrs_new = [
SpanAttributes.HTTP_REQUEST_METHOD, HTTP_REQUEST_METHOD,
SpanAttributes.URL_SCHEME, URL_SCHEME,
] ]
OTEL_SEMCONV_STABILITY_OPT_IN = "OTEL_SEMCONV_STABILITY_OPT_IN" OTEL_SEMCONV_STABILITY_OPT_IN = "OTEL_SEMCONV_STABILITY_OPT_IN"
@ -202,46 +213,40 @@ def _set_http_method(result, original, normalized, sem_conv_opt_in_mode):
# See https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-spans.md#common-attributes # See https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-spans.md#common-attributes
# Method is case sensitive. "http.request.method_original" should not be sanitized or automatically capitalized. # Method is case sensitive. "http.request.method_original" should not be sanitized or automatically capitalized.
if original != normalized and _report_new(sem_conv_opt_in_mode): if original != normalized and _report_new(sem_conv_opt_in_mode):
set_string_attribute( set_string_attribute(result, HTTP_REQUEST_METHOD_ORIGINAL, original)
result, SpanAttributes.HTTP_REQUEST_METHOD_ORIGINAL, original
)
if _report_old(sem_conv_opt_in_mode): if _report_old(sem_conv_opt_in_mode):
set_string_attribute(result, SpanAttributes.HTTP_METHOD, normalized) set_string_attribute(result, SpanAttributes.HTTP_METHOD, normalized)
if _report_new(sem_conv_opt_in_mode): if _report_new(sem_conv_opt_in_mode):
set_string_attribute( set_string_attribute(result, HTTP_REQUEST_METHOD, normalized)
result, SpanAttributes.HTTP_REQUEST_METHOD, normalized
)
def _set_http_status_code(result, code, sem_conv_opt_in_mode): def _set_http_status_code(result, code, sem_conv_opt_in_mode):
if _report_old(sem_conv_opt_in_mode): if _report_old(sem_conv_opt_in_mode):
set_int_attribute(result, SpanAttributes.HTTP_STATUS_CODE, code) set_int_attribute(result, SpanAttributes.HTTP_STATUS_CODE, code)
if _report_new(sem_conv_opt_in_mode): if _report_new(sem_conv_opt_in_mode):
set_int_attribute( set_int_attribute(result, HTTP_RESPONSE_STATUS_CODE, code)
result, SpanAttributes.HTTP_RESPONSE_STATUS_CODE, code
)
def _set_http_url(result, url, sem_conv_opt_in_mode): def _set_http_url(result, url, sem_conv_opt_in_mode):
if _report_old(sem_conv_opt_in_mode): if _report_old(sem_conv_opt_in_mode):
set_string_attribute(result, SpanAttributes.HTTP_URL, url) set_string_attribute(result, SpanAttributes.HTTP_URL, url)
if _report_new(sem_conv_opt_in_mode): if _report_new(sem_conv_opt_in_mode):
set_string_attribute(result, SpanAttributes.URL_FULL, url) set_string_attribute(result, URL_FULL, url)
def _set_http_scheme(result, scheme, sem_conv_opt_in_mode): def _set_http_scheme(result, scheme, sem_conv_opt_in_mode):
if _report_old(sem_conv_opt_in_mode): if _report_old(sem_conv_opt_in_mode):
set_string_attribute(result, SpanAttributes.HTTP_SCHEME, scheme) set_string_attribute(result, SpanAttributes.HTTP_SCHEME, scheme)
if _report_new(sem_conv_opt_in_mode): if _report_new(sem_conv_opt_in_mode):
set_string_attribute(result, SpanAttributes.URL_SCHEME, scheme) set_string_attribute(result, URL_SCHEME, scheme)
def _set_http_host(result, host, sem_conv_opt_in_mode): def _set_http_host(result, host, sem_conv_opt_in_mode):
if _report_old(sem_conv_opt_in_mode): if _report_old(sem_conv_opt_in_mode):
set_string_attribute(result, SpanAttributes.HTTP_HOST, host) set_string_attribute(result, SpanAttributes.HTTP_HOST, host)
if _report_new(sem_conv_opt_in_mode): if _report_new(sem_conv_opt_in_mode):
set_string_attribute(result, SpanAttributes.SERVER_ADDRESS, host) set_string_attribute(result, SERVER_ADDRESS, host)
# Client # Client
@ -251,23 +256,21 @@ def _set_http_net_peer_name_client(result, peer_name, sem_conv_opt_in_mode):
if _report_old(sem_conv_opt_in_mode): if _report_old(sem_conv_opt_in_mode):
set_string_attribute(result, SpanAttributes.NET_PEER_NAME, peer_name) set_string_attribute(result, SpanAttributes.NET_PEER_NAME, peer_name)
if _report_new(sem_conv_opt_in_mode): if _report_new(sem_conv_opt_in_mode):
set_string_attribute(result, SpanAttributes.SERVER_ADDRESS, peer_name) set_string_attribute(result, SERVER_ADDRESS, peer_name)
def _set_http_peer_port_client(result, port, sem_conv_opt_in_mode): def _set_http_peer_port_client(result, port, sem_conv_opt_in_mode):
if _report_old(sem_conv_opt_in_mode): if _report_old(sem_conv_opt_in_mode):
set_int_attribute(result, SpanAttributes.NET_PEER_PORT, port) set_int_attribute(result, SpanAttributes.NET_PEER_PORT, port)
if _report_new(sem_conv_opt_in_mode): if _report_new(sem_conv_opt_in_mode):
set_int_attribute(result, SpanAttributes.SERVER_PORT, port) set_int_attribute(result, SERVER_PORT, port)
def _set_http_network_protocol_version(result, version, sem_conv_opt_in_mode): def _set_http_network_protocol_version(result, version, sem_conv_opt_in_mode):
if _report_old(sem_conv_opt_in_mode): if _report_old(sem_conv_opt_in_mode):
set_string_attribute(result, SpanAttributes.HTTP_FLAVOR, version) set_string_attribute(result, SpanAttributes.HTTP_FLAVOR, version)
if _report_new(sem_conv_opt_in_mode): if _report_new(sem_conv_opt_in_mode):
set_string_attribute( set_string_attribute(result, NETWORK_PROTOCOL_VERSION, version)
result, SpanAttributes.NETWORK_PROTOCOL_VERSION, version
)
# Server # Server
@ -347,8 +350,8 @@ def _set_status(
): ):
if status_code < 0: if status_code < 0:
if _report_new(sem_conv_opt_in_mode): if _report_new(sem_conv_opt_in_mode):
span.set_attribute(_SPAN_ATTRIBUTES_ERROR_TYPE, status_code_str) span.set_attribute(ERROR_TYPE, status_code_str)
metrics_attributes[_SPAN_ATTRIBUTES_ERROR_TYPE] = status_code_str metrics_attributes[ERROR_TYPE] = status_code_str
span.set_status( span.set_status(
Status( Status(
@ -370,12 +373,8 @@ def _set_status(
status_code status_code
) )
if status == StatusCode.ERROR: if status == StatusCode.ERROR:
span.set_attribute( span.set_attribute(ERROR_TYPE, status_code_str)
_SPAN_ATTRIBUTES_ERROR_TYPE, status_code_str metrics_attributes[ERROR_TYPE] = status_code_str
)
metrics_attributes[_SPAN_ATTRIBUTES_ERROR_TYPE] = (
status_code_str
)
span.set_status(Status(status)) span.set_status(Status(status))