ceph/doc/mgr/telemetry.rst
Lenz Grimmer c3149421bc doc: Replaced "plugin" with "module" in the Mgr documentation
The documentation currently refers to Ceph Manager Modules as
"plugins" in many places, while the command line interface uses
"module" to enable/disable modules. Replaced all occurences
of "plugin" with "module" in the docs, to avoid confusion and to
be in alignment with the CLI. Also fixed the capitalizations of some
module chapters.

Fixes: https://tracker.ceph.com/issues/38481
Signed-off-by: Lenz Grimmer <lgrimmer@suse.com>
2019-02-27 13:49:47 +01:00

37 lines
1.1 KiB
ReStructuredText

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.
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.