opentelemetry-instrumentation-django: improve docs for response_hook with examples of providing attributes from middlewares #3923
+73 −3
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
| * `Django Response object <https://docs.djangoproject.com/en/5.2/ref/request-response/#httpresponse-objects>`_ | ||
| Adding attributes from middleware context | ||
| ******************************************************************************** |
Contributor
There was a problem hiding this comment.
Thank you for this helpful update!
Would it make sense to have this and the other new sections be subsections under Request and Response hooks? so e.g.
Suggested change
| ******************************************************************************** | |
| ################################################################################ |
Contributor
There was a problem hiding this comment.
This should be as long as the title, also the other titles have the same issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
Description
Suggested documentation updates:
request_hookruns,so attributes like
request.userorrequest.siteare unavailable there.enduser.id,enduser.username,site.idandsite.domaininresponse_hook.Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
tox -e docsDoes This PR Require a Core Repo Change?
Checklist:
See contributing.md for styleguide, changelog guidelines, and more.