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

[7.x] [telemetry] update README to downplay ui_metrics (#74635) #74753

Merged
merged 1 commit into from
Aug 11, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions src/plugins/usage_collection/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@ To integrate with the telemetry services for usage collection of your feature, t

All you need to provide is a `type` for organizing your fields, `schema` field to define the expected types of usage fields reported, and a `fetch` method for returning your usage data. Then you need to make the Telemetry service aware of the collector by registering it.

### New Platform

1. Make sure `usageCollection` is in your optional Plugins:

```json
Expand Down Expand Up @@ -205,6 +203,10 @@ There are a few ways you can test that your usage collector is working properly.

# UI Metric app

The UI metrics implementation in its current state is not useful. We are working on improving the implementation to enable teams to use the data to visualize and gather information from what is being reported. Please refer to the telemetry team if you are interested in adding ui_metrics to your plugin.

**Until a better implementation is introduced, please defer from adding any new ui metrics.**

## Purpose

The purpose of the UI Metric app is to provide a tool for gathering data on how users interact with
Expand Down