import ceph quincy 17.2.4

[ceph.git] / ceph / doc / mgr / dashboard_plugins / debug.inc.rst

.. _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:

.. prompt:: bash $

   ceph dashboard debug status

::

  Debug: 'disabled'

.. prompt:: bash $

   ceph dashboard debug enable

::

  Debug: 'enabled'

.. prompt:: bash $

   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
<https://docs.cherrypy.org/en/latest/config.html#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.