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

Jump to bottom

Add capture of http.route to DjangoInstrumentor middleware #1226

Merged
merged 17 commits into from
Oct 15, 2020
Merged

Add capture of http.route to DjangoInstrumentor middleware #1226

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
12da4f6
Add capture of http.route to DjangoInstrumentor middleware
stschenk Oct 8, 2020
7362f73
Update changelog
stschenk Oct 8, 2020
e3979de
Fix lint error
stschenk Oct 8, 2020
f070259
Switch from using hidden _func_path property to calculating the funct…
stschenk Oct 8, 2020
9190a7d
Update instrumentation/opentelemetry-instrumentation-django/CHANGELOG.md
stschenk Oct 12, 2020
5f7927b
Switch to using request.resolver_match.route for http.route
stschenk Oct 12, 2020
d919de2
Switch to using request.path for http.route
stschenk Oct 12, 2020
3bd216d
capture request.resolver_match.route as http.route
stschenk Oct 13, 2020
a5889bb
add test for templated route
stschenk Oct 13, 2020
aa4e35b
switch http.path to http.target
stschenk Oct 13, 2020
afadb66
fix lint issue
stschenk Oct 13, 2020
ad9dfa5
Merge branch 'master' into add_http.route_capture_to_DjangoInstrumentor
owais Oct 14, 2020
7348240
remove setting of http.target, it is handled elsewhere
stschenk Oct 14, 2020
9170599
Merge branch 'add_http.route_capture_to_DjangoInstrumentor' of https:…
stschenk Oct 14, 2020
b65e384
Merge branch 'master' into add_http.route_capture_to_DjangoInstrumentor
lzchen Oct 14, 2020
3f93411
Merge branch 'master' into add_http.route_capture_to_DjangoInstrumentor
owais Oct 14, 2020
6a5c07f
Merge branch 'master' into add_http.route_capture_to_DjangoInstrumentor
Oct 15, 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
1 change: 1 addition & 0 deletions instrumentation/opentelemetry-instrumentation-django/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

- Changed span name extraction from request to comply semantic convention ([#992](https://github.com/open-telemetry/opentelemetry-python/pull/992))
- Added support for `OTEL_PYTHON_DJANGO_TRACED_REQUEST_ATTRS` ([#1154](https://github.com/open-telemetry/opentelemetry-python/pull/1154))
- Added capture of http.route ([#1226](https://github.com/open-telemetry/opentelemetry-python/issues/1226))

## Version 0.13b0

Expand Down
21 changes: 21 additions & 0 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 @@ -117,6 +117,7 @@ def process_request(self, request):
)
for key, value in attributes.items():
span.set_attribute(key, value)
span.set_attribute("http.path", request.path)
Copy link
Contributor

Choose a reason for hiding this comment

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

This should be http.target according to the spec. https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/trace/semantic_conventions/http.md#common-attributes

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sound good.

Copy link
Contributor

Choose a reason for hiding this comment

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

Isn't http.target already being populated in collect_request_attributes?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good point @lzchen! I will remove the setting of the attribute from the django middleware.


activation = tracer.use_span(span, end_on_exit=True)
activation.__enter__()
Expand All @@ -125,6 +126,26 @@ def process_request(self, request):
request.META[self._environ_span_key] = span
request.META[self._environ_token] = token

def process_view(self, request, view_func, *args, **kwargs):
# Process view is executed before the view function, here we get the
# route template from request.resolver_match. It is not set yet in process_request
if self._excluded_urls.url_disabled(request.build_absolute_uri("?")):
return

if (
self._environ_activation_key in request.META.keys()
and self._environ_span_key in request.META.keys()
):
span = request.META[self._environ_span_key]

if span.is_recording():
if getattr(request, "resolver_match") and getattr(
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: hasattr might be better for this if we aren't using the return val directly.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I used getattr because I also don't want to capture the value if it is None.

Copy link
Contributor

@owais owais Oct 13, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

match = getattr(request, "resolved_match")
if match:
    route = getattr(match, "route")
    if route:
        set_attribute()

Perhaps use this? I know it's usually not a big deal but we never know where the library will be used and better to reduce attribute look ups if we can in case the code ends up on a very hot path.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

makes sense... I have not thought about reducing attribute lookups before. Thanks!

request.resolver_match, "route"
):
span.set_attribute(
"http.route", request.resolver_match.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
Expand Down
3 changes: 3 additions & 0 deletions 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 @@ -85,6 +85,7 @@ def test_traced_get(self):
self.assertEqual(
span.attributes["http.url"], "http://testserver/traced/"
)
self.assertEqual(span.attributes["http.route"], "^traced/")
self.assertEqual(span.attributes["http.scheme"], "http")
self.assertEqual(span.attributes["http.status_code"], 200)
self.assertEqual(span.attributes["http.status_text"], "OK")
Expand Down Expand Up @@ -121,6 +122,7 @@ def test_traced_post(self):
self.assertEqual(
span.attributes["http.url"], "http://testserver/traced/"
)
self.assertEqual(span.attributes["http.route"], "^traced/")
Copy link
Contributor

Choose a reason for hiding this comment

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

would be nice to add a templated route so tests cover that and catch any regressions in future.

self.assertEqual(span.attributes["http.scheme"], "http")
self.assertEqual(span.attributes["http.status_code"], 200)
self.assertEqual(span.attributes["http.status_text"], "OK")
Expand All @@ -145,6 +147,7 @@ def test_error(self):
self.assertEqual(
span.attributes["http.url"], "http://testserver/error/"
)
self.assertEqual(span.attributes["http.route"], "^error/")
self.assertEqual(span.attributes["http.scheme"], "http")

@patch(
Expand Down