]> git-server-git.apps.pok.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/mgr: point users at ceph-exporter for daemon metrics 70866/head
authorEmmanuel Ameh <eameh@contractor.linuxfoundation.org>
Wed, 5 Aug 2026 22:14:37 +0000 (23:14 +0100)
committerEmmanuel Ameh <eameh@contractor.linuxfoundation.org>
Wed, 5 Aug 2026 22:14:37 +0000 (23:14 +0100)
The prometheus module page buried the fact that daemon perf counters
are now exported by ceph-exporter. Add a prominent note up top, and
name the CLICommand decorator as the replacement for the deprecated
handle_command mechanism in modules.rst.

Fixes: https://tracker.ceph.com/issues/77190
Signed-off-by: Emmanuel Ameh <eameh@contractor.linuxfoundation.org>
doc/mgr/modules.rst
doc/mgr/prometheus.rst

index 1e2976074d4a1e151ba5b28c16e810c9d32a9cbf..8e13feb70495aca066767002f57e351cd975d61b 100644 (file)
@@ -23,7 +23,9 @@ The most important methods to override are:
   take action when new cluster data is available.
 * a ``handle_command`` member function if your module
   exposes CLI commands. But this approach for exposing commands
-  is deprecated. For more details, see :ref:`mgr-module-exposing-commands`.
+  is deprecated: new modules should register commands with the
+  ``CLICommand`` decorator instead. For details on both approaches,
+  see :ref:`mgr-module-exposing-commands`.
 
 Some modules interface with external orchestrators to deploy
 Ceph services.  These also inherit from ``Orchestrator``, which adds
index d19de71a08ffda472f8d9215fe9c7a82eddafc5a..f8067998a61be5dd102fe20a2eb4106c57c472f0 100644 (file)
@@ -15,6 +15,16 @@ counters for all reporting entities are returned in the Prometheus exposition
 format.  (See the Prometheus `documentation
 <https://prometheus.io/docs/instrumenting/exposition_formats/#text-format-details>`_.)
 
+.. note:: Ceph daemon performance counters are no longer exported by
+   this module by default. That job has moved to the ``ceph-exporter``
+   daemon, which cephadm deploys on every host and which reads the
+   counters directly from the local daemon admin sockets. The
+   ``prometheus`` module continues to provide cluster-level metrics,
+   the service discovery endpoint, and RBD image metrics. See
+   :ref:`monitoring` for an overview of the monitoring stack and
+   `Ceph daemon performance counters metrics`_ below for how to
+   re-enable the old behavior.
+
 Enabling Prometheus output
 ==========================