Skip to content

Commit e0b1c10

Browse files
committed
doc/mgr: edit telemetry.rst
Edit doc/mgr/telemetry.rst. Follow up on the suggestions made by Anthony D'Atri in ceph#63740. Make several changes that were not earmarked in that PR, but that nonetheless improve the quality of the English in telemetry.rst. Signed-off-by: Zac Dover <[email protected]> (cherry picked from commit fc25b1e)
1 parent 5b2c31d commit e0b1c10

File tree

1 file changed

+20
-12
lines changed

1 file changed

+20
-12
lines changed

doc/mgr/telemetry.rst

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -237,17 +237,22 @@ List all collections with:
237237

238238
Where:
239239

240-
**NAME**: Collection name; prefix indicates the channel the collection belongs to.
240+
NAME
241+
Collection name. The prefix indicates the channel to which the
242+
collection belongs.
241243

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).
244+
STATUS
245+
Indicates whether the collection metrics are reported. This is
246+
determined by the status (``enabled`` or ``disabled``) to which
247+
the channel of the collection belongs, along with the
248+
enrollment status of the collection (whether the user is
249+
opted-in to this collection).
246250

247-
**DESC**: General description of the collection.
251+
DESC
252+
General description of the collection.
248253

249-
See the diff between the collections you are enrolled to, and the new,
250-
available collections with:
254+
To display any difference between the currenty-enrolled collections and any new
255+
or available collections, run the following command:
251256

252257
.. prompt:: bash #
253258

@@ -259,7 +264,8 @@ Enroll to the most recent collections with:
259264

260265
ceph telemetry on
261266

262-
Then enable new channels that are off with:
267+
Enable a new channel that is currently disabled by running a command of the
268+
following form:
263269

264270
.. prompt:: bash #
265271

@@ -287,14 +293,16 @@ The see the current configuration:
287293
Manually sending telemetry
288294
--------------------------
289295

290-
To ad hoc send telemetry data:
296+
To send an ansynchronous, one-time set of telemetry data, run the following
297+
command:
291298

292299
.. prompt:: bash #
293300

294301
ceph telemetry send
295302

296-
In case telemetry is not enabled (with ``ceph telemetry on``), you need to add
297-
``--license sharing-1-0`` to the ``ceph telemetry send`` command.
303+
If telemetry has not been enabled (by running the command ``ceph telemetry
304+
on``), you need to add ``--license sharing-1-0`` to the ``ceph telemetry send``
305+
command.
298306

299307
Sending telemetry through a proxy
300308
---------------------------------

0 commit comments

Comments
 (0)