Skip to content
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.

Sign up for GitHub

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

Django: Record status and http.status_code on exception #1257

Merged
merged 2 commits into from
Oct 21, 2020
Merged

Django: Record status and http.status_code on exception #1257

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
95a5b82
Django: Record status, http.status_code and event on exception
owais Oct 19, 2020
05e9b99
Merge branch 'master' into django-exception-status-code
owais Oct 19, 2020
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
29 changes: 13 additions & 16 deletions ...entelemetry-instrumentation-django/src/opentelemetry/instrumentation/django/middleware.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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__(
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wasn't this behavior already implemented here? How does moving the logic to process_response change anything?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It was but because we popped the activation key, process_response did not do anything. We recorded the exception but ignored the response meaning response code or metrics were not recorded for example. We could either duplicate the code here, take it out in a function and call from both places or just make the exception available to process_response so it can handle all cases.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right makes sense. Doesn't add_response_attributes already handle setting the status and http.status_code though?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right, it does but without this change it was never executed in case of an exception so status_code (and other response attrs) were never set in case of an exception.

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("?")):
Expand All @@ -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)
lzchen marked this conversation as resolved.
Show resolved Hide resolved
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():
Expand All @@ -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
11 changes: 10 additions & 1 deletion instrumentation/opentelemetry-instrumentation-django/tests/test_middleware.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/",
}
)
Expand Down
3 changes: 3 additions & 0 deletions instrumentation/opentelemetry-instrumentation-flask/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down