]> git.proxmox.com Git - ceph.git/blobdiff - ceph/doc/dev/perf_counters.rst
import quincy beta 17.1.0
[ceph.git] / ceph / doc / dev / perf_counters.rst
index 2f49f772fb846f777afe9a8bdc2e56da97d83e8a..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
 ------
@@ -60,7 +64,7 @@ lifetime average value.  Normally these are used to measure latencies
 for the previous interval is what is interesting.
 
 Instead of interpreting the bit fields, the ``metric type`` has a
-value of either ``guage`` or ``counter``, and the ``value type``
+value of either ``gauge`` or ``counter``, and the ``value type``
 property will be one of ``real``, ``integer``, ``real-integer-pair``
 (for a sum + real count pair), or ``integer-integer-pair`` (for a
 sum + integer count pair).