Remove the logging panel as discussed

Closes #1683, closes #1681, closes #1119, closes #906, closes #695.
django-commons · matthiask · Jan 20, 2023 · Jan 20, 2023 · Jan 20, 2023 · Jan 20, 2023
commit 580d5cd97ff93e37fd95a662897665d0e3edfbaf
diff --git a/debug_toolbar/panels/logging.py b/debug_toolbar/panels/logging.py
diff --git a/debug_toolbar/settings.py b/debug_toolbar/settings.py
@@ -1,3 +1,4 @@
+import warnings
 from functools import lru_cache
 
 from django.conf import settings
@@ -64,7 +65,6 @@ def get_config():
     "debug_toolbar.panels.templates.TemplatesPanel",
     "debug_toolbar.panels.cache.CachePanel",
     "debug_toolbar.panels.signals.SignalsPanel",
-    "debug_toolbar.panels.logging.LoggingPanel",
     "debug_toolbar.panels.redirects.RedirectsPanel",
     "debug_toolbar.panels.profiling.ProfilingPanel",
 ]
@@ -76,6 +76,14 @@ def get_panels():
         PANELS = list(settings.DEBUG_TOOLBAR_PANELS)
     except AttributeError:
         PANELS = PANELS_DEFAULTS
+
+    logging_panel = "debug_toolbar.panels.logging.LoggingPanel"
+    if logging_panel in PANELS:
+        PANELS = [panel for panel in PANELS if panel != logging_panel]
+        warnings.warn(
+            f"Please remove {logging_panel} from your DEBUG_TOOLBAR_PANELS setting.",
+            DeprecationWarning,
+        )
     return PANELS
 
 

diff --git a/debug_toolbar/templates/debug_toolbar/panels/logging.html b/debug_toolbar/templates/debug_toolbar/panels/logging.html
diff --git a/docs/changes.rst b/docs/changes.rst
@@ -9,6 +9,10 @@ Pending
 * Use ``TOOLBAR_LANGUAGE`` setting when rendering individual panels
   that are loaded via AJAX.
 * Add decorator for rendering toolbar views with ``TOOLBAR_LANGUAGE``.
+* Removed the logging panel. The panel's implementation was too complex, caused
+  memory leaks and sometimes very verbose and hard to silence output in some
+  environments (but not others). The maintainers judged that time and effort is
+  better invested elsewhere.
 
 3.8.1 (2022-12-03)
 ------------------

diff --git a/docs/configuration.rst b/docs/configuration.rst
@@ -31,7 +31,6 @@ default value is::
         'debug_toolbar.panels.templates.TemplatesPanel',
         'debug_toolbar.panels.cache.CachePanel',
         'debug_toolbar.panels.signals.SignalsPanel',
-        'debug_toolbar.panels.logging.LoggingPanel',
         'debug_toolbar.panels.redirects.RedirectsPanel',
         'debug_toolbar.panels.profiling.ProfilingPanel',
     ]

diff --git a/docs/panels.rst b/docs/panels.rst
@@ -97,13 +97,6 @@ Signal
 
 List of signals and receivers.
 
-Logging
-~~~~~~~
-
-.. class:: debug_toolbar.panels.logging.LoggingPanel
-
-Logging output via Python's built-in :mod:`logging` module.
-
 Redirects
 ~~~~~~~~~
 

diff --git a/tests/panels/test_history.py b/tests/panels/test_history.py
@@ -77,7 +77,6 @@ class HistoryViewsTestCase(IntegrationTestCase):
         "TemplatesPanel",
         "CachePanel",
         "SignalsPanel",
-        "LoggingPanel",
         "ProfilingPanel",
     }
 

diff --git a/tests/panels/test_logging.py b/tests/panels/test_logging.py