From: Zac Dover Date: Thu, 5 Jun 2025 03:05:54 +0000 (+1000) Subject: doc/mgr: edit telemetry (4 of x) X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=b199d75763baf654fe1b21a780a4f6bcd0c4735b;p=ceph.git doc/mgr: edit telemetry (4 of x) Improve the English and the formatting in doc/mgr/telemetry.rst. This follows up on https://github.com/ceph/ceph/pull/63476. This commit edits the final part of doc/mgr/telemetry.rst. Signed-off-by: Zac Dover --- diff --git a/doc/mgr/telemetry.rst b/doc/mgr/telemetry.rst index 9c5fe5ce2f734..529466c126633 100644 --- a/doc/mgr/telemetry.rst +++ b/doc/mgr/telemetry.rst @@ -300,14 +300,14 @@ Sending telemetry through a proxy --------------------------------- If the cluster cannot directly connect to the configured telemetry -endpoint (default ``telemetry.ceph.com``), you can configure a HTTP/HTTPS -proxy server with: +endpoint (default: ``telemetry.ceph.com``), configure a HTTP/HTTPS +proxy server by running a command of the following form: .. prompt:: bash # ceph config set mgr mgr/telemetry/proxy https://10.0.0.1:8080 -You can also include a ``user:pass`` if needed: +Include a ``user:pass`` if needed by running a command of the following form: .. prompt:: bash # @@ -317,8 +317,9 @@ You can also include a ``user:pass`` if needed: Contact and Description ----------------------- -A contact and description can be added to the report. This is -completely optional, and disabled by default: +A contact and description can be added to the report. This is optional and is +disabled by default. Run commands of the following forms to add contacts and +descriptions: .. prompt:: bash # @@ -337,8 +338,9 @@ To participate in a leaderboard in the `public dashboards ceph config set mgr mgr/telemetry/leaderboard true The leaderboard displays basic information about the cluster. This includes the -total storage capacity and the number of OSDs. To add a description of the -cluster, run a command of the following form: +cluster's total storage capacity and the number of OSDs. To add a description +of the cluster so that it can more easily be identified on the leaderboard, run +a command of the following form: .. prompt:: bash # @@ -346,4 +348,3 @@ cluster, run a command of the following form: If the ``ident`` channel is enabled, its details will not be displayed in the leaderboard. -