From bcf487a350e341c023783d02bf12ee912487d4de Mon Sep 17 00:00:00 2001 From: Yaarit Hatuka Date: Thu, 6 Feb 2020 12:50:42 -0500 Subject: [PATCH] doc/mgr/telemetry: added device channel details Plus details about license agreement. Fixes: https://tracker.ceph.com/issues/43648 Signed-off-by: Yaarit Hatuka (cherry picked from commit 66c41f3d0e516e217dc89ab20c53563ea10f97f7) --- doc/mgr/telemetry.rst | 36 ++++++++++++++++++++++++++++++++---- 1 file changed, 32 insertions(+), 4 deletions(-) diff --git a/doc/mgr/telemetry.rst b/doc/mgr/telemetry.rst index e994d18105340..c0f56dde3c4e9 100644 --- a/doc/mgr/telemetry.rst +++ b/doc/mgr/telemetry.rst @@ -31,14 +31,19 @@ the per-channel setting has no effect.) - operating system (OS distribution, kernel version) - stack trace identifying where in the Ceph code the crash occurred -* **ident** (default: on): User-provided identifying information about +* **device** (default: on): Information about device metrics, including + + - anonymized SMART metrics + +* **ident** (default: off): User-provided identifying information about the cluster - cluster description - contact email address The data being reported does *not* contain any sensitive -data like pool names, object names, object contents, or hostnames. +data like pool names, object names, object contents, hostnames, or device +serial numbers. It contains counters and statistics on how the cluster has been deployed, the version of Ceph, the distribition of the hosts and other @@ -63,6 +68,15 @@ You can look at what data is reported at any time with the command:: ceph telemetry show +To protect your privacy, device reports are generated separately, and data such +as hostname and device serial number is anonymized. The device telemetry is +sent to a different endpoint and does not associate the device data with a +particular cluster. To see a preview of the device report use the command:: + + ceph telemetry show-device + +Please note: In order to generate the device report we use Smartmontools +version 7.0 and up, which supports JSON output. If you have any concerns about privacy with regard to the information included in this report, please contact the Ceph developers. @@ -74,15 +88,22 @@ Individual channels can be enabled or disabled with:: ceph config set mgr mgr/telemetry/channel_ident false 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 telemetry show + ceph telemetry show-device Enabling Telemetry ------------------ -To allow the *telemetry* module to start sharing data,:: +To allow the *telemetry* module to start sharing data:: ceph telemetry on +Please note: Telemetry data is licensed under the Community Data License +Agreement - Sharing - Version 1.0 (https://cdla.io/sharing-1-0/). Hence, +telemetry module can be enabled only after you add '--license sharing-1-0' to +the 'ceph telemetry on' command. + Telemetry can be disabled at any time with:: ceph telemetry off @@ -95,6 +116,13 @@ You can adjust this interval with:: ceph config set mgr mgr/telemetry/interval 72 # report every three days +Status +-------- + +The see the current configuration:: + + ceph telemetry status + Sending telemetry through a proxy --------------------------------- @@ -108,6 +136,7 @@ You can also include a *user:pass* if needed:: ceph config set mgr mgr/telemetry/proxy https://ceph:telemetry@10.0.0.1:8080 + Contact and Description ----------------------- @@ -117,4 +146,3 @@ completely optional, and disabled by default.:: ceph config set mgr mgr/telemetry/contact 'John Doe ' ceph config set mgr mgr/telemetry/description 'My first Ceph cluster' ceph config set mgr mgr/telemetry/channel_ident true - -- 2.39.5