Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Usage Collection] [Meta] Enhance usage collection with richer API's #69291

Closed
TinaHeiligers opened this issue Jun 16, 2020 · 5 comments
Closed
Labels
Feature:Telemetry Meta Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc

Comments

@TinaHeiligers
Copy link
Contributor

TinaHeiligers commented Jun 16, 2020

In an effort to simplify the usage data that's collected in Kibana, we are making an effort to improve the existing usage collectors.

Documentation/Helper guides:

There are 2 options for capturing and reporting usage data to the telemetry service:

  1. Public/Browser side: ui_metrics
  2. Server side: usage_collection service

In addition, we want to enrich the APIs:

  1. Replace callCluster with { callCluster (with the deprecated flag), esClient (the new one), savedObjects }
  2. (to be filled in)

This issue serves as a meta ticket to reference related issues that need to be addressed.

Linked issues:

- [ ] Migrate Usage Collection plugin to Core as a Service (#69306)

@TinaHeiligers TinaHeiligers changed the title [usage Collection] [Meta] Standardize usage collection [Usage Collection] [Meta] Standardize usage collection Jun 16, 2020
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-telemetry (Team:KibanaTelemetry)

@afharo
Copy link
Member

afharo commented Jun 16, 2020

I’m not sure Standardize is the word we are after. If a piece of telemetry is “standard” for all plugins, we’ve already done it as a general one: like application_usage or custom uiSettings, and any more we can add if needed (like if we want to report every time an element containing a certain HTML property is displayed as part of the application_usage).

The custom UsageCollectors are meant to be used for custom telemetry: for anything that is very plugin-specific.

We can improve our APIs to report event-based telemetry (the repeated 7d/30d/90d/total approach), and I def think we should put some efforts into that. UI Metrics is an example that could benefit from that.

But in both scenarios, as far as I understand, it's just about adding support to event-based telemetry (which we already do with the existing ui_metric API, we simply store it and report it in a way that it's meaningless).

Is there any other type of standardisation we can do?

@TinaHeiligers
Copy link
Contributor Author

@afharo we need to see if there are custom usage collectors that have similar enough implementations to figure out if we can develop other types of standard/general collectors to suit those needs. If we could offer a customizable general usage collector that other plugins could "tweak" to get their job done and offer that through core too, that would be great! If, however, the custom collectors differ sufficiently from each other, then we can't really offer anything else right now.

@TinaHeiligers TinaHeiligers changed the title [Usage Collection] [Meta] Standardize usage collection [Usage Collection] [Meta] Enhance usage collection with richer API's Aug 17, 2020
@afharo
Copy link
Member

afharo commented Dec 10, 2020

I think the only missing bit is #81645. Let's close this issue for the sake of housekeeping :)

@afharo afharo closed this as completed Dec 10, 2020
@lukeelmers lukeelmers added the Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc label Oct 1, 2021
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-core (Team:Core)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature:Telemetry Meta Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc
Projects
None yet
Development

No branches or pull requests

4 participants