From 1ba15aab0c8729cd7e9aa44433ba41cf6df62f48 Mon Sep 17 00:00:00 2001 From: Shraddha Agrawal Date: Thu, 21 Aug 2025 18:08:18 +0530 Subject: [PATCH] doc: add config option and usage docs This commit adds docs for the new config option introduced as well as updates the feature docs on how to use this config option. Fixes: https://tracker.ceph.com/issues/72619 Signed-off-by: Shraddha Agrawal (cherry picked from commit 1cbe41bde12eb1d0437b746164edb689393cc5ad) --- PendingReleaseNotes | 8 +++++--- doc/rados/configuration/mon-config-ref.rst | 1 + doc/rados/operations/monitoring.rst | 17 +++++++++++++---- 3 files changed, 19 insertions(+), 7 deletions(-) diff --git a/PendingReleaseNotes b/PendingReleaseNotes index c2a33ef21e16e..a3b50e2984da9 100644 --- a/PendingReleaseNotes +++ b/PendingReleaseNotes @@ -161,9 +161,11 @@ users to view the availability score for each pool in a cluster. A pool is considered unavailable if any PG in the pool is not in active state or if there are unfound objects. Otherwise the pool is considered available. The score is updated every - 5 seconds. The feature is on by default. A new config option ``enable_availability_tracking`` - can be used to turn off the feature if required. Another command is added to clear the - availability status for a specific pool, ``ceph osd pool clear-availability-status ``. + one second by default. This interval can be changed using the new config option + ``pool_availability_update_interval.``. The feature is on by default. A new config option + ``enable_availability_tracking`` can be used to turn off the feature if required. + Another command is added to clear the availability status for a specific pool, + ``ceph osd pool clear-availability-status ``. This feature is in tech preview. Related trackers: - https://tracker.ceph.com/issues/67777 diff --git a/doc/rados/configuration/mon-config-ref.rst b/doc/rados/configuration/mon-config-ref.rst index a432d83501643..c0d2ad5316dfb 100644 --- a/doc/rados/configuration/mon-config-ref.rst +++ b/doc/rados/configuration/mon-config-ref.rst @@ -628,6 +628,7 @@ Miscellaneous .. confval:: mon_memory_target .. confval:: mon_memory_autotune .. confval:: enable_availability_tracking +.. confval:: pool_availability_update_interval NVMe-oF Monitor Client ====================== diff --git a/doc/rados/operations/monitoring.rst b/doc/rados/operations/monitoring.rst index 90d5fc90a7df2..2e3294a955f8c 100644 --- a/doc/rados/operations/monitoring.rst +++ b/doc/rados/operations/monitoring.rst @@ -781,10 +781,19 @@ the Mean Time Between Failures (MTBF) and Mean Time To Recover (MTTR) for each pool. The availability score is then calculated by finding the ratio of MTBF to the total time. -The score is updated every five seconds. This interval is currently -not configurable. Any intermittent changes to the pools that -occur between this duration but are reset before we recheck the pool -status will not be captured by this feature. +The score is updated every one second. Transient changes to pools that +occur and are reverted between successive updates will not be captured. +It is possible to configure this interval with a command of the following +form: + +.. prompt:: bash $ + + ceph config set mon pool_availability_update_interval 2 + +This will set the update interval to two seconds. Please note that +it is not possible to set this interval less than the config value set +for ``paxos_propose_interval``. + This feature is on by default. To turn the feature off, e.g. - for an expected downtime, the ``enable_availability_tracking`` config option can be set to ``false``. -- 2.39.5