RepoMirrors/ceph
1
0
Fork 0
mirror of https://github.com/ceph/ceph synced 2025-04-01 00:26:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: Add information on how to enable the rbd-images dashboard

Browse Source 
Fixes: https://tracker.ceph.com/issues/44623
Signed-off-by: Enno Gotthold <egotthold@suse.de>

In the previous commit (1c52ee2b) the added dashboard will stay empty
until it is manually enabled to display information.
This commit is contained in:
Enno G 2020-03-20 09:19:01 +01:00 committed by Enno Gotthold
parent 9707cb30cb
commit 6386095e51
No known key found for this signature in database
GPG Key ID: 18569829AD881702
2 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/cephadm/monitoring.rst
View File

@ -70,3 +70,10 @@ cluster.
* To enable the dashboard's prometheus-based alerting, see :ref:`dashboard-alerting`.
* To enable dashboard integration with Grafana, see :ref:`dashboard-grafana`.
Enabling RBD-Image monitoring
---------------------------------
Due to performance reasons, monitoring of RBD images is disabled by default. For more information please see
:ref:`prometheus-rbd-io-statistics`. If disabled, the overview and details dashboards will stay empty in Grafana
and the metrics will not be visible in Prometheus.

10
doc/mgr/prometheus.rst
View File

@ -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 <https://github.com/prometheus/prometheus/wiki/Default-port-allocations>`_.
.. _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
==========================