ceph/doc/mgr/dashboard_plugins/debug.inc.rst

   1 .. _dashboard-debug:
   2
   3 Debug
   4 ^^^^^
   5
   6 This plugin allows to customize the behaviour of the dashboard according to the
   7 debug mode. It can be enabled, disabled or checked with the following command::
   8
   9   $ ceph dashboard debug status
  10   Debug: 'disabled'
  11   $ ceph dashboard debug enable
  12   Debug: 'enabled'
  13   $ ceph dashboard debug disable
  14   Debug: 'disabled'
  15
  16 By default, it's disabled. This is the recommended setting for production
  17 deployments. If required, debug mode can be enabled without need of restarting.
  18 Currently, disabled debug mode equals to CherryPy ``production`` environment,
  19 while when enabled, it uses ``test_suite`` defaults (please refer to
  20 `CherryPy Environments
  21 <https://docs.cherrypy.org/en/latest/config.html#environments>`_ for more
  22 details).
  23
  24 It also adds request uuid (``unique_id``) to Cherrypy on versions that don't
  25 support this. It additionally prints the ``unique_id`` to error responses and
  26 log messages.