Skip to content

refactor(tornado): replaces SpanAttributes by semconv attributes #3582

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.

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 3 commits into from
Jun 16, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -182,8 +182,19 @@ def client_response_hook(span, future):
from opentelemetry.metrics import get_meter
from opentelemetry.metrics._internal.instrument import Histogram
from opentelemetry.propagators import textmap
from opentelemetry.semconv._incubating.attributes.http_attributes import (
HTTP_CLIENT_IP,
HTTP_FLAVOR,
HTTP_HOST,
HTTP_METHOD,
HTTP_SCHEME,
HTTP_STATUS_CODE,
HTTP_TARGET,
)
from opentelemetry.semconv._incubating.attributes.net_attributes import (
NET_PEER_IP,
)
from opentelemetry.semconv.metrics import MetricInstruments
from opentelemetry.semconv.trace import SpanAttributes
from opentelemetry.trace.status import Status, StatusCode
from opentelemetry.util.http import (
OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_REQUEST,
Expand Down Expand Up @@ -442,23 +453,21 @@ def _collect_custom_response_headers_attributes(response_headers):

def _get_attributes_from_request(request):
attrs = {
SpanAttributes.HTTP_METHOD: request.method,
SpanAttributes.HTTP_SCHEME: request.protocol,
SpanAttributes.HTTP_HOST: request.host,
SpanAttributes.HTTP_TARGET: request.path,
HTTP_METHOD: request.method,
HTTP_SCHEME: request.protocol,
HTTP_HOST: request.host,
HTTP_TARGET: request.path,
}

if request.remote_ip:
# NET_PEER_IP is the address of the network peer
# HTTP_CLIENT_IP is the address of the client, which might be different
# if Tornado is set to trust X-Forwarded-For headers (xheaders=True)
attrs[SpanAttributes.HTTP_CLIENT_IP] = request.remote_ip
attrs[HTTP_CLIENT_IP] = request.remote_ip
if hasattr(request.connection, "context") and getattr(
request.connection.context, "_orig_remote_ip", None
):
attrs[SpanAttributes.NET_PEER_IP] = (
request.connection.context._orig_remote_ip
)
attrs[NET_PEER_IP] = request.connection.context._orig_remote_ip

return extract_attributes_from_object(
request, _traced_request_attrs, attrs
Expand Down Expand Up @@ -550,7 +559,7 @@ def _finish_span(tracer, handler, error=None):
return

if ctx.span.is_recording():
ctx.span.set_attribute(SpanAttributes.HTTP_STATUS_CODE, status_code)
ctx.span.set_attribute(HTTP_STATUS_CODE, status_code)
otel_status_code = http_status_to_status_code(
status_code, server_span=True
)
Expand Down Expand Up @@ -601,7 +610,7 @@ def _record_on_finish_metrics(server_histograms, handler, error=None):
metric_attributes = _create_metric_attributes(handler)

if isinstance(error, tornado.web.HTTPError):
metric_attributes[SpanAttributes.HTTP_STATUS_CODE] = error.status_code
metric_attributes[HTTP_STATUS_CODE] = error.status_code

server_histograms[MetricInstruments.HTTP_SERVER_RESPONSE_SIZE].record(
response_size, attributes=metric_attributes
Expand All @@ -621,18 +630,18 @@ def _record_on_finish_metrics(server_histograms, handler, error=None):

def _create_active_requests_attributes(request):
metric_attributes = {
SpanAttributes.HTTP_METHOD: request.method,
SpanAttributes.HTTP_SCHEME: request.protocol,
SpanAttributes.HTTP_FLAVOR: request.version,
SpanAttributes.HTTP_HOST: request.host,
SpanAttributes.HTTP_TARGET: request.path,
HTTP_METHOD: request.method,
HTTP_SCHEME: request.protocol,
HTTP_FLAVOR: request.version,
HTTP_HOST: request.host,
HTTP_TARGET: request.path,
}

return metric_attributes


def _create_metric_attributes(handler):
metric_attributes = _create_active_requests_attributes(handler.request)
metric_attributes[SpanAttributes.HTTP_STATUS_CODE] = handler.get_status()
metric_attributes[HTTP_STATUS_CODE] = handler.get_status()

return metric_attributes
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,11 @@
from opentelemetry import trace
from opentelemetry.instrumentation.utils import http_status_to_status_code
from opentelemetry.propagate import inject
from opentelemetry.semconv.trace import SpanAttributes
from opentelemetry.semconv._incubating.attributes.http_attributes import (
HTTP_METHOD,
HTTP_STATUS_CODE,
HTTP_URL,
)
from opentelemetry.trace.status import Status, StatusCode
from opentelemetry.util.http import remove_url_credentials

Expand Down Expand Up @@ -75,8 +79,8 @@ def fetch_async(

if span.is_recording():
attributes = {
SpanAttributes.HTTP_URL: remove_url_credentials(request.url),
SpanAttributes.HTTP_METHOD: request.method,
HTTP_URL: remove_url_credentials(request.url),
HTTP_METHOD: request.method,
}
for key, value in attributes.items():
span.set_attribute(key, value)
Expand Down Expand Up @@ -135,7 +139,7 @@ def _finish_tracing_callback(
)

if status_code is not None:
span.set_attribute(SpanAttributes.HTTP_STATUS_CODE, status_code)
span.set_attribute(HTTP_STATUS_CODE, status_code)
span.set_status(status)

if response is not None:
Expand All @@ -160,9 +164,9 @@ def _finish_tracing_callback(

def _create_metric_attributes(response):
metric_attributes = {
SpanAttributes.HTTP_STATUS_CODE: response.code,
SpanAttributes.HTTP_URL: remove_url_credentials(response.request.url),
SpanAttributes.HTTP_METHOD: response.request.method,
HTTP_STATUS_CODE: response.code,
HTTP_URL: remove_url_credentials(response.request.url),
HTTP_METHOD: response.request.method,
}

return metric_attributes
Loading