@@ -121,21 +121,22 @@ List all channels with:
121121Enabling Telemetry
122122------------------
123123
124- To allow the *telemetry * module to start sharing data:
124+ To allow the *telemetry * module to start sharing data, run the following
125+ command:
125126
126127.. prompt :: bash #
127128
128129 ceph telemetry on
129130
130- Please note: Telemetry data is licensed under the Community Data License
131- Agreement - Sharing - Version 1.0 ( https://cdla.io/sharing-1-0/). Hence,
132- telemetry module can be enabled only after you add ``--license sharing-1-0 `` to
133- the ``ceph telemetry on `` command. Once telemetry is on, please consider
134- enabling channels which are off by default, such as the `` perf `` channel.
135- ``ceph telemetry on `` output will list the exact command to enable these
136- channels.
131+ Please note: Telemetry data is licensed under the ` Community Data License
132+ Agreement - Sharing - Version 1.0 < https://cdla.io/sharing-1-0/> `_. This means
133+ that telemetry module can be enabled only after you add ``--license
134+ sharing-1-0 `` to the ``ceph telemetry on `` command. After telemetry is on,
135+ consider enabling channels which are off by default, such as the
136+ ``perf `` channel. `` ceph telemetry on `` output will list the exact command to
137+ enable these channels.
137138
138- Telemetry can be disabled at any time with :
139+ Telemetry can be disabled at any time by running the following command :
139140
140141.. prompt :: bash #
141142
@@ -144,58 +145,61 @@ Telemetry can be disabled at any time with:
144145Sample report
145146-------------
146147
147- You can look at what data is reported at any time with the command:
148+ Show reported data by running the following command:
148149
149150.. prompt :: bash #
150151
151152 ceph telemetry show
152153
153- If telemetry is off, you can preview a sample report with :
154+ If telemetry is disabled, run the following command to preview a sample report:
154155
155156.. prompt :: bash #
156157
157158 ceph telemetry preview
158159
159- Generating a sample report might take a few moments in big clusters ( clusters
160- with hundreds of OSDs or more).
160+ The generation of a sample report might take a few moments in big clusters
161+ (clusters with hundreds of OSDs or more).
161162
162- To protect your privacy, device reports are generated separately, and data such
163- as hostname and device serial number is anonymized. The device telemetry is
164- sent to a different endpoint and does not associate the device data with a
165- particular cluster. To see a preview of the device report use the command:
163+ To protect your privacy, device reports are generated separately. Data
164+ including hostnames and device serial numbers are anonymized. The device
165+ telemetry is sent to a different endpoint and does not associate the device
166+ data with a particular cluster. To see a preview of the device report, run the
167+ following command:
166168
167169.. prompt :: bash #
168170
169171 ceph telemetry show-device
170172
171- If telemetry is off, you can preview a sample device report with:
173+ If telemetry is disabled, run the following command to preview a sample device
174+ report:
172175
173176.. prompt :: bash #
174177
175178 ceph telemetry preview-device
176179
177- Please note: In order to generate the device report we use Smartmontools
178- version 7.0 and up, which supports JSON output. If you have any concerns about
179- privacy with regard to the information included in this report, please contact
180- the Ceph developers.
180+ .. note :: In order to generate the device report we use Smartmontools version
181+ 7.0 and up, which supports JSON output. If you have any concerns about
182+ privacy with regard to the information included in this report, contact the
183+ Ceph developers.
181184
182- In case you prefer to have a single output of both reports, and telemetry is
183- on, use:
185+ When telemetry is enabled, run the following command to generate both reports
186+ in a single output:
184187
185188.. prompt :: bash #
186189
187190 ceph telemetry show-all
188191
189- If you would like to view a single output of both reports, and telemetry is
190- off, use :
192+ When telemetry is disabled, run the following command to view both reports in a
193+ single output :
191194
192195.. prompt :: bash #
193196
194197 ceph telemetry preview-all
195198
196199**Sample report by channel **
197200
198- When telemetry is on you can see what data is reported by channel with:
201+ Run the following command when telemetry is enabled to show the data reported
202+ by a specified channel:
199203
200204.. prompt :: bash #
201205
0 commit comments