Telemetry module

The telemetry module sends data about the storage cluster to help understand how Ceph is used and what problems are encountered during operations. The data is visualized on the public dashboard to view the summary statistics on how many clusters are reporting, their total capacity and OSD count, and version distribution trends.

The telemetry report is broken down into different channels, each with a different type of information. After the telemetry is enabled, you can turn on or turn off the individual channels.

The following are the available channels:

  • basic
  • crash
  • device
  • ident
  • perf
basic
Default is on. This channel provides the basic information about the clusters, which includes the following information:
  • The capacity of the cluster.
  • The number of monitors, managers, OSDs, MDSs, Ceph Object Gateways, or other daemons.
  • The software version that is currently being used.
  • The number and types of RADOS pools and Ceph File Systems.
  • The names of configuration options that are changed from their default (but not their values).
crash
Default is on. This channel provides information about the daemon crashes, which includes the following information:
  • The type of daemon.
  • The version of the daemon.
  • The operating system, the OS distribution, and the kernel version.
  • The stack trace that identifies where in the Ceph code the crash occurred.
device
Default is on. This channel provides information about the device metrics, which includes anonymized SMART metrics.
ident
Default is off. This channel provides the user-provided identifying information about the cluster such as cluster description, and contact email address.
perf
Default is off. This channel provides the various performance metrics of the cluster, which can be used for the following:
  • Reveal overall cluster health.
  • Identify workload patterns.
  • Troubleshoot issues with latency, throttling, memory management, and other similar issues.
  • Monitor cluster performance by daemon.

The data that is reported does not contain any sensitive data such as pool names, object names, object contents, hostnames, or device serial numbers.

It contains counters and statistics on how the cluster is deployed, Ceph version, host distribution, and other parameters that help the project to gain a better understanding of the way Ceph is used.

Data is secure and is sent to https://telemetry.ceph.com.

Enabling telemetry

Before enabling channels, ensure that the telemetry is on.

Enable telemetry by using the following command: 
ceph telemetry on

Enabling and disabling channels

You can enable and disable either individual channels, multiple channels simultaneously, or all channels.
  • Enable an individual channel by using the following command: 
    ceph telemetry enable channel CHANNEL
    For example, 
    [ceph: root@host01 /]# ceph telemetry enable channel basic
  • Disable an individual channel by using the following command: 
    ceph telemetry disable channel CHANNEL
    For example, 
    [ceph: root@host01 /]# ceph telemetry disable channel basic
  • Enable multiple individual channels with a single command by using the following command: 
    ceph telemetry enable channel CHANNEL1 CHANNEL2 CHANNEL3
    For example, 
    [ceph: root@host01 /]# ceph telemetry enable channel basic crash device
  • Disable multiple individual channels with a single command by using the following command: 
    ceph telemetry disable channel CHANNEL1 CHANNEL2 CHANNEL3
    For example, 
    [ceph: root@host01 /]# ceph telemetry disable channel basic crash device
  • Enable all channels simultaneously by using the following command: 
    ceph telemetry enable channel all
    For example, 
    [ceph: root@host01 /]# ceph telemetry enable channel all
  • Disable all channels simultaneously by using the following command: 
    ceph telemetry disable channel all
    For example, 
    [ceph: root@host01 /]# ceph telemetry disable channel all

Sample reports

Use the following commands to generate and view sample reports.
  • Review the data report at any time by generating a sample report. 
    ceph telemetry show
    • If telemetry is off, you can preview the sample report. 
      ceph telemetry preview

      It takes longer to generate a sample report for storage clusters with hundreds of OSDs or more.

  • Device reports are generated separately to protect your privacy. Device reports output with data such as the host name and device serial number as anonymous. The device telemetry is sent to a different endpoint and does not associate the device data with a particular cluster. 
    ceph telemetry show-device
    • If telemetry is off, you can preview the sample device report. 
      ceph telemetry preview-device
  • Generate a single output for both the data and device. 
    ceph telemetry show-all
    • If telemetry is off, you can preview both reports. 
      ceph telemetry preview-all
  • Generate a sample report per channel. 
    ceph telemetry show CHANNEL_NAME
    • If telemetry is off, you can preview a sample report per channel. 
      ceph telemetry preview CHANNEL_NAME

Collections

Collections are different aspects of data that is collected within a channel.

  • List the collections. 
    ceph telemetry collection ls
  • See the difference between the collections that you are enrolled in, and the new, available collections. 
    ceph telemetry diff
  • Enroll to the most recent collections. 
    ceph telemetry on
ceph telemetry enable channel CHANNEL_NAME

interval

The interval module compiles and sends a new report every 24 hours by default.

Use the mgr/telemetry/interval option to adjust the report interval. 
ceph config set mgr mgr/telemetry/interval INTERVAL
The following example sets the report generation for every three days (72 hours). 
[ceph: root@host01 /]# ceph config set mgr mgr/telemetry/interval 72

status

Use the status option to view the current configuration. 
ceph telemetry status

Manually sending telemetry

Send an asynchronous, one-time set of telemetry data, by running the send command. 
ceph telemetry send
If telemetry is off, include --license sharing-1-0 to the command. 
ceph telemetry send --license sharing-1-0

Sending telemetry through a proxy

If the cluster cannot connect directly to the configured telemetry endpoint, you can configure a HTTP/HTTPs proxy server. 
ceph config set mgr mgr/telemetry/proxy PROXY_URL
For example, 
[ceph: root@host01 /]# ceph config set mgr mgr/telemetry/proxy https://10.0.0.1:8080

Contact and description

A contact and description can be added to the report. This is optional and is disabled by default.
Note: If ident flag is enabled, its details are not displayed in the leaderboard.
ceph config set mgr mgr/telemetry/contact 'CONTACT_NAME'
ceph config set mgr mgr/telemetry/description 'DESCRIPTION'
ceph config set mgr mgr/telemetry/channel_ident true
For example, 
[ceph: root@host01 /]# ceph config set mgr mgr/telemetry/contact 'John Doe <john.doe@example.com>'
[ceph: root@host01 /]# ceph config set mgr mgr/telemetry/description 'My first Ceph cluster'
[ceph: root@host01 /]# ceph config set mgr mgr/telemetry/channel_ident true

Leaderboard

You can participate in a leaderboard on the public Telemetry dashboard.

The leaderboard displays basic information about the storage cluster. This board includes the total storage capacity and the number of OSDs.

ceph config set mgr mgr/telemetry/leaderboard true