[Data-Plugin] Add telemetry around query/filter bar usage #82709

majagrubic · 2020-11-05T12:57:42Z

Summary

As part of #58747, we'd like to add a metric around "the number of times a query is submitted from search bar vs filter is added.

I tested this by querying saved objects API:
http://localhost:5601/dov/api/saved_objects/_find?type=ui-metric and inspecting the response:

{"type":"ui-metric","id":"discover:query_submit","attributes":{"count":6},"references":[],"updated_at":"2020-11-05T12:33:12.014Z","version":"WzEzMiwxXQ==","score":0},{"type":"ui-metric","id":"discover:filter_added","attributes":{"count":3},"references":[],"updated_at":"2020-11-05T12:33:43.107Z","version":"WzEzNywxXQ==","score":0}

This PR adds the trackUiMetric ability to data plugin. Additionally, it introduces metrics around query/filter bar usage:

query_submitted metric, when a query is submitted from a search bar
filter_added metric, when a filter is added from a filter bar
filter_edited, when a filter is edited
filter_invertInclusion when filter results are included/excluded
filter_toggleAllDisabled when a filter is enabled/disabled

All metrics are prefixed with the appropriate appName for easier tracking.

Checklist

Delete any items that are not applicable to this PR.

~~- [ ] Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support~~

Documentation was added for features that require explanation or tutorials
Unit or functional tests were updated or added to match the most common scenarios
~~- [ ] Any UI touched in this PR is usable by keyboard only (learn more about keyboard accessibility)~~
~~- [ ] Any UI touched in this PR does not create any new axe failures (run axe in browser: FF, Chrome)~~
~~- [ ] This renders correctly on smaller devices using a responsive layout. (You can test this in your browser)~~
~~- [ ] This was checked for cross-browser compatibility~~

For maintainers

This was checked for breaking API changes and was labeled appropriately

elasticmachine · 2020-11-05T14:32:51Z

Pinging @elastic/kibana-app (Team:KibanaApp)

kertal

There seems to be a problem when you load the application multiple events are tracked

what users use more filters or search bar - maybe calculate the number of times a query is submitted from search bar vs filter is added

dear @AlonaNadler maybe you meant the number of times a filter is added by using the field selector, the data table, the document view compared to the usage of the search bar including the filters there?

lizozom

I think all apps would benefit from this. Lets add this directly into the SearchBar component for all apps.
Also avoiding adding new callbacks to this component is preferable, as we want to have an Observable base API.

src/plugins/discover/public/application/components/discover_legacy.tsx

src/plugins/data/public/types.ts

lizozom · 2020-11-06T15:38:49Z

Review telemetry from SearchBar

AlonaNadler · 2020-11-06T17:18:09Z

dear @AlonaNadler maybe you meant the number of times a filter is added by using the field selector, the data table, the document view compared to the usage of the search bar including the filters there?

@kertal I think you are right, can we add the number of times a filter is added either explicitly, from the table or the document view. Im addition can we collect the number of times users interact with the filter ? counting the number of times users use either edit filter, exclude or include results, and temporary disable or enable?

lizozom · 2020-11-09T11:51:36Z

@elasticmachine merge upstream

lizozom

Looks great. I think we can add the additional metrics @AlonaNadler suggests.
Can't wait to see the results.

lizozom · 2020-11-06T14:29:00Z

src/plugins/data/public/ui/search_bar/create_search_bar.tsx

 }

 export type StatefulSearchBarProps = SearchBarOwnProps & {
  appName: string;
  useDefaultBehaviors?: boolean;
  savedQueryId?: string;
  onSavedQueryIdChange?: (savedQueryId?: string) => void;
+  onFilterAdded?: () => void;


I think this can be removed

I think it was, you must be looking at the old commit 🤔

It's actually a comment from last week :-D
Sorry

kibanamachine · 2020-11-10T10:46:28Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: 1380c60

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`data`	587	597	+10

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`data`	235.0KB	245.4KB	+10.4KB

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`data`	963.2KB	963.5KB	+354.0B

History

💚 Build #86731 succeeded c31c469
💚 Build #86715 succeeded b38fd8e
💚 Build #86422 succeeded 2e2c423
💚 Build #86404 succeeded 986ee7f
💔 Build #86399 failed 200d2a4

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

kertal · 2020-11-10T11:13:54Z

src/plugins/data/public/ui/filter_bar/filter_bar.tsx

+    if (props.trackUiMetric) {
+      props.trackUiMetric(METRIC_TYPE.CLICK, `${props.appName}:filter_invertInclusion`);
+    }


@lizozom there are more functions here like onDisableAll, onPinAll, since this PR started to add metric to some of them this functions, I wonder if it makes sense to add metric to all of them?

kertal

Code LGTM, tested locally, works 👍 in Discover, Visualize, Dashboard , added a note if it makes sense to add more metrics, and would suggest to updated the PR's description with all new metrics that were introduced and if it also makes sense to track removing of filters?

majagrubic · 2020-11-10T14:13:54Z

Thanks @kertal. I've updated the PR description. Not sure about adding more metrics - my feeling is we shouldn't be emitting unnecessary metrics if there is no need for that. But will defer the decision to @lizozom, since app-arch own these particular components.

…83157) * [Discover] Add telemetry around query/filter bar usage * Updating documentation * Adding a separate method for tracking query submit * Updating doc changes * Adding trackUiMetric to Data plugin * Doc changes * Do not make usageCollection a start dependency * Updating documentation * Adding metrics for filter inclusion, edit, and disabled * updating docs Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

Maja Grubic added 2 commits November 5, 2020 12:50

[Discover] Add telemetry around query/filter bar usage

4732c94

Updating documentation

1035730

majagrubic added release_note:roadmap v7.11.0 Team:Visualizations Visualization editors, elastic-charts and infrastructure Feature:Discover Discover Application labels Nov 5, 2020

majagrubic marked this pull request as ready for review November 5, 2020 14:32

majagrubic requested a review from a team November 5, 2020 14:32

majagrubic requested a review from a team as a code owner November 5, 2020 14:32

majagrubic requested review from kertal and lizozom November 5, 2020 14:32

kertal reviewed Nov 6, 2020

View reviewed changes

Maja Grubic added 2 commits November 6, 2020 09:43

Adding a separate method for tracking query submit

d2cbb48

Updating doc changes

51136a3

lizozom suggested changes Nov 6, 2020

View reviewed changes

src/plugins/discover/public/application/components/discover_legacy.tsx Outdated Show resolved Hide resolved

Adding trackUiMetric to Data plugin

200d2a4

lizozom reviewed Nov 6, 2020

View reviewed changes

src/plugins/data/public/types.ts Outdated Show resolved Hide resolved

Doc changes

986ee7f

botelastic bot added the Feature:Embedding Embedding content via iFrame label Nov 6, 2020

majagrubic changed the title ~~[Discover] Add telemetry around query/filter bar usage~~ [Data-Plugin] Add telemetry around query/filter bar usage Nov 6, 2020

Maja Grubic added 2 commits November 6, 2020 14:42

Do not make usageCollection a start dependency

b261f3f

Updating documentation

2e2c423

Merge branch 'master' into discover-telemetry-2

b38fd8e

lizozom approved these changes Nov 9, 2020

View reviewed changes

Maja Grubic added 2 commits November 9, 2020 12:56

Adding metrics for filter inclusion, edit, and disabled

c31c469

Merge master

bf6e87e

updating docs

1380c60

majagrubic requested a review from kertal November 10, 2020 09:01

kertal reviewed Nov 10, 2020

View reviewed changes

kertal approved these changes Nov 10, 2020

View reviewed changes

majagrubic merged commit cb27a72 into elastic:master Nov 11, 2020

majagrubic deleted the discover-telemetry-2 branch November 11, 2020 12:18

majagrubic mentioned this pull request Nov 11, 2020

[7.x] [Data-Plugin] Add telemetry around query/filter bar usage (#82709) #83157

Merged

Dosant mentioned this pull request Feb 16, 2021

Report telemetry for autocomplete #91428

Merged

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Data-Plugin] Add telemetry around query/filter bar usage #82709

[Data-Plugin] Add telemetry around query/filter bar usage #82709

majagrubic commented Nov 5, 2020 •

edited

Loading

elasticmachine commented Nov 5, 2020

kertal left a comment

lizozom left a comment •

edited

Loading

lizozom commented Nov 6, 2020

AlonaNadler commented Nov 6, 2020 •

edited

Loading

lizozom commented Nov 9, 2020

lizozom left a comment

lizozom Nov 6, 2020

majagrubic Nov 9, 2020

lizozom Nov 9, 2020

kibanamachine commented Nov 10, 2020

kertal Nov 10, 2020

kertal left a comment

majagrubic commented Nov 10, 2020

[Data-Plugin] Add telemetry around query/filter bar usage #82709

[Data-Plugin] Add telemetry around query/filter bar usage #82709

Conversation

majagrubic commented Nov 5, 2020 • edited Loading

Summary

Checklist

For maintainers

elasticmachine commented Nov 5, 2020

kertal left a comment

Choose a reason for hiding this comment

lizozom left a comment • edited Loading

Choose a reason for hiding this comment

lizozom commented Nov 6, 2020

AlonaNadler commented Nov 6, 2020 • edited Loading

lizozom commented Nov 9, 2020

lizozom left a comment

Choose a reason for hiding this comment

lizozom Nov 6, 2020

Choose a reason for hiding this comment

majagrubic Nov 9, 2020

Choose a reason for hiding this comment

lizozom Nov 9, 2020

Choose a reason for hiding this comment

kibanamachine commented Nov 10, 2020

💚 Build Succeeded

Metrics [docs]

Module Count

Async chunks

Page load bundle

History

kertal Nov 10, 2020

Choose a reason for hiding this comment

kertal left a comment

Choose a reason for hiding this comment

majagrubic commented Nov 10, 2020

majagrubic commented Nov 5, 2020 •

edited

Loading

lizozom left a comment •

edited

Loading

AlonaNadler commented Nov 6, 2020 •

edited

Loading