Document panel instrumentation behavior for production deployments - #2405
Open
onxxdatas wants to merge 4 commits into
Open
Document panel instrumentation behavior for production deployments#2405onxxdatas wants to merge 4 commits into
onxxdatas wants to merge 4 commits into
Conversation
Coverage report
This PR does not seem to contain any modification to coverable code. |
Contributor
Author
|
@tim-schilling Hey how are you, Can you review this PR, I think this is ready-to-merge already |
Member
|
@onxxdatas this is going to be a bit before I get to it. You're jumping ahead a bit here by starting with the PR. We should review that audit summary and discuss it first. |
Contributor
Author
yeah that makes sense, i'll pull my findings out and post the audit summary as a comment on the issue so it's easier to discuss |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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
This PR adds a new Production documentation page that audits the behavior of each built-in Django Debug Toolbar panel when the toolbar is installed but not displayed via SHOW_TOOLBAR_CALLBACK.
The documentation includes:
An overview of when instrumentation is installed (ready(), module import, or enable_instrumentation()).
Whether each panel's instrumentation can be fully avoided without removing it from DEBUG_TOOLBAR_PANELS.
Whether each panel monkey-patches Django or other components.
Recommendations for using Django Debug Toolbar in production-like environments.
An example configuration for excluding panels that install permanent instrumentation.
This also adds the new documentation page to the documentation index.
Closes #2203.