]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/dev/perf_counters: update docs to include more context about perf counter usage 42402/head
authorLaura Flores <lflores@redhat.com>
Mon, 19 Jul 2021 17:17:58 +0000 (17:17 +0000)
committerLaura Flores <lflores@redhat.com>
Mon, 19 Jul 2021 19:07:39 +0000 (19:07 +0000)
The Perf Counters docs, although informative, are lacking for users and developers who are wondering what they can do with their perf counter data. I wrote an extra paragraph here that outlines some ways in which the counters can be used, including diagnosing problems in a cluster and identifying workload patterns.

Signed-off-by: Laura Flores <lflores@redhat.com>
doc/dev/perf_counters.rst

index ce2fdea31b88a19446173c72c3b8380c76500633..747b4680bb73d43dcb00e1efdc6f2a9c35ea2ac9 100644 (file)
@@ -2,9 +2,13 @@
  Perf counters
 ===============
 
-The perf counters provide generic internal infrastructure for gauges and counters.  The counted values can be both integer and float.  There is also an "average" type (normally float) that combines a sum and num counter which can be divided to provide an average.
+The perf counters provide generic internal infrastructure for gauges and counters.  The counted values can be both integer and float. There is also an "average" type (normally float) that combines a sum and num counter which can be divided to provide an average.
 
-The intention is that this data will be collected and aggregated by a tool like ``collectd`` or ``statsd`` and fed into a tool like ``graphite`` for graphing and analysis.  Also, note the :doc:`../mgr/prometheus`.
+The intention is that this data will be collected and aggregated by a tool like ``collectd`` or ``statsd`` and fed into a tool like ``graphite`` for graphing and analysis.  Also, note the :doc:`../mgr/prometheus` and the :doc:`../mgr/telemetry`.
+
+Users and developers can also access perf counter data locally to check a cluster's overall health, identify workload patterns, monitor cluster performance by daemon types, and troubleshoot issues with latency, throttling, memory management, etc. (see :ref:`Access`)
+
+.. _Access:
 
 Access
 ------