From f2750a7912a3af22ad35e223006827f2871903c4 Mon Sep 17 00:00:00 2001 From: Kefu Chai Date: Mon, 10 May 2021 11:45:34 +0800 Subject: [PATCH] doc/mgr/prometheus: use confval directive to define options less repeating this way. Signed-off-by: Kefu Chai --- doc/mgr/prometheus.rst | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/doc/mgr/prometheus.rst b/doc/mgr/prometheus.rst index 2c0fff5dcf7..1c52b248afb 100644 --- a/doc/mgr/prometheus.rst +++ b/doc/mgr/prometheus.rst @@ -29,6 +29,14 @@ Configuration The Prometheus manager module needs to be restarted for configuration changes to be applied. +.. mgr_module:: prometheus +.. confval:: server_addr +.. confval:: server_port +.. confval:: scrape_interval +.. confval:: stale_cache_strategy +.. confval:: rbd_stats_pools +.. confval:: rbd_stats_pools_refresh_interval + By default the module will accept HTTP requests on port ``9283`` on all IPv4 and IPv6 addresses on the host. The port and listen address are both configurable with ``ceph config set``, with keys @@ -43,11 +51,10 @@ is registered with Prometheus's `registry .. warning:: - The ``scrape_interval`` of this module should always be set to match + The :confval:`mgr/prometheus/scrape_interval` of this module should always be set to match Prometheus' scrape interval to work properly and not cause any issues. -The Prometheus manager module is, by default, configured with a scrape interval -of 15 seconds. The scrape interval in the module is used for caching purposes +The scrape interval in the module is used for caching purposes and to determine when a cache is stale. It is not recommended to use a scrape interval below 10 seconds. It is