Report telemetry for autocomplete #91428

lizozom · 2021-02-15T17:24:26Z

Summary

Added some telemetry around the data plugin

Autocomplete interactions

error count
position of selected suggestion
length of query used to generate the suggestions

This should allow us to analyze how often and how well users engage with our existing Autocomplete results.

Value suggestions requests

Autocomplete requests triggered
Autocomplete request sent to server (memoize cache miss)
Autocomplete response received
Autocomplete Error

Other UI components

query language switch
filter bar bulk actions

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)
If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the docker list
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

* error cound * position of selected suggestion * length of query used to generate the suggestions Also added a couple if handly telemetry events: * query language switch * filter bar bulk actions

…autocomplete-telemetry

elasticmachine · 2021-02-16T13:28:19Z

Pinging @elastic/kibana-app-services (Team:AppServices)

src/plugins/data/public/autocomplete/providers/value_suggestion_provider.ts

Dosant · 2021-02-16T14:03:35Z

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

-    if (props.trackUiMetric) {
-      props.trackUiMetric(METRIC_TYPE.CLICK, `${props.appName}:filter_invertInclusion`);
-    }
+    reportUiCounter?.(METRIC_TYPE.CLICK, `filter:invert_all`);


Does this change how we report existing metrics? Isn't it breaking as it would make those harder to analyze?

We never analyze them anyway...
I thought it was good timing for some standardization

Since this was added by kibana/app #82709, #82961
I think we should ping them for reviewing these changes? In case they analyzing those.

@majagrubic would you mind taking a look?
I wanted to align the names of telemetry events. Will this break anything for you?

Thanks!

Is my understanding correct here that we're no longer tracking the appName with the metric? This would make it impossible for us to track which clicks came from inside Discover for example?

As I understood, we get an appname thanks to the binding right here:
https://github.com/elastic/kibana/pull/91428/files#diff-b370985f7060e1ee97121c246b0ac878bf5b1dee2271e0593a983f893141109eR47

@majagrubic We still report the appName, I just renamed some of the events themselves and it should be easier to analyze as the appName now is in its own field

I think it's fine with us, we're not actively using these metrics yet.

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

src/plugins/data/public/autocomplete/collectors/create_usage_collector.ts

lizozom · 2021-02-17T08:39:11Z

@elasticmachine merge upstream

Dosant

LGTM

Dosant · 2021-02-17T10:18:15Z

src/plugins/data/public/autocomplete/providers/value_suggestion_provider.ts

+      return await requestSuggestions(title, field, query, filters, signal);
+    } catch (e) {
+      if (!signal?.aborted) {
+        usageCollector?.trackError();


nit: I think this also belongs to requestSuggestions and should be similar to usageCollector?.trackResult(); call

I agree, but I didn't want to delete anything from requestSugestions.cache before the function returned.

kibanamachine · 2021-02-17T10:47:58Z

💚 Build Succeeded

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`data`	701	704	+3

Async chunks

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

id	before	after	diff
`data`	236.3KB	225.6KB	-10.6KB

Page load bundle

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

id	before	after	diff
`data`	909.0KB	911.2KB	+2.2KB

History

💚 Build #106934 succeeded 815b636
💚 Build #106890 succeeded e223061
💔 Build #106847 failed 3ecb615
💔 Build #106830 failed 5ecdcbd
💔 Build #106812 failed 7dfa358

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

* Report telemetry about autocomplete * error cound * position of selected suggestion * length of query used to generate the suggestions Also added a couple if handly telemetry events: * query language switch * filter bar bulk actions * Fix ts * Report the value suggestions funnel * docs * docs * fix jest * test * code review Co-authored-by: Kibana Machine <[email protected]>

* Report telemetry about autocomplete * error cound * position of selected suggestion * length of query used to generate the suggestions Also added a couple if handly telemetry events: * query language switch * filter bar bulk actions * Fix ts * Report the value suggestions funnel * docs * docs * fix jest * test * code review Co-authored-by: Kibana Machine <[email protected]> Co-authored-by: Kibana Machine <[email protected]>

Liza K added 4 commits February 15, 2021 18:32

Report telemetry about autocomplete

4c84050

* error cound * position of selected suggestion * length of query used to generate the suggestions Also added a couple if handly telemetry events: * query language switch * filter bar bulk actions

Fix ts

320e723

Report the value suggestions funnel

69cdc32

Merge branch 'master' of github.com:elastic/kibana into make-it-slow/…

f3a60f2

…autocomplete-telemetry

lizozom self-assigned this Feb 16, 2021

lizozom added Feature:Telemetry Team:AppServices v8.0.0 release_note:skip Skip the PR/issue when compiling release notes labels Feb 16, 2021

lizozom marked this pull request as ready for review February 16, 2021 13:28

lizozom requested a review from a team as a code owner February 16, 2021 13:28

docs

7dfa358

Dosant reviewed Feb 16, 2021

View reviewed changes

docs

5ecdcbd

Dosant added v7.12.0 and removed v7.12 labels Feb 16, 2021

fix jest

3ecb615

lizozom requested a review from Dosant February 16, 2021 15:12

Dosant reviewed Feb 16, 2021

View reviewed changes

src/plugins/data/public/ui/filter_bar/filter_bar.tsx Outdated Show resolved Hide resolved

src/plugins/data/public/ui/filter_bar/filter_bar.tsx Outdated Show resolved Hide resolved

src/plugins/data/public/autocomplete/collectors/create_usage_collector.ts Show resolved Hide resolved

Liza K added 2 commits February 16, 2021 18:08

test

e223061

code review

815b636

lizozom requested a review from Dosant February 16, 2021 17:55

Merge branch 'master' into make-it-slow/autocomplete-telemetry

97786a1

Dosant approved these changes Feb 17, 2021

View reviewed changes

lizozom requested a review from majagrubic February 17, 2021 11:27

majagrubic approved these changes Feb 17, 2021

View reviewed changes

lizozom merged commit 98bd8e0 into elastic:master Feb 17, 2021

lizozom mentioned this pull request Feb 17, 2021

[7.x] Report telemetry for autocomplete (#91428) #91648

Merged

lizozom mentioned this pull request Feb 25, 2021

[Autocomplete] Integrate new autocomplete API #92783

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Report telemetry for autocomplete #91428

Report telemetry for autocomplete #91428

lizozom commented Feb 15, 2021 •

edited

Loading

elasticmachine commented Feb 16, 2021

Dosant Feb 16, 2021

lizozom Feb 16, 2021

Dosant Feb 16, 2021

lizozom Feb 17, 2021

majagrubic Feb 17, 2021

Dosant Feb 17, 2021

lizozom Feb 17, 2021 •

edited

Loading

majagrubic Feb 17, 2021

lizozom commented Feb 17, 2021

Dosant left a comment

Dosant Feb 17, 2021

lizozom Feb 17, 2021

kibanamachine commented Feb 17, 2021

Report telemetry for autocomplete #91428

Report telemetry for autocomplete #91428

Conversation

lizozom commented Feb 15, 2021 • edited Loading

Summary

Autocomplete interactions

Value suggestions requests

Other UI components

Checklist

For maintainers

elasticmachine commented Feb 16, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lizozom Feb 17, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lizozom commented Feb 17, 2021

Dosant left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kibanamachine commented Feb 17, 2021

💚 Build Succeeded

Metrics [docs]

Module Count

Async chunks

Page load bundle

History

lizozom commented Feb 15, 2021 •

edited

Loading

lizozom Feb 17, 2021 •

edited

Loading