Skip to content

Commit e6648cd

Browse files
authored
Merge pull request ceph#63740 from zdover23/wip-doc-2025-06-05-mgr-telemetry-63476-followup-3-of-x
doc/mgr: edit telemetry (3 of x) Reviewed-by: Anthony D'Atri <[email protected]>
2 parents 4035e70 + 3ce61e0 commit e6648cd

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
@@ -219,10 +219,10 @@ If telemetry is off you can preview a sample report by channel with:
219219
Collections
220220
-----------
221221

222-
Collections represent different aspects of data that we collect within a
222+
Collections represent different aspects of data collected within a
223223
channel.
224224

225-
List all collections with:
225+
To list all collections, run the following command:
226226

227227
.. prompt:: bash #
228228

@@ -247,29 +247,38 @@ List all collections with:
247247

248248
Where:
249249

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

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

257-
**DESC**: General description of the collection.
256+
STATUS
257+
Indicates whether the collection metrics are reported; this is
258+
determined by the status (enabled / disabled) of the channel
259+
the collection belongs to, along with the enrollment status of
260+
the collection (whether the user is opted-in to this
261+
collection).
258262

259-
See the diff between the collections you are enrolled to, and the new,
260-
available collections with:
263+
DESC
264+
General description of the collection.
265+
266+
To print the diff that displays the differences between (1) the collections you
267+
are enrolled to and (2) the new, available collections, run the following
268+
command:
261269

262270
.. prompt:: bash #
263271

264272
ceph telemetry diff
265273

266-
Enroll to the most recent collections with:
274+
To enroll to the most recent collections, run the following command:
267275

268276
.. prompt:: bash #
269277

270278
ceph telemetry on
271279

272-
Then enable new channels that are off with:
280+
Enable a new channel that is disabled by running a command of the following
281+
form:
273282

274283
.. prompt:: bash #
275284

@@ -278,8 +287,8 @@ Then enable new channels that are off with:
278287
Interval
279288
--------
280289

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

284293
.. prompt:: bash #
285294

@@ -288,7 +297,8 @@ You can adjust this interval with:
288297
Status
289298
--------
290299

291-
The see the current configuration:
300+
To print the current configuration of the telemetry module, run a command of
301+
the following form:
292302

293303
.. prompt:: bash #
294304

@@ -297,7 +307,7 @@ The see the current configuration:
297307
Manually sending telemetry
298308
--------------------------
299309

300-
To ad hoc send telemetry data:
310+
To ad hoc [fixme] send telemetry data:
301311

302312
.. prompt:: bash #
303313

0 commit comments

Comments
 (0)