From f318eed2a4ccae2d561f2b63312f0c99ccf7413f Mon Sep 17 00:00:00 2001 From: Laura Flores Date: Tue, 13 Jul 2021 20:44:44 +0000 Subject: [PATCH] doc/mgr/telemetry: update Telemetry Module docs to include perf channel PR #42074 adds a new perf channel to the Telemetry Module. With this commit, the docs will reflect that addition. Within the Telemetry Module docs, I explain the purpose of the new perf channel as well as some use cases of the metrics that will be collected under the channel. Signed-off-by: Laura Flores --- doc/mgr/telemetry.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/doc/mgr/telemetry.rst b/doc/mgr/telemetry.rst index 6eaaa5c44923..bdc8dde83f2b 100644 --- a/doc/mgr/telemetry.rst +++ b/doc/mgr/telemetry.rst @@ -46,6 +46,12 @@ the per-channel setting has no effect.) - cluster description - contact email address +* **perf** (default: off): Aggregated performance counter metrics of a cluster, which can be used to + - reveal overall cluster health + - identify workload patterns + - troubleshoot issues with latency, throttling, memory management, etc. + - monitor cluster performance by daemon types + The data being reported does *not* contain any sensitive data like pool names, object names, object contents, hostnames, or device serial numbers. @@ -85,6 +91,7 @@ Individual channels can be enabled or disabled with:: ceph config set mgr mgr/telemetry/channel_basic false ceph config set mgr mgr/telemetry/channel_crash false ceph config set mgr mgr/telemetry/channel_device false + ceph config set mgr mgr/telemetry/channel_perf false ceph telemetry show ceph telemetry show-device -- 2.47.3