From 61e4508ca43fa6c9c65aa5543d848a6bee92b700 Mon Sep 17 00:00:00 2001 From: Enno G Date: Fri, 20 Mar 2020 09:19:01 +0100 Subject: [PATCH] doc: Add information on how to enable the rbd-images dashboard Fixes: https://tracker.ceph.com/issues/44623 Signed-off-by: Enno Gotthold In the previous commit (1c52ee2b) the added dashboard will stay empty until it is manually enabled to display information. (cherry picked from commit 6386095e51a1d58fa0093d37b26df25c524b72bc) Conflicts: doc/cephadm/monitoring.rst - Delete (file doesn't exist in nautilus) --- doc/mgr/prometheus.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/doc/mgr/prometheus.rst b/doc/mgr/prometheus.rst index e01196bb0ced4..49c8b24285123 100644 --- a/doc/mgr/prometheus.rst +++ b/doc/mgr/prometheus.rst @@ -31,6 +31,8 @@ configurable with ``ceph config-key set``, with keys ``mgr/prometheus/server_addr`` and ``mgr/prometheus/server_port``. This port is registered with Prometheus's `registry `_. +.. _prometheus-rbd-io-statistics: + RBD IO statistics ----------------- @@ -41,6 +43,10 @@ configuration parameter. The parameter is a comma or space separated list of ``pool[/namespace]`` entries. If the namespace is not specified the statistics are collected for all namespaces in the pool. +Example to enable the images ``image1``, ``image2`` and ``imageN``:: + + ceph config set mgr mgr/prometheus/rbd_stats_pools "image1,image2,imageN" + The module makes the list of all available images scanning the specified pools and namespaces and refreshes it periodically. The period is configurable via the ``mgr/prometheus/rbd_stats_pools_refresh_interval`` @@ -48,6 +54,10 @@ parameter (in sec) and is 300 sec (5 minutes) by default. The module will force refresh earlier if it detects statistics from a previously unknown RBD image. +Example to turn up the sync interval to 10 minutes:: + + ceph config set mgr mgr/prometheus/rbd_stats_pools_refresh_interval 600 + Statistic names and labels ========================== -- 2.39.5