Skip to content

Commit ac7f757

Browse files
committed
doc/mgr: edit telemetry.rst
Edit doc/mgr/telemetry.rst. Incorporate Anthony D'Atri's suggestions from ceph#63739. Signed-off-by: Zac Dover <[email protected]>
1 parent 7c5164b commit ac7f757

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

doc/mgr/telemetry.rst

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -121,8 +121,7 @@ List all channels with:
121121
Enabling Telemetry
122122
------------------
123123

124-
To allow the *telemetry* module to start sharing data, run the following
125-
command:
124+
To allow the *telemetry* module to share data, run the following command:
126125

127126
.. prompt:: bash #
128127

@@ -157,10 +156,9 @@ If telemetry is disabled, run the following command to preview a sample report:
157156

158157
ceph telemetry preview
159158

160-
The generation of a sample report might take a few moments in big clusters
161-
(clusters with hundreds of OSDs or more).
159+
The generation of a sample report for larger clusters might take some time.
162160

163-
To protect your privacy, device reports are generated separately. Data
161+
To protect sensitive information, device reports are generated separately. Data
164162
including hostnames and device serial numbers are anonymized. The device
165163
telemetry is sent to a different endpoint and does not associate the device
166164
data with a particular cluster. To see a preview of the device report, run the
@@ -177,10 +175,10 @@ report:
177175

178176
ceph telemetry preview-device
179177

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.
178+
.. note:: ``smartmontools`` version 7.0 or later must be installed so that JSON
179+
output can be specified and parsed. If you have any concerns about privacy
180+
with regard to the information included in this report, contact the Ceph
181+
developers.
184182

185183
When telemetry is enabled, run the following command to generate both reports
186184
in a single output:

0 commit comments

Comments
 (0)