ceph/doc/mgr/telemetry.rst

   1 .. _telemetry:
   2
   3 Telemetry Module
   4 ================
   5
   6 The telemetry module sends anonymous data about the cluster back to the Ceph
   7 developers to help understand how Ceph is used and what problems users may
   8 be experiencing.
   9
  10 Reported telemetry includes:
  11
  12   * capacity of the cluster
  13   * number of monitors, managers, OSDs, MDSs, radosgws, or other daemons
  14   * software version currently being used
  15   * number and types of RADOS pools and CephFS file systems
  16   * information about daemon crashes, including
  17
  18     - type of daemon
  19     - version of the daemon
  20     - operating system (OS distribution, kernel version)
  21     - stack trace identifying where in the Ceph code the crash occurred
  22
  23 The data being reported does *not* contain any sensitive
  24 data like pool names, object names, object contents, or hostnames.
  25
  26 It contains counters and statistics on how the cluster has been
  27 deployed, the version of Ceph, the distribition of the hosts and other
  28 parameters which help the project to gain a better understanding of
  29 the way Ceph is used.
  30
  31 Data is sent over HTTPS to *telemetry.ceph.com*.
  32
  33 Sample report
  34 -------------
  35
  36 You can look at what data is reported at any time with the command::
  37
  38   ceph mgr module enable telemetry
  39   ceph telemetry show
  40
  41 If you have any concerns about privacy with regard to the information included in
  42 this report, please contact the Ceph developers.
  43
  44 Enabling
  45 --------
  46
  47 The *telemetry* module is enabled with::
  48
  49   ceph mgr module enable telemetry
  50   ceph telemetry on
  51
  52 Telemetry can be disabled with::
  53
  54   ceph telemetry off
  55
  56 Interval
  57 --------
  58
  59 The module compiles and sends a new report every 72 hours by default.
  60 You can adjust this interval with::
  61
  62   ceph config set mgr mgr/telemetry/interval 24    # report every day
  63
  64 Contact and Description
  65 -----------------------
  66
  67 A contact and description can be added to the report.  This is completely optional.::
  68
  69   ceph config set mgr mgr/telemetry/contact 'John Doe <john.doe@example.com>'
  70   ceph config set mgr mgr/telemetry/description 'My first Ceph cluster'
  71
  72 Show report
  73 -----------
  74
  75 The report is sent in JSON format, and can be printed::
  76
  77   ceph telemetry show
  78
  79 So you can inspect the content if you have privacy concerns.