RepoMirrors/ceph
1
0
Fork 0
mirror of https://github.com/ceph/ceph synced 2024-12-23 11:54:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc/mgr/prometheus: use confval directive to define options

Browse Source 
less repeating this way.

Signed-off-by: Kefu Chai <kchai@redhat.com>
This commit is contained in:
Kefu Chai 2021-05-10 11:45:34 +08:00
parent 80eb4f42fb
commit f2750a7912
1 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/mgr/prometheus.rst
View 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