- cluster description
- contact email address
+* **perf** (default: off): Various performance metrics of a cluster, which can be used to
+
+ - reveal overall cluster health
+ - identify workload patterns
+ - troubleshoot issues with latency, throttling, memory management, etc.
+ - monitor cluster performance by daemon
+
The data being reported does *not* contain any sensitive
data like pool names, object names, object contents, hostnames, or device
serial numbers.
Data is sent secured to *https://telemetry.ceph.com*.
+Individual channels can be enabled or disabled with::
+
+ ceph telemetry enable channel basic
+ ceph telemetry enable channel crash
+ ceph telemetry enable channel device
+ ceph telemetry enable channel ident
+ ceph telemetry enable channel perf
+
+ ceph telemetry disable channel basic
+ ceph telemetry disable channel crash
+ ceph telemetry disable channel device
+ ceph telemetry disable channel ident
+ ceph telemetry disable channel perf
+
+Multiple channels can be enabled or disabled with::
+
+ ceph telemetry enable channel basic crash device ident perf
+ ceph telemetry disable channel basic crash device ident perf
+
+Channels can be enabled or disabled all at once with::
+
+ ceph telemetry enable channel all
+ ceph telemetry disable channel all
+
+Please note that telemetry should be on for these commands to take effect.
+
+List all channels with::
+
+ ceph telemetry channel ls
+
+ NAME ENABLED DEFAULT DESC
+ basic ON ON Share basic cluster information (size, version)
+ crash ON ON Share metadata about Ceph daemon crashes (version, stack straces, etc)
+ device ON ON Share device health metrics (e.g., SMART data, minus potentially identifying info like serial numbers)
+ ident OFF OFF Share a user-provided description and/or contact email for the cluster
+ perf ON OFF Share various performance metrics of a cluster
+
+
+Enabling Telemetry
+------------------
+
+To allow the *telemetry* module to start sharing data::
+
+ ceph telemetry on
+
+Please note: Telemetry data is licensed under the Community Data License
+Agreement - Sharing - Version 1.0 (https://cdla.io/sharing-1-0/). Hence,
+telemetry module can be enabled only after you add '--license sharing-1-0' to
+the 'ceph telemetry on' command.
+Once telemetry is on, please consider enabling channels which are off by
+default, such as the 'perf' channel. 'ceph telemetry on' output will list the
+exact command to enable these channels.
+
+Telemetry can be disabled at any time with::
+
+ ceph telemetry off
+
Sample report
-------------
ceph telemetry show
+If telemetry is off, you can preview a sample report with::
+
+ ceph telemetry preview
+
+Generating a sample report might take a few moments in big clusters (clusters
+with hundreds of OSDs or more).
+
To protect your privacy, device reports are generated separately, and data such
as hostname and device serial number is anonymized. The device telemetry is
sent to a different endpoint and does not associate the device data with a
ceph telemetry show-device
+If telemetry is off, you can preview a sample device report with::
+
+ ceph telemetry preview-device
+
Please note: In order to generate the device report we use Smartmontools
version 7.0 and up, which supports JSON output.
If you have any concerns about privacy with regard to the information included in
this report, please contact the Ceph developers.
-Channels
---------
+In case you prefer to have a single output of both reports, and telemetry is on, use::
-Individual channels can be enabled or disabled with::
+ ceph telemetry show-all
- ceph config set mgr mgr/telemetry/channel_ident false
- ceph config set mgr mgr/telemetry/channel_basic false
- ceph config set mgr mgr/telemetry/channel_crash false
- ceph config set mgr mgr/telemetry/channel_device false
- ceph telemetry show
- ceph telemetry show-device
+If you would like to view a single output of both reports, and telemetry is off, use::
-Enabling Telemetry
-------------------
+ ceph telemetry preview-all
-To allow the *telemetry* module to start sharing data::
+**Sample report by channel**
- ceph telemetry on
+When telemetry is on you can see what data is reported by channel with::
-Please note: Telemetry data is licensed under the Community Data License
-Agreement - Sharing - Version 1.0 (https://cdla.io/sharing-1-0/). Hence,
-telemetry module can be enabled only after you add '--license sharing-1-0' to
-the 'ceph telemetry on' command.
+ ceph telemetry show <channel_name>
-Telemetry can be disabled at any time with::
+Please note: If telemetry is on, and <channel_name> is disabled, the command
+above will output a sample report by that channel, according to the collections
+the user is enrolled to. However this data is not reported, since the channel
+is disabled.
- ceph telemetry off
+If telemetry is off you can preview a sample report by channel with::
+
+ ceph telemetry preview <channel_name>
+
+Collections
+-----------
+
+Collections represent different aspects of data that we collect within a channel.
+
+List all collections with::
+
+ ceph telemetry collection ls
+
+ NAME STATUS DESC
+ basic_base REPORTING Basic information about the cluster (capacity, number and type of daemons, version, etc.)
+ basic_mds_metadata NOT REPORTING: NOT OPTED-IN MDS metadata
+ basic_pool_usage NOT REPORTING: NOT OPTED-IN Default pool application and usage statistics
+ basic_usage_by_class NOT REPORTING: NOT OPTED-IN Default device class usage statistics
+ crash_base REPORTING Information about daemon crashes (daemon type and version, backtrace, etc.)
+ device_base REPORTING Information about device health metrics
+ ident_base NOT REPORTING: CHANNEL ident IS OFF User-provided identifying information about the cluster
+ perf_perf NOT REPORTING: NOT OPTED-IN, CHANNEL perf IS OFF Information about performance counters of the cluster
+
+
+Where:
+
+**NAME**: Collection name; prefix indicates the channel the collection belongs to.
+
+**STATUS**: Indicates whether the collection metrics are reported; this is
+determined by the status (enabled / disabled) of the channel the collection
+belongs to, along with the enrollment status of the collection (whether the user
+is opted-in to this collection).
+
+**DESC**: General description of the collection.
+
+See the diff between the collections you are enrolled to, and the new,
+available collections with::
+
+ ceph telemetry diff
+
+Enroll to the most recent collections with::
+
+ ceph telemetry on
+
+Then enable new channels that are off with::
+
+ ceph telemetry enable channel <channel_name>
Interval
--------
projects / ceph.git / blobdiff