ceph/doc/mgr/telemetry.rst
Wido den Hollander 394b10049e mgr/telemetry: Add Ceph Telemetry module to send reports back to project
This Manager Module will send statistics and version information from
a Ceph cluster back to telemetry.ceph.com if the user has opted-in on sending
this information.

Additionally a user can tell that the information is allowed to be made
public which then allows other users to see this information.

Signed-off-by: Wido den Hollander <wido@42on.com>
(cherry picked from commit 8f6137d162)
2018-05-14 23:34:25 +08:00

37 lines
1.1 KiB
ReStructuredText

Telemetry plugin
================
The telemetry plugin 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.
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*
Enabling
--------
The *telemetry* module is enabled with::
ceph mgr module enable telemetry
Interval
--------
The module compiles and sends a new report every 72 hours by default.
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'
Show report
-----------
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.