Django: Record status, http.status_code and event on exception (open-telemetry#1257)

owais · web-flow · commit 9642b6d47dc3 · 2020-10-21T09:01:49.000-07:00
diff --git a/instrumentation/opentelemetry-instrumentation-django/src/opentelemetry/instrumentation/django/middleware.py b/instrumentation/opentelemetry-instrumentation-django/src/opentelemetry/instrumentation/django/middleware.py
@@ -60,6 +60,7 @@ class _DjangoMiddleware(MiddlewareMixin):
     )
     _environ_token = "opentelemetry-instrumentor-django.token"
     _environ_span_key = "opentelemetry-instrumentor-django.span_key"
+    _environ_exception_key = "opentelemetry-instrumentor-django.exception_key"
 
     _excluded_urls = Configuration().DJANGO_EXCLUDED_URLS or []
     if _excluded_urls:
@@ -177,22 +178,11 @@ def process_view(self, request, view_func, *args, **kwargs):
                         span.set_attribute("http.route", route)
 
     def process_exception(self, request, exception):
-        # Django can call this method and process_response later. In order
-        # to avoid __exit__ and detach from being called twice then, the
-        # respective keys are being removed here.
         if self._excluded_urls.url_disabled(request.build_absolute_uri("?")):
             return
 
         if self._environ_activation_key in request.META.keys():
-            request.META[self._environ_activation_key].__exit__(
-                type(exception),
-                exception,
-                getattr(exception, "__traceback__", None),
-            )
-            request.META.pop(self._environ_activation_key)
-
-            detach(request.environ[self._environ_token])
-            request.META.pop(self._environ_token, None)
+            request.META[self._environ_exception_key] = exception
 
     def process_response(self, request, response):
         if self._excluded_urls.url_disabled(request.build_absolute_uri("?")):
@@ -213,9 +203,17 @@ def process_response(self, request, response):
             )
             request.META.pop(self._environ_span_key)
 
-            request.META[self._environ_activation_key].__exit__(
-                None, None, None
-            )
+            exception = request.META.pop(self._environ_exception_key, None)
+            if exception:
+                request.META[self._environ_activation_key].__exit__(
+                    type(exception),
+                    exception,
+                    getattr(exception, "__traceback__", None),
+                )
+            else:
+                request.META[self._environ_activation_key].__exit__(
+                    None, None, None
+                )
             request.META.pop(self._environ_activation_key)
 
         if self._environ_token in request.META.keys():
@@ -231,5 +229,4 @@ def process_response(self, request, response):
                 )
         except Exception as ex:  # pylint: disable=W0703
             _logger.warning("Error recording duration metrics: %s", ex)
-
         return response
diff --git a/instrumentation/opentelemetry-instrumentation-django/tests/test_middleware.py b/instrumentation/opentelemetry-instrumentation-django/tests/test_middleware.py
@@ -194,21 +194,30 @@ def test_error(self):
         )
         self.assertEqual(span.kind, SpanKind.SERVER)
         self.assertEqual(
-            span.status.canonical_code, StatusCanonicalCode.UNKNOWN
+            span.status.canonical_code, StatusCanonicalCode.INTERNAL
         )
         self.assertEqual(span.attributes["http.method"], "GET")
         self.assertEqual(
             span.attributes["http.url"], "http://testserver/error/"
         )
         self.assertEqual(span.attributes["http.route"], "^error/")
         self.assertEqual(span.attributes["http.scheme"], "http")
+        self.assertEqual(span.attributes["http.status_code"], 500)
         self.assertIsNotNone(_django_instrumentor.meter)
         self.assertEqual(len(_django_instrumentor.meter.metrics), 1)
+
+        self.assertEqual(len(span.events), 1)
+        event = span.events[0]
+        self.assertEqual(event.name, "exception")
+        self.assertEqual(event.attributes["exception.type"], "ValueError")
+        self.assertEqual(event.attributes["exception.message"], "error")
+
         recorder = _django_instrumentor.meter.metrics.pop()
         match_key = get_dict_as_key(
             {
                 "http.flavor": "1.1",
                 "http.method": "GET",
+                "http.status_code": "500",
                 "http.url": "http://testserver/error/",
             }
         )
diff --git a/instrumentation/opentelemetry-instrumentation-flask/CHANGELOG.md b/instrumentation/opentelemetry-instrumentation-flask/CHANGELOG.md
@@ -2,6 +2,9 @@
 
 ## Unreleased
 
+- Record span status and http.status_code attribute on exception 
+  ([#1257](https://github.com/open-telemetry/opentelemetry-python/pull/1257))
+
 ## Version 0.13b0
 
 Released 2020-09-17

Original file line number	Diff line number	Diff line change
`@@ -194,21 +194,30 @@ def test_error(self):`
`194`	`194`	`)`
`195`	`195`	`self.assertEqual(span.kind, SpanKind.SERVER)`
`196`	`196`	`self.assertEqual(`
`197`		`- span.status.canonical_code, StatusCanonicalCode.UNKNOWN`
	`197`	`+ span.status.canonical_code, StatusCanonicalCode.INTERNAL`
`198`	`198`	`)`
`199`	`199`	`self.assertEqual(span.attributes["http.method"], "GET")`
`200`	`200`	`self.assertEqual(`
`201`	`201`	`span.attributes["http.url"], "http://testserver/error/"`
`202`	`202`	`)`
`203`	`203`	`self.assertEqual(span.attributes["http.route"], "^error/")`
`204`	`204`	`self.assertEqual(span.attributes["http.scheme"], "http")`
	`205`	`+ self.assertEqual(span.attributes["http.status_code"], 500)`
`205`	`206`	`self.assertIsNotNone(_django_instrumentor.meter)`
`206`	`207`	`self.assertEqual(len(_django_instrumentor.meter.metrics), 1)`
	`208`	`+`
	`209`	`+ self.assertEqual(len(span.events), 1)`
	`210`	`+ event = span.events[0]`
	`211`	`+ self.assertEqual(event.name, "exception")`
	`212`	`+ self.assertEqual(event.attributes["exception.type"], "ValueError")`
	`213`	`+ self.assertEqual(event.attributes["exception.message"], "error")`
	`214`	`+`
`207`	`215`	`recorder = _django_instrumentor.meter.metrics.pop()`
`208`	`216`	`match_key = get_dict_as_key(`
`209`	`217`	`{`
`210`	`218`	`"http.flavor": "1.1",`
`211`	`219`	`"http.method": "GET",`
	`220`	`+ "http.status_code": "500",`
`212`	`221`	`"http.url": "http://testserver/error/",`
`213`	`222`	`}`
`214`	`223`	`)`