From 928bb30952e71bcbd12648f4d53b52b652b9cdad Mon Sep 17 00:00:00 2001 From: Ernesto Puerta Date: Thu, 10 Oct 2019 11:25:49 +0200 Subject: [PATCH] doc: new Dashboard Plugin: Debug Fixes: https://tracker.ceph.com/issues/41990 Signed-off-by: Ernesto Puerta --- doc/mgr/dashboard.rst | 5 +++-- doc/mgr/dashboard_plugins/debug.inc.rst | 26 +++++++++++++++++++++++++ src/pybind/mgr/dashboard/HACKING.rst | 2 +- 3 files changed, 30 insertions(+), 3 deletions(-) create mode 100644 doc/mgr/dashboard_plugins/debug.inc.rst diff --git a/doc/mgr/dashboard.rst b/doc/mgr/dashboard.rst index e2cae32bc5c97..1a7cc31ce3fa5 100644 --- a/doc/mgr/dashboard.rst +++ b/doc/mgr/dashboard.rst @@ -968,7 +968,8 @@ Web UI will automatically allow to choose to which cluster an export belongs. Plug-ins -------- -Dashboard Plug-ins allow to extend the functionality of the dashboard in a modular -and loosely coupled approach. +Dashboard Plug-ins extend the functionality of the dashboard in a modular +and loosely coupled fashion. .. include:: dashboard_plugins/feature_toggles.inc.rst +.. include:: dashboard_plugins/debug.inc.rst diff --git a/doc/mgr/dashboard_plugins/debug.inc.rst b/doc/mgr/dashboard_plugins/debug.inc.rst new file mode 100644 index 0000000000000..e11137cd258df --- /dev/null +++ b/doc/mgr/dashboard_plugins/debug.inc.rst @@ -0,0 +1,26 @@ +.. _dashboard-debug: + +Debug +^^^^^ + +This plugin allows to customize the behaviour of the dashboard according to the +debug mode. It can be enabled, disabled or checked with the following command:: + + $ ceph dashboard debug status + Debug: 'disabled' + $ ceph dashboard debug enable + Debug: 'enabled' + $ ceph dashboard debug disable + Debug: 'disabled' + +By default, it's disabled. This is the recommended setting for production +deployments. If required, debug mode can be enabled without need of restarting. +Currently, disabled debug mode equals to CherryPy ``production`` environment, +while when enabled, it uses ``test_suite`` defaults (please refer to +`CherryPy Environments +`_ for more +details). + +It also adds request uuid (``unique_id``) to Cherrypy on versions that don't +support this. It additionally prints the ``unique_id`` to error responses and +log messages. diff --git a/src/pybind/mgr/dashboard/HACKING.rst b/src/pybind/mgr/dashboard/HACKING.rst index 56763d999cb30..211e2e7ffc087 100644 --- a/src/pybind/mgr/dashboard/HACKING.rst +++ b/src/pybind/mgr/dashboard/HACKING.rst @@ -1876,7 +1876,7 @@ The available Interfaces are: - ``FilterRequest.BeforeHandler``: requires overriding ``filter_request_before_handler()`` hook. This method receives a ``cherrypy.request`` object for processing. A usual implementation of this - method will allow some requests to pass or will raise a ``cherrypy.HTTPError` + method will allow some requests to pass or will raise a ``cherrypy.HTTPError`` based on the ``request`` metadata and other conditions. New interfaces and hooks should be added as soon as they are required to -- 2.39.5