Develop/condition server span django

CHANGELOG.md

@@ -23,8 +23,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `opentelemetry-instrumentation-tornado` Add support instrumentation for Tornado 5.1.1
   ([#812](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/812))
 
+- `opentelemetry-instrumentation-django` Django: Conditionally create SERVER spans
+  ([#812](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/832))
+
 - `opentelemetry-instrumentation-flask` Flask: Conditionally create SERVER spans
   ([#828](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/828))
+
 
 ## [1.7.1-0.26b1](https://github.com/open-telemetry/opentelemetry-python/releases/tag/v1.7.0-0.26b0) - 2021-11-11
 

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

@@ -32,7 +32,13 @@
 from opentelemetry.instrumentation.wsgi import wsgi_getter
 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:
@@ -183,11 +189,16 @@ def process_request(self, request):
             carrier_getter = wsgi_getter
             collect_request_attributes = wsgi_collect_request_attributes
 
-        token = attach(extract(carrier, getter=carrier_getter))
-
+        token = context = None
+        span_kind = SpanKind.INTERNAL
+        if get_current_span() is INVALID_SPAN:
+            context = extract(request_meta, getter=carrier_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"
             ),
@@ -220,7 +231,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:
+            request.META[self._environ_token] = token
 
         if _DjangoMiddleware._otel_request_hook:
             _DjangoMiddleware._otel_request_hook(  # pylint: disable=not-callable
@@ -295,7 +307,8 @@ def process_response(self, request, response):
             else:
                 activation.__exit__(None, None, None)
 
-        if self._environ_token in request.META.keys():
+        # if self._environ_token in request.META.keys():
+        if request.META.get(self._environ_token, None) is not None:
             detach(request.META.get(self._environ_token))
             request.META.pop(self._environ_token)
 

instrumentation/opentelemetry-instrumentation-django/tests/test_middleware.py

@@ -18,9 +18,13 @@
 from unittest.mock import Mock, patch
 
 from django import VERSION, conf
+from django.core.wsgi import get_wsgi_application
+from django.core.servers.basehttp import get_internal_wsgi_application
 from django.http import HttpRequest, HttpResponse
-from django.test.client import Client
-from django.test.utils import setup_test_environment, teardown_test_environment
+from django.test.client import Client, RequestFactory
+from django.test.testcases import SimpleTestCase
+from django.test.utils import override_settings, setup_test_environment, teardown_test_environment
+from opentelemetry import trace
 
 from opentelemetry.instrumentation.django import (
     DjangoInstrumentor,
@@ -30,6 +34,7 @@
     TraceResponsePropagator,
     set_global_response_propagator,
 )
+from opentelemetry.instrumentation.wsgi import OpenTelemetryMiddleware
 from opentelemetry.sdk import resources
 from opentelemetry.sdk.trace import Span
 from opentelemetry.sdk.trace.id_generator import RandomIdGenerator
@@ -409,6 +414,7 @@ def setUp(self):
         result = self.create_tracer_provider(resource=resource)
         tracer_provider, exporter = result
         self.exporter = exporter
+        self.tracer_provider = tracer_provider
         _django_instrumentor.instrument(tracer_provider=tracer_provider)
 
     def tearDown(self):
@@ -432,3 +438,28 @@ def test_tracer_provider_traced(self):
         self.assertEqual(
             span.resource.attributes["resource-key"], "resource-value"
         )
+
+
+    def test_django_with_wsgi_instrumented(self):
+        """ 
+        This test is related to https://github.com/open-telemetry/opentelemetry-python-contrib/issues/448
+        Here we have enabled django as well as wsgi instrumentation.
+        and on sending the request, it should give us the two spans with parent-child relationship.
+        """
+        application = get_wsgi_application()
+        application = OpenTelemetryMiddleware(application, tracer_provider=self.tracer_provider)
+        environ = RequestFactory()._base_environ(
+            PATH_INFO="/span_name/1234/",
+            CONTENT_TYPE="text/html; charset=utf-8",
+            REQUEST_METHOD="GET"
+        )
+        response_data = {}
+        def start_response(status, headers):
+            response_data["status"] = status
+            response_data["headers"] = headers
+
+        resp = next(application(environ, start_response))
+        span_list = self.exporter.get_finished_spans()
+        self.assertEqual(span_list[0].attributes[SpanAttributes.HTTP_STATUS_CODE], 200)
+        self.assertEqual(trace.SpanKind.INTERNAL, span_list[0].kind)
+        self.assertEqual(trace.SpanKind.SERVER, span_list[1].kind)