Fixed context extraction and activation logic.

Author: Andres Beck-Ruiz

CHANGELOG.md

@@ -14,6 +14,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   `opentelemetry-instrumentation-starlette`, `opentelemetry-instrumentation-urllib`, `opentelemetry-instrumentation-urllib3` Added `request_hook` and `response_hook` callbacks 
   ([#576](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/576))
 
+### Changed
+- Server instrumentations now look for parent spans in current context before extracting context from carriers. ([#544](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/544))
+
 ## [1.4.0-0.23b0](https://github.com/open-telemetry/opentelemetry-python/releases/tag/v1.4.0-0.23b0) - 2021-07-21
 
 ### Removed

instrumentation/opentelemetry-instrumentation-asgi/src/opentelemetry/instrumentation/asgi/__init__.py

@@ -219,8 +219,14 @@ async def __call__(self, scope, receive, send):
         span_name, additional_attributes = self.default_span_details(scope)
 
         try:
+            token = ctx = span_kind = None
+            if trace.get_current_span() is trace.INVALID_SPAN:
+                ctx = extract(scope, getter=asgi_getter)
+                token = context.attach(ctx)
+                span_kind = trace.SpanKind.SERVER
+
             with self.tracer.start_as_current_span(
-                span_name, kind=trace.SpanKind.SERVER,
+                span_name, ctx, kind=span_kind
             ) as span:
                 if span.is_recording():
                     attributes = collect_request_attributes(scope)
@@ -265,4 +271,5 @@ async def wrapped_send(message):
 
                 await self.app(scope, wrapped_receive, wrapped_send)
         finally:
-            context.detach(token)
+            if token is not None:
+                context.detach(token)

instrumentation/opentelemetry-instrumentation-django/src/opentelemetry/instrumentation/django/middleware.py

@@ -32,7 +32,13 @@
 )
 from opentelemetry.propagate import extract
 from opentelemetry.semconv.trace import SpanAttributes
-from opentelemetry.trace import Span, SpanKind, use_span
+from opentelemetry.trace import (
+    INVALID_SPAN,
+    Span,
+    SpanKind,
+    get_current_span,
+    use_span,
+)
 from opentelemetry.util.http import get_excluded_urls, get_traced_request_attrs
 
 try:
@@ -146,11 +152,17 @@ def process_request(self, request):
 
         request_meta = request.META
 
-        token = attach(extract(request_meta, getter=wsgi_getter))
+        token = context = span_kind = None
+
+        if get_current_span() is INVALID_SPAN:
+            context = extract(request_meta, getter=wsgi_getter)
+            token = attach(context)
+            span_kind = SpanKind.SERVER
 
         span = self._tracer.start_span(
             self._get_span_name(request),
-            kind=SpanKind.SERVER,
+            context,
+            kind=span_kind,
             start_time=request_meta.get(
                 "opentelemetry-instrumentor-django.starttime_key"
             ),
@@ -170,7 +182,8 @@ def process_request(self, request):
 
         request.META[self._environ_activation_key] = activation
         request.META[self._environ_span_key] = span
-        request.META[self._environ_token] = token
+        if token is not None:
+            request.META[self._environ_token] = token
 
         if _DjangoMiddleware._otel_request_hook:
             _DjangoMiddleware._otel_request_hook(  # pylint: disable=not-callable
@@ -238,7 +251,7 @@ def process_response(self, request, response):
             else:
                 activation.__exit__(None, None, None)
 
-        if self._environ_token in request.META.keys():
+        if request.META.get(self._environ_token, None) is not None:
             detach(request.environ.get(self._environ_token))
             request.META.pop(self._environ_token)
 

instrumentation/opentelemetry-instrumentation-falcon/src/opentelemetry/instrumentation/falcon/__init__.py

@@ -174,12 +174,20 @@ def __call__(self, env, start_response):
 
         start_time = _time_ns()
 
-        token = context.attach(extract(env, getter=otel_wsgi.wsgi_getter))
+        token = ctx = span_kind = None
+
+        if trace.get_current_span() is trace.INVALID_SPAN:
+            ctx = extract(env, getter=otel_wsgi.wsgi_getter)
+            token = context.attach(ctx)
+            span_kind = trace.SpanKind.SERVER
+
         span = self._tracer.start_span(
             otel_wsgi.get_default_span_name(env),
-            kind=trace.SpanKind.SERVER,
+            ctx,
+            kind=span_kind,
             start_time=start_time,
         )
+
         if span.is_recording():
             attributes = otel_wsgi.collect_request_attributes(env)
             for key, value in attributes.items():
@@ -196,7 +204,8 @@ def _start_response(status, response_headers, *args, **kwargs):
                 status, response_headers, *args, **kwargs
             )
             activation.__exit__(None, None, None)
-            context.detach(token)
+            if token is not None:
+                context.detach(token)
             return response
 
         try:
@@ -205,7 +214,8 @@ def _start_response(status, response_headers, *args, **kwargs):
             activation.__exit__(
                 type(exc), exc, getattr(exc, "__traceback__", None),
             )
-            context.detach(token)
+            if token is not None:
+                context.detach(token)
             raise
 
 

instrumentation/opentelemetry-instrumentation-flask/src/opentelemetry/instrumentation/flask/__init__.py

@@ -129,15 +129,21 @@ def _before_request():
             return
         flask_request_environ = flask.request.environ
         span_name = get_default_span_name()
-        token = context.attach(
-            extract(flask_request_environ, getter=otel_wsgi.wsgi_getter)
-        )
+
+        token = ctx = span_kind = None
+
+        if trace.get_current_span() is trace.INVALID_SPAN:
+            ctx = extract(flask_request_environ, getter=otel_wsgi.wsgi_getter)
+            token = context.attach(ctx)
+            span_kind = trace.SpanKind.SERVER
 
         span = tracer.start_span(
             span_name,
-            kind=trace.SpanKind.SERVER,
+            ctx,
+            kind=span_kind,
             start_time=flask_request_environ.get(_ENVIRON_STARTTIME_KEY),
         )
+
         if request_hook:
             request_hook(span, flask_request_environ)
 
@@ -181,7 +187,8 @@ def _teardown_request(exc):
         activation.__exit__(
             type(exc), exc, getattr(exc, "__traceback__", None)
         )
-    context.detach(flask.request.environ.get(_ENVIRON_TOKEN))
+    if flask.request.environ.get(_ENVIRON_TOKEN, None) is not None:
+        context.detach(flask.request.environ.get(_ENVIRON_TOKEN))
 
 
 class _InstrumentedFlask(flask.Flask):

instrumentation/opentelemetry-instrumentation-pyramid/src/opentelemetry/instrumentation/pyramid/callbacks.py

@@ -92,8 +92,15 @@ def _before_traversal(event):
     else:
         span_name = otel_wsgi.get_default_span_name(request_environ)
 
+    token = ctx = span_kind = None
+
+    if trace.get_current_span() is trace.INVALID_SPAN:
+        ctx = extract(request_environ, getter=otel_wsgi.wsgi_getter)
+        token = context.attach(ctx)
+        span_kind = trace.SpanKind.SERVER
+
     span = tracer.start_span(
-        span_name, kind=trace.SpanKind.SERVER, start_time=start_time,
+        span_name, ctx, kind=span_kind, start_time=start_time,
     )
 
     if span.is_recording():
@@ -109,7 +116,8 @@ def _before_traversal(event):
     activation.__enter__()  # pylint: disable=E1101
     request_environ[_ENVIRON_ACTIVATION_KEY] = activation
     request_environ[_ENVIRON_SPAN_KEY] = span
-    request_environ[_ENVIRON_TOKEN] = token
+    if token is not None:
+        request_environ[_ENVIRON_TOKEN] = token
 
 
 def trace_tween_factory(handler, registry):
@@ -177,8 +185,8 @@ def trace_tween(request):
                     )
                 else:
                     activation.__exit__(None, None, None)
-
-                context.detach(request.environ.get(_ENVIRON_TOKEN))
+                if request.environ.get(_ENVIRON_TOKEN, None) is not None:
+                    context.detach(request.environ.get(_ENVIRON_TOKEN))
 
         return response
 

instrumentation/opentelemetry-instrumentation-tornado/src/opentelemetry/instrumentation/tornado/__init__.py

@@ -253,13 +253,20 @@ def _get_operation_name(handler, request):
 
 
 def _start_span(tracer, handler, start_time) -> _TraceContext:
-    token = context.attach(extract(handler.request.headers))
+    token = ctx = span_kind = None
+
+    if trace.get_current_span() is trace.INVALID_SPAN:
+        ctx = extract(handler.request.headers)
+        token = context.attach(ctx)
+        span_kind = trace.SpanKind.SERVER
 
     span = tracer.start_span(
         _get_operation_name(handler, handler.request),
-        kind=trace.SpanKind.SERVER,
+        ctx,
+        kind=span_kind,
         start_time=start_time,
     )
+
     if span.is_recording():
         attributes = _get_attributes_from_request(handler.request)
         for key, value in attributes.items():
@@ -317,5 +324,6 @@ def _finish_span(tracer, handler, error=None):
         )
 
     ctx.activation.__exit__(*finish_args)  # pylint: disable=E1101
-    context.detach(ctx.token)
+    if ctx.token is not None:
+        context.detach(ctx.token)
     delattr(handler, _HANDLER_CONTEXT_KEY)

instrumentation/opentelemetry-instrumentation-wsgi/src/opentelemetry/instrumentation/wsgi/__init__.py

@@ -257,11 +257,17 @@ def __call__(self, environ, start_response):
             start_response: The WSGI start_response callable.
         """
 
-        token = context.attach(extract(environ, getter=wsgi_getter))
+        token = ctx = span_kind = None
+
+        if trace.get_current_span() is trace.INVALID_SPAN:
+            ctx = extract(environ, getter=wsgi_getter)
+            token = context.attach(ctx)
+            span_kind = trace.SpanKind.SERVER
 
         span = self.tracer.start_span(
             get_default_span_name(environ),
-            kind=trace.SpanKind.SERVER,
+            ctx,
+            kind=span_kind,
             attributes=collect_request_attributes(environ),
         )
 
@@ -285,7 +291,8 @@ def __call__(self, environ, start_response):
             if span.is_recording():
                 span.set_status(Status(StatusCode.ERROR, str(ex)))
             span.end()
-            context.detach(token)
+            if token is not None:
+                context.detach(token)
             raise
 
 
@@ -302,7 +309,8 @@ def _end_span_after_iterating(iterable, span, tracer, token):
         if close:
             close()
         span.end()
-        context.detach(token)
+        if token is not None:
+            context.detach(token)
 
 
 # TODO: inherit from opentelemetry.instrumentation.propagators.Setter