Skip to content

Use django-debug-toolbar cache backend to share data across workers #13087

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

Open
agjohnson wants to merge 1 commit into
base: main
Choose a base branch
from
+5 −8
Open

Use django-debug-toolbar cache backend to share data across workers #13087

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 5 additions & 8 deletions readthedocs/settings/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,17 +64,14 @@ def _show_debug_toolbar(request):

return {
"SHOW_TOOLBAR_CALLBACK": _show_debug_toolbar,
"DISABLE_PANELS": [
# Default ones
"DISABLE_PANELS": {
# Default panels that are normally disabled
"debug_toolbar.panels.profiling.ProfilingPanel",
"debug_toolbar.panels.redirects.RedirectsPanel",
# Custome ones
# We are disabling these because they take a lot of time to execute in the new dashboard.
# We make an intensive usage of the ``include`` template tag there.
# It's a "known issue/bug" and there is no solution as far as we can tell.
# Panels that are slow
"debug_toolbar.panels.sql.SQLPanel",
"debug_toolbar.panels.templates.TemplatesPanel",
Copy link
Copy Markdown
Member

@stsewd stsewd Jun 2, 2026

Choose a reason for hiding this comment

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

Is this just unchecking the panel by default or is it removing it?

Copy link
Copy Markdown
Member

@humitos humitos Jun 2, 2026

Choose a reason for hiding this comment

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

We are re-enabling it now. @agjohnson is that what we want here? why did you change this config? does it work reliably now?

Copy link
Copy Markdown
Member

@humitos humitos Jun 2, 2026

Choose a reason for hiding this comment

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

@stsewd only disables it by default. You have to click on it to enable it.

Copy link
Copy Markdown
Contributor Author

@agjohnson agjohnson Jun 2, 2026

Choose a reason for hiding this comment

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

I don't trust the comment in settings is at all accurate. The templates pane works fine and I'm fixing up debug toolbar specifically for that pane. It's much better than trying to guess what templates are used by deciphering HTML.

Copy link
Copy Markdown
Member

@humitos humitos Jun 2, 2026

Choose a reason for hiding this comment

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

I remember having a bunch of issues with that pane and disabling it worked.

I'm fine re-enabling it if it works, but honestly, I don't think it has to be enabled by default. 99% of the time we don't look at that pane. Also, once you enable it locally it saves a cookie in your browser, so it will be enabled by default for you.

I'd prefer to keep it disabled by default.

Copy link
Copy Markdown
Contributor Author

@agjohnson agjohnson Jun 2, 2026

Choose a reason for hiding this comment

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

Yes, the pane works fine for me. If you don't recall the errors that you've hit, I think it's safe to just keep it enabled.

The only error I've encountered is the error fixed by this PR. I was using the single worker fix for months prior to this to use the toolbar.

I mostly want to make this more usable. After watching Eric struggle to debug templates, it's pretty clear this needs to be a more obvious it's part of our development workflow.

],
},
"TOOLBAR_STORE_CLASS": "debug_toolbar.store.CacheStore",
}

@property
Expand Down