ceph/doc/mgr/progress.rst
Kamoltat f06da20dff pybind/mgr/progress: disable pg recovery event by default
The progress module disabled the pg recovery event by default
since the event is expensive and has interrupted other serviceis
when there is OSDs being marked in/out from the the cluster.

To turn the event on manually:

ceph config set mgr mgr/progress/allow_pg_recovery_event true

Updated qa/tasks/mgr/test_progress.py to enable
the pg recovery event when testing the progress module.

Signed-off-by: Kamoltat <ksirivad@redhat.com>
2022-02-03 17:51:42 +00:00

59 lines
1.3 KiB
ReStructuredText

Progress Module
===============
The progress module is used to inform users about the recovery progress of PGs
(Placement Groups) that are affected by events such as (1) OSDs being marked
in or out and (2) ``pg_autoscaler`` trying to match the target PG number.
The ``ceph -s`` command returns something called " Global Recovery Progress",
which reports the overall recovery progress of PGs and is based on the number
of PGs that are in the ``active+clean`` state.
Enabling
--------
The *progress* module is enabled by default, but it can be enabled manually by
running the following command:
.. prompt:: bash #
ceph progress on
The module can be disabled at anytime by running the following command:
.. prompt:: bash #
ceph progress off
Commands
--------
Show the summary of all the ongoing and completed events and their duration:
.. prompt:: bash #
ceph progress
Show the summary of ongoing and completed events in JSON format:
.. prompt:: bash #
ceph progress json
Clear all ongoing and completed events:
.. prompt:: bash #
ceph progress clear
PG Recovery Event
-----------------
An event for each PG affected by recovery event can be shown in
`ceph progress` This is completely optional, and disabled by default
due to CPU overheard:
.. prompt:: bash #
ceph config set mgr mgr/progress/allow_pg_recovery_event true