From: Sage Weil <sage@redhat.com>
Date: Fri, 1 Mar 2019 20:31:50 +0000 (-0600)
Subject: doc/mgr/telemtry: update docs
X-Git-Tag: v14.1.1~36^2~1
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=d14c909408a6bbddb87c2fa1efb4429cfb134a7a;p=ceph.git

doc/mgr/telemtry: update docs

- new commands
- more explicit summary of what we send
- multiple steps to enable, so that you can see what would be reported
  before opting in.

Signed-off-by: Sage Weil <sage@redhat.com>
---

diff --git a/doc/mgr/telemetry.rst b/doc/mgr/telemetry.rst
index 668e70fc7c29..2bd1edb09b37 100644
--- a/doc/mgr/telemetry.rst
+++ b/doc/mgr/telemetry.rst
@@ -1,12 +1,45 @@
+.. _telemetry:
+
 Telemetry Module
 ================
-The telemetry module sends anonymous data about the cluster, in which it is running, back to the Ceph project.
 
-The data being sent back to the project does not contain any sensitive data like pool names, object names, object contents or hostnames.
+The telemetry module sends anonymous data about the cluster back to the Ceph
+developers to help understand how Ceph is used and what problems users may
+be experiencing.
+
+Reported telemetry includes:
+
+  * capacity of the cluster 
+  * number of monitors, managers, OSDs, MDSs, radosgws, or other daemons
+  * software version currently being used
+  * number and types of RADOS pools and CephFS file systems
+  * information about daemon crashes, including
+
+    - type of daemon
+    - version of the daemon
+    - operating system (OS distribution, kernel version)
+    - stack trace identifying where in the Ceph code the crash occurred
+
+The data being reported does *not* contain any sensitive
+data like pool names, object names, object contents, or hostnames.
+
+It contains counters and statistics on how the cluster has been
+deployed, the version of Ceph, the distribition of the hosts and other
+parameters which help the project to gain a better understanding of
+the way Ceph is used.
+
+Data is sent over HTTPS to *telemetry.ceph.com*.
+
+Sample report
+-------------
 
-It contains counters and statistics on how the cluster has been deployed, the version of Ceph, the distribition of the hosts and other parameters which help the project to gain a better understanding of the way Ceph is used.
+You can look at what data is reported at any time with the command::
 
-Data is sent over HTTPS to *telemetry.ceph.com*
+  ceph mgr module enable telemetry
+  ceph telemetry show
+
+If you have any concerns about privacy with regard to the information included in
+this report, please contact the Ceph developers.
 
 Enabling
 --------
@@ -14,21 +47,31 @@ Enabling
 The *telemetry* module is enabled with::
 
   ceph mgr module enable telemetry
+  ceph telemetry on
+
+Telemetry can be disabled with::
 
+  ceph telemetry off
 
 Interval
 --------
+
 The module compiles and sends a new report every 72 hours by default.
+You can adjust this interval with::
+
+  ceph config set mgr mgr/telemetry/interval 24    # report every day
 
 Contact and Description
 -----------------------
-A contact and description can be added to the report, this is optional.
 
-  ceph telemetry config-set contact 'John Doe <john.doe@example.com>'
-  ceph telemetry config-set description 'My first Ceph cluster'
+A contact and description can be added to the report.  This is completely optional.::
+
+  ceph config set mgr mgr/telemetry/contact 'John Doe <john.doe@example.com>'
+  ceph config set mgr mgr/telemetry/description 'My first Ceph cluster'
 
 Show report
 -----------
+
 The report is sent in JSON format, and can be printed::
 
   ceph telemetry show