projects / ceph.git / blame
| Commit | Line | Data |
|---|---|---|
| 20effc67 TL |
1 | Progress Module |
| 2 | =============== | |
| 3 | ||
| 4 | The progress module is used to inform users about the recovery progress of PGs | |
| 5 | (Placement Groups) that are affected by events such as (1) OSDs being marked | |
| 6 | in or out and (2) ``pg_autoscaler`` trying to match the target PG number. | |
| 7 | ||
| 8 | The ``ceph -s`` command returns something called " Global Recovery Progress", | |
| 9 | which reports the overall recovery progress of PGs and is based on the number | |
| 10 | of PGs that are in the ``active+clean`` state. | |
| 11 | ||
| 12 | Enabling | |
| 13 | -------- | |
| 14 | ||
| 15 | The *progress* module is enabled by default, but it can be enabled manually by | |
| 16 | running the following command: | |
| 17 | ||
| 18 | .. prompt:: bash # | |
| 19 | ||
| 20 | ceph progress on | |
| 21 | ||
| 22 | The module can be disabled at anytime by running the following command: | |
| 23 | ||
| 24 | .. prompt:: bash # | |
| 25 | ||
| 26 | ceph progress off | |
| 27 | ||
| 28 | Commands | |
| 29 | -------- | |
| 30 | ||
| 31 | Show the summary of all the ongoing and completed events and their duration: | |
| 32 | ||
| 33 | .. prompt:: bash # | |
| 34 | ||
| 35 | ceph progress | |
| 36 | ||
| 37 | Show the summary of ongoing and completed events in JSON format: | |
| 38 | ||
| 39 | .. prompt:: bash # | |
| 40 | ||
| 41 | ceph progress json | |
| 42 | ||
| 43 | Clear all ongoing and completed events: | |
| 44 | ||
| 45 | .. prompt:: bash # | |
| 46 | ||
| 47 | ceph progress clear | |
| 48 | ||
| 49 | PG Recovery Event | |
| 50 | ----------------- | |
| 51 | ||
| 52 | An event for each PG affected by recovery event can be shown in | |
| 53 | `ceph progress` This is completely optional, and disabled by default | |
| 54 | due to CPU overheard: | |
| 55 | ||
| 56 | .. prompt:: bash # | |
| 57 | ||
| 58 | ceph config set mgr mgr/progress/allow_pg_recovery_event true |