]> git-server-git.apps.pok.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/mgr/prometheus: use confval directive to define options 41245/head
authorKefu Chai <kchai@redhat.com>
Mon, 10 May 2021 03:45:34 +0000 (11:45 +0800)
committerKefu Chai <kchai@redhat.com>
Tue, 11 May 2021 08:05:04 +0000 (16:05 +0800)
less repeating this way.

Signed-off-by: Kefu Chai <kchai@redhat.com>
doc/mgr/prometheus.rst

index 2c0fff5dcf7d87ed964943ae6db96b6b2c7c668e..1c52b248afb25ce758761147edb767aa54327f53 100644 (file)
@@ -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