Skip to content

Commit 3ce61e0

Browse files
committed
doc/mgr: edit telemetry (3 of x)
Improve the English and the formatting in doc/mgr/telemetry.rst. This follows up on ceph#63476. This commit edits the third hundred lines in doc/mgr/telemetry.rst. Signed-off-by: Zac Dover <[email protected]>
1 parent 12ffad5 commit 3ce61e0

File tree

1 file changed

+26
-16
lines changed

1 file changed

+26
-16
lines changed

doc/mgr/telemetry.rst

Lines changed: 26 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -209,10 +209,10 @@ If telemetry is off you can preview a sample report by channel with:
209209
Collections
210210
-----------
211211

212-
Collections represent different aspects of data that we collect within a
212+
Collections represent different aspects of data collected within a
213213
channel.
214214

215-
List all collections with:
215+
To list all collections, run the following command:
216216

217217
.. prompt:: bash #
218218

@@ -237,29 +237,38 @@ List all collections with:
237237

238238
Where:
239239

240-
**NAME**: Collection name; prefix indicates the channel the collection belongs to.
240+
.. glossary::
241241

242-
**STATUS**: Indicates whether the collection metrics are reported; this is
243-
determined by the status (enabled / disabled) of the channel the collection
244-
belongs to, along with the enrollment status of the collection (whether the user
245-
is opted-in to this collection).
242+
NAME
243+
Collection name; prefix indicates the channel the collection
244+
belongs to.
246245

247-
**DESC**: General description of the collection.
246+
STATUS
247+
Indicates whether the collection metrics are reported; this is
248+
determined by the status (enabled / disabled) of the channel
249+
the collection belongs to, along with the enrollment status of
250+
the collection (whether the user is opted-in to this
251+
collection).
248252

249-
See the diff between the collections you are enrolled to, and the new,
250-
available collections with:
253+
DESC
254+
General description of the collection.
255+
256+
To print the diff that displays the differences between (1) the collections you
257+
are enrolled to and (2) the new, available collections, run the following
258+
command:
251259

252260
.. prompt:: bash #
253261

254262
ceph telemetry diff
255263

256-
Enroll to the most recent collections with:
264+
To enroll to the most recent collections, run the following command:
257265

258266
.. prompt:: bash #
259267

260268
ceph telemetry on
261269

262-
Then enable new channels that are off with:
270+
Enable a new channel that is disabled by running a command of the following
271+
form:
263272

264273
.. prompt:: bash #
265274

@@ -268,8 +277,8 @@ Then enable new channels that are off with:
268277
Interval
269278
--------
270279

271-
The module compiles and sends a new report every 24 hours by default.
272-
You can adjust this interval with:
280+
The telemetry module compiles and sends a new report every 24 hours by default.
281+
Adjust this interval by running a command of the following form:
273282

274283
.. prompt:: bash #
275284

@@ -278,7 +287,8 @@ You can adjust this interval with:
278287
Status
279288
--------
280289

281-
The see the current configuration:
290+
To print the current configuration of the telemetry module, run a command of
291+
the following form:
282292

283293
.. prompt:: bash #
284294

@@ -287,7 +297,7 @@ The see the current configuration:
287297
Manually sending telemetry
288298
--------------------------
289299

290-
To ad hoc send telemetry data:
300+
To ad hoc [fixme] send telemetry data:
291301

292302
.. prompt:: bash #
293303

0 commit comments

Comments
 (0)