Commit Graph

22 Commits

Author SHA1 Message Date
Laura Flores
f69cec5b70 mgr/telemetry: separate device class usage statistics into their own collection
The new collection is called `basic_usage_by_class`. This info should be separate
from `basic_pool_usage` since it doesn't involve pool statistics.

Signed-off-by: Laura Flores <lflores@redhat.com>
2022-02-08 00:45:02 +00:00
Laura Flores
c71a54ec1a mgr/telemetry: update basic_pool_usage collection desc
- Added the word "default" since we are only collecting
default pool applications

- Removed the word "data" since we are actually collecting
usage *statistics*

Signed-off-by: Laura Flores <lflores@redhat.com>
2022-02-08 00:42:37 +00:00
Laura Flores
4a2b54c1f2 doc/mgr: update telemetry doc to reflect basic_pool_usage collection
Signed-off-by: Laura Flores <lflores@redhat.com>
2022-02-02 23:08:53 +00:00
Yaarit Hatuka
2d1550cf05 mgr/telemetry: add enable / disable channel all
Enable or disable all telemetry channels at once with:
    ceph telemetry enable channel all
    ceph telemetry disable channel all

Signed-off-by: Yaarit Hatuka <yaarit@redhat.com>
2022-01-13 21:54:07 +00:00
Yaarit Hatuka
77a032526d mgr/telemetry: improve output of ceph telemetry collection ls
STATUS column now indicates whether a collection is being reported, and
the reasons why it's not (either the user is not opted-in to this
collection, or its channel is off).

Also, removed the ENROLLED and DEFAULT columns due to potential
confusion they may cause.

In case a user is not opted-in to certain collections, a message will
appear above the table with the missing collections:

    New collections are available:
    ['basic_base', 'basic_mds_metadata', 'crash_base', 'device_base',
    'ident_base', 'perf_perf']
    Run `ceph telemetry on` to opt-in to these collections.

Signed-off-by: Yaarit Hatuka <yaarit@redhat.com>
2022-01-13 21:54:07 +00:00
Yaarit Hatuka
4c110ed2a5 doc/mgr/telemetry: document new commands
New commands:

  ceph telemetry enable channel <channel_name>
  ceph telemetry disable channel <channel_name>
  ceph telemetry channel ls
  ceph telemetry collection ls
  ceph telemetry collection diff
  ceph telemetry preview
  ceph telemetry preview-device
  ceph telemetry preview-all

Signed-off-by: Yaarit Hatuka <yaarit@redhat.com>
2022-01-13 21:53:47 +00:00
Laura Flores
b57d61c1cb mgr/telemetry: remove aggregated perf metrics from the perf channel
Up until this point, we included aggregated and separated data for
testing purposes. Now that we've done our testing, the aggregated
metrics are no longer relevant.

Aggregated metrics can still be achieved on the server side by
summing separated metrics.

Signed-off-by: Laura Flores <lflores@redhat.com>
2021-12-02 18:43:33 +00:00
Laura Flores
1734647008
doc/mgr/telemetry: fix formatting problem
There was strange bolding and bullet point placement due to a missing new line in the perf description.

Signed-off-by: Laura Flores <lflores@redhat.com>
2021-07-28 10:11:17 -05:00
Laura Flores
f318eed2a4 doc/mgr/telemetry: update Telemetry Module docs to include perf channel
PR #42074 adds a new perf channel to the Telemetry Module. With this commit, the docs will reflect that addition. Within the Telemetry Module docs, I explain the purpose of the new perf channel as well as some use cases of the metrics that will be collected under the channel.

Signed-off-by: Laura Flores <lflores@redhat.com>
2021-07-13 20:44:44 +00:00
Tatjana Dehler
18875ef337 mgr/dashboard: add telemetry report component
Add a telemetry component in order to give the user the
possibility to configure the telemetry module in a more
guided fashion. The component offers broader explanations,
shows a preview of the generated report and asks the user
to accept the license before enabling the module.

Fixes: https://tracker.ceph.com/issues/43956
Signed-off-by: Tatjana Dehler <tdehler@suse.com>
2020-04-29 16:34:00 +02:00
Tatjana Dehler
8d91443c8b mgr/telemetry: refactor/enhance CLI commands
1. Move the implementations of the `on` and `off`
command into dedicated methods so that they can
be accessed by other mgr modules via `mgr.remote`.

2. Add a `show-all` command to return the report
and device report at once. Also add a method
`get_report` to make the reports accessible for
other mgr modules as mentioned above.

3. Add two  minor changes and a note where the
gathered data can be found to the Telemetry docu
file.

Signed-off-by: Tatjana Dehler <tdehler@suse.com>
2020-04-29 15:08:35 +02:00
Yaarit Hatuka
4308c5d56e doc/mgr/telemetry: add 'send' command
Signed-off-by: Yaarit Hatuka <yaarit@redhat.com>
2020-03-05 12:15:27 -05:00
Lars Marowsky-Bree
5d7c79b079 mgr/telemetry: fix and document proxy usage
This addresses https://tracker.ceph.com/issues/44320 - fix and document
use of proxies for mgr/telemetry.

Signed-off-by: Lars Marowsky-Bree <lmb@suse.com>
2020-02-27 11:11:01 +01:00
Yaarit Hatuka
66c41f3d0e doc/mgr/telemetry: added device channel details
Plus details about license agreement.

Fixes: https://tracker.ceph.com/issues/43648
Signed-off-by: Yaarit Hatuka <yaarit@redhat.com>
2020-02-20 10:27:21 -05:00
Tim Serong
3c8793c4bd doc/mgr/telemetry: update default interval
Commit 712987d533 changed the default interval to 24h;
updating the docs to match (this also should go to
the Nautilus branch as that commit landed there too
in https://github.com/ceph/ceph/pull/27709)

Signed-off-by: Tim Serong <tserong@suse.com>
2019-10-21 18:18:05 +11:00
Sage Weil
2d62d71cd4 mon: enable telemetry module by default
We already have a robust set of opt-in and opt-out procedures; no need to
require the user to enable the module.

Signed-off-by: Sage Weil <sage@redhat.com>
2019-08-01 04:55:44 -05:00
Sage Weil
fce9fe87df mgr/telemetry: include any config options that are customized
This does not reveal the value of the options, only which options have
been customized.

Signed-off-by: Sage Weil <sage@redhat.com>
2019-07-26 08:17:58 -05:00
Sage Weil
9fd65934de doc/mgr/telemetry: update
Signed-off-by: Sage Weil <sage@redhat.com>
2019-07-25 10:47:07 -05:00
Bryan Stillwell
8d87df48f2 doc: Miscellaneous spelling fixes
While looking over the documentation I found a few words being misspelled.

Signed-off-by: Bryan Stillwell <bstillwell@godaddy.com>
2019-03-26 14:52:12 -06:00
Sage Weil
d14c909408 doc/mgr/telemtry: update docs
- new commands
- more explicit summary of what we send
- multiple steps to enable, so that you can see what would be reported
  before opting in.

Signed-off-by: Sage Weil <sage@redhat.com>
2019-03-01 14:32:04 -06:00
Lenz Grimmer
c3149421bc doc: Replaced "plugin" with "module" in the Mgr documentation
The documentation currently refers to Ceph Manager Modules as
"plugins" in many places, while the command line interface uses
"module" to enable/disable modules. Replaced all occurences
of "plugin" with "module" in the docs, to avoid confusion and to
be in alignment with the CLI. Also fixed the capitalizations of some
module chapters.

Fixes: https://tracker.ceph.com/issues/38481
Signed-off-by: Lenz Grimmer <lgrimmer@suse.com>
2019-02-27 13:49:47 +01:00
Wido den Hollander
394b10049e mgr/telemetry: Add Ceph Telemetry module to send reports back to project
This Manager Module will send statistics and version information from
a Ceph cluster back to telemetry.ceph.com if the user has opted-in on sending
this information.

Additionally a user can tell that the information is allowed to be made
public which then allows other users to see this information.

Signed-off-by: Wido den Hollander <wido@42on.com>
(cherry picked from commit 8f6137d162)
2018-05-14 23:34:25 +08:00