Skip to content

Commit c05f7c9

Browse files
committed
doc/mgr: edit telemetry (2 of x)
Improve the English and the formatting in doc/mgr/telemetry.rst. This follows up on ceph#63476. This commit edits the second hundred lines in doc/mgr/telemetry.rst. Signed-off-by: Zac Dover <[email protected]> (cherry picked from commit f8975b0)
1 parent 239dd0e commit c05f7c9

File tree

1 file changed

+31
-27
lines changed

1 file changed

+31
-27
lines changed

doc/mgr/telemetry.rst

Lines changed: 31 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -115,21 +115,22 @@ List all channels with:
115115
Enabling Telemetry
116116
------------------
117117

118-
To allow the *telemetry* module to start sharing data:
118+
To allow the *telemetry* module to start sharing data, run the following
119+
command:
119120

120121
.. prompt:: bash #
121122

122123
ceph telemetry on
123124

124-
Please note: Telemetry data is licensed under the Community Data License
125-
Agreement - Sharing - Version 1.0 (https://cdla.io/sharing-1-0/). Hence,
126-
telemetry module can be enabled only after you add ``--license sharing-1-0`` to
127-
the ``ceph telemetry on`` command. Once telemetry is on, please consider
128-
enabling channels which are off by default, such as the ``perf`` channel.
129-
``ceph telemetry on`` output will list the exact command to enable these
130-
channels.
125+
Please note: Telemetry data is licensed under the `Community Data License
126+
Agreement - Sharing - Version 1.0 <https://cdla.io/sharing-1-0/>`_. This means
127+
that telemetry module can be enabled only after you add ``--license
128+
sharing-1-0`` to the ``ceph telemetry on`` command. After telemetry is on,
129+
consider enabling channels which are off by default, such as the
130+
``perf`` channel. ``ceph telemetry on`` output will list the exact command to
131+
enable these channels.
131132

132-
Telemetry can be disabled at any time with:
133+
Telemetry can be disabled at any time by running the following command:
133134

134135
.. prompt:: bash #
135136

@@ -138,58 +139,61 @@ Telemetry can be disabled at any time with:
138139
Sample report
139140
-------------
140141

141-
You can look at what data is reported at any time with the command:
142+
Show reported data by running the following command:
142143

143144
.. prompt:: bash #
144145

145146
ceph telemetry show
146147

147-
If telemetry is off, you can preview a sample report with:
148+
If telemetry is disabled, run the following command to preview a sample report:
148149

149150
.. prompt:: bash #
150151

151152
ceph telemetry preview
152153

153-
Generating a sample report might take a few moments in big clusters (clusters
154-
with hundreds of OSDs or more).
154+
The generation of a sample report might take a few moments in big clusters
155+
(clusters with hundreds of OSDs or more).
155156

156-
To protect your privacy, device reports are generated separately, and data such
157-
as hostname and device serial number is anonymized. The device telemetry is
158-
sent to a different endpoint and does not associate the device data with a
159-
particular cluster. To see a preview of the device report use the command:
157+
To protect your privacy, device reports are generated separately. Data
158+
including hostnames and device serial numbers are anonymized. The device
159+
telemetry is sent to a different endpoint and does not associate the device
160+
data with a particular cluster. To see a preview of the device report, run the
161+
following command:
160162

161163
.. prompt:: bash #
162164

163165
ceph telemetry show-device
164166

165-
If telemetry is off, you can preview a sample device report with:
167+
If telemetry is disabled, run the following command to preview a sample device
168+
report:
166169

167170
.. prompt:: bash #
168171

169172
ceph telemetry preview-device
170173

171-
Please note: In order to generate the device report we use Smartmontools
172-
version 7.0 and up, which supports JSON output. If you have any concerns about
173-
privacy with regard to the information included in this report, please contact
174-
the Ceph developers.
174+
.. note:: In order to generate the device report we use Smartmontools version
175+
7.0 and up, which supports JSON output. If you have any concerns about
176+
privacy with regard to the information included in this report, contact the
177+
Ceph developers.
175178

176-
In case you prefer to have a single output of both reports, and telemetry is
177-
on, use:
179+
When telemetry is enabled, run the following command to generate both reports
180+
in a single output:
178181

179182
.. prompt:: bash #
180183

181184
ceph telemetry show-all
182185

183-
If you would like to view a single output of both reports, and telemetry is
184-
off, use:
186+
When telemetry is disabled, run the following command to view both reports in a
187+
single output:
185188

186189
.. prompt:: bash #
187190

188191
ceph telemetry preview-all
189192

190193
**Sample report by channel**
191194

192-
When telemetry is on you can see what data is reported by channel with:
195+
Run the following command when telemetry is enabled to show the data reported
196+
by a specified channel:
193197

194198
.. prompt:: bash #
195199

0 commit comments

Comments
 (0)