opentelemetry-instrumentation-tornado 0.55b1__py3-none-any.whl → 0.56b0__py3-none-any.whl

opentelemetry/instrumentation/tornado/__init__.py

@@ -162,6 +162,7 @@ from timeit import default_timer
 from typing import Collection, Dict
 
 import tornado.web
+import tornado.websocket
 import wrapt
 from wrapt import wrap_function_wrapper
 
@@ -182,8 +183,19 @@ from opentelemetry.instrumentation.utils import (
 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,
@@ -351,12 +363,20 @@ def patch_handler_class(tracer, server_histograms, cls, request_hook=None):
         "prepare",
         partial(_prepare, tracer, server_histograms, request_hook),
     )
-    _wrap(cls, "on_finish", partial(_on_finish, tracer, server_histograms))
     _wrap(
         cls,
         "log_exception",
         partial(_log_exception, tracer, server_histograms),
     )
+
+    if issubclass(cls, tornado.websocket.WebSocketHandler):
+        _wrap(
+            cls,
+            "on_close",
+            partial(_websockethandler_on_close, tracer, server_histograms),
+        )
+    else:
+        _wrap(cls, "on_finish", partial(_on_finish, tracer, server_histograms))
     return True
 
 
@@ -365,8 +385,11 @@ def unpatch_handler_class(cls):
         return
 
     unwrap(cls, "prepare")
-    unwrap(cls, "on_finish")
     unwrap(cls, "log_exception")
+    if issubclass(cls, tornado.websocket.WebSocketHandler):
+        unwrap(cls, "on_close")
+    else:
+        unwrap(cls, "on_finish")
     delattr(cls, _OTEL_PATCHED_KEY)
 
 
@@ -394,13 +417,21 @@ def _prepare(
 
 
 def _on_finish(tracer, server_histograms, func, handler, args, kwargs):
-    response = func(*args, **kwargs)
-
-    _record_on_finish_metrics(server_histograms, handler)
+    try:
+        return func(*args, **kwargs)
+    finally:
+        _record_on_finish_metrics(server_histograms, handler)
+        _finish_span(tracer, handler)
 
-    _finish_span(tracer, handler)
 
-    return response
+def _websockethandler_on_close(
+    tracer, server_histograms, func, handler, args, kwargs
+):
+    try:
+        func()
+    finally:
+        _record_on_finish_metrics(server_histograms, handler)
+        _finish_span(tracer, handler)
 
 
 def _log_exception(tracer, server_histograms, func, handler, args, kwargs):
@@ -442,23 +473,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
@@ -550,7 +579,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
         )
@@ -601,7 +630,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
@@ -621,11 +650,11 @@ 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
@@ -633,6 +662,6 @@ def _create_active_requests_attributes(request):
 
 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

opentelemetry/instrumentation/tornado/client.py

@@ -20,9 +20,13 @@ from tornado.httpclient import HTTPError, HTTPRequest
 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
+from opentelemetry.util.http import redact_url
 
 
 def _normalize_request(args, kwargs):
@@ -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: redact_url(request.url),
+            HTTP_METHOD: request.method,
         }
         for key, value in attributes.items():
             span.set_attribute(key, value)
@@ -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:
@@ -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: redact_url(response.request.url),
+        HTTP_METHOD: response.request.method,
     }
 
     return metric_attributes

opentelemetry/instrumentation/tornado/version.py

@@ -12,4 +12,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-__version__ = "0.55b1"
+__version__ = "0.56b0"

{opentelemetry_instrumentation_tornado-0.55b1.dist-info → opentelemetry_instrumentation_tornado-0.56b0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: opentelemetry-instrumentation-tornado
-Version: 0.55b1
+Version: 0.56b0
 Summary: Tornado instrumentation for OpenTelemetry
 Project-URL: Homepage, https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/instrumentation/opentelemetry-instrumentation-tornado
 Project-URL: Repository, https://github.com/open-telemetry/opentelemetry-python-contrib
@@ -18,9 +18,9 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.9
 Requires-Dist: opentelemetry-api~=1.12
-Requires-Dist: opentelemetry-instrumentation==0.55b1
-Requires-Dist: opentelemetry-semantic-conventions==0.55b1
-Requires-Dist: opentelemetry-util-http==0.55b1
+Requires-Dist: opentelemetry-instrumentation==0.56b0
+Requires-Dist: opentelemetry-semantic-conventions==0.56b0
+Requires-Dist: opentelemetry-util-http==0.56b0
 Provides-Extra: instruments
 Requires-Dist: tornado>=5.1.1; extra == 'instruments'
 Description-Content-Type: text/x-rst

opentelemetry_instrumentation_tornado-0.56b0.dist-info/RECORD

@@ -0,0 +1,9 @@
+opentelemetry/instrumentation/tornado/__init__.py,sha256=Xo2NCi1_C4J9wK3U1EI1gNNlNPsUJDFlu97FSnjTh2I,23814
+opentelemetry/instrumentation/tornado/client.py,sha256=owjoJurMaTaW3u8MGbuScAPKKtbqm-tkzY8O1eoasPQ,5031
+opentelemetry/instrumentation/tornado/package.py,sha256=mv-OUOrDF54kFoP_Epb3Pv8aufliZTMOwLWL5oAV_hY,649
+opentelemetry/instrumentation/tornado/version.py,sha256=Lt3ez1q5jzk4LG8aTMzoNp4bUxxWBqofY7vWXcRBByA,608
+opentelemetry_instrumentation_tornado-0.56b0.dist-info/METADATA,sha256=Ae8-OpWuHMP9SOLyiHgbDKKSVK7lMNvsC_tUde_1q0Q,2072
+opentelemetry_instrumentation_tornado-0.56b0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+opentelemetry_instrumentation_tornado-0.56b0.dist-info/entry_points.txt,sha256=oDTErilMYHHuN6bv9XNAU1Avoy8f_nfCx91bASSkpgg,97
+opentelemetry_instrumentation_tornado-0.56b0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+opentelemetry_instrumentation_tornado-0.56b0.dist-info/RECORD,,

opentelemetry_instrumentation_tornado-0.55b1.dist-info/RECORD

@@ -1,9 +0,0 @@
-opentelemetry/instrumentation/tornado/__init__.py,sha256=avm1_uofS-LrkTteD7R9VLgQagBmu0cuSBqCW41yYyc,23228
-opentelemetry/instrumentation/tornado/client.py,sha256=GmCilVnjXQAyXqGDAZsTT8CDhVTmRtczXgFzYLmpMto,5082
-opentelemetry/instrumentation/tornado/package.py,sha256=mv-OUOrDF54kFoP_Epb3Pv8aufliZTMOwLWL5oAV_hY,649
-opentelemetry/instrumentation/tornado/version.py,sha256=9poofzNAQlIZ01Tbk-NsWviDJJKwwkXRZ-4gS8RKJ9M,608
-opentelemetry_instrumentation_tornado-0.55b1.dist-info/METADATA,sha256=p_YFie3JFEPUrAeoXWCOEEOIJxhKB_U-dif7D6y4yQY,2072
-opentelemetry_instrumentation_tornado-0.55b1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-opentelemetry_instrumentation_tornado-0.55b1.dist-info/entry_points.txt,sha256=oDTErilMYHHuN6bv9XNAU1Avoy8f_nfCx91bASSkpgg,97
-opentelemetry_instrumentation_tornado-0.55b1.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-opentelemetry_instrumentation_tornado-0.55b1.dist-info/RECORD,,