2019-03-01 20:31:50 +00:00
|
|
|
.. _telemetry:
|
|
|
|
|
|
2019-02-27 12:49:47 +00:00
|
|
|
Telemetry Module
|
2018-04-27 07:14:05 +00:00
|
|
|
================
|
|
|
|
|
|
2019-03-01 20:31:50 +00:00
|
|
|
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
|
|
|
|
|
-------------
|
2018-04-27 07:14:05 +00:00
|
|
|
|
2019-03-01 20:31:50 +00:00
|
|
|
You can look at what data is reported at any time with the command::
|
2018-04-27 07:14:05 +00:00
|
|
|
|
2019-03-01 20:31:50 +00:00
|
|
|
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.
|
2018-04-27 07:14:05 +00:00
|
|
|
|
|
|
|
|
Enabling
|
|
|
|
|
--------
|
|
|
|
|
|
|
|
|
|
The *telemetry* module is enabled with::
|
|
|
|
|
|
|
|
|
|
ceph mgr module enable telemetry
|
2019-03-01 20:31:50 +00:00
|
|
|
ceph telemetry on
|
|
|
|
|
|
|
|
|
|
Telemetry can be disabled with::
|
2018-04-27 07:14:05 +00:00
|
|
|
|
2019-03-01 20:31:50 +00:00
|
|
|
ceph telemetry off
|
2018-04-27 07:14:05 +00:00
|
|
|
|
|
|
|
|
Interval
|
|
|
|
|
--------
|
2019-03-01 20:31:50 +00:00
|
|
|
|
2018-04-27 07:14:05 +00:00
|
|
|
The module compiles and sends a new report every 72 hours by default.
|
2019-03-01 20:31:50 +00:00
|
|
|
You can adjust this interval with::
|
|
|
|
|
|
|
|
|
|
ceph config set mgr mgr/telemetry/interval 24 # report every day
|
2018-04-27 07:14:05 +00:00
|
|
|
|
|
|
|
|
Contact and Description
|
|
|
|
|
-----------------------
|
|
|
|
|
|
2019-03-01 20:31:50 +00:00
|
|
|
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'
|
2018-04-27 07:14:05 +00:00
|
|
|
|
|
|
|
|
Show report
|
|
|
|
|
-----------
|
2019-03-01 20:31:50 +00:00
|
|
|
|
2018-04-27 07:14:05 +00:00
|
|
|
The report is sent in JSON format, and can be printed::
|
|
|
|
|
|
|
|
|
|
ceph telemetry show
|
|
|
|
|
|
|
|
|
|
So you can inspect the content if you have privacy concerns.
|
