[Lens] add performance journey to track rendering time for XY visualization and suggestions panel #163412

dmlemeshko · 2023-08-08T13:44:40Z

Summary

Related to #163089

Adding the first performance journey for the Lens Editor. It simulated loading existing Lens visualisation with data view having 10k fields.

We collect the following metrics:

fetchFieldsExistenceInfo reports time it takes to fetch fields in Data Panel
lensVisualizationRenderTime reports both time it takes to fetch the data (time_to_data) and render the main visualization (time_to_render)
lensSuggestionsRenderTime reports time it takes to render suggestions panel

Metrics consistency

Run locally with

node scripts/functional_tests --config x-pack/performance/journeys/many_fields_lens_editor.ts

Metrics will be available here
https://telemetry-v2-staging.elastic.dev/s/kibana-performance/app/dashboards#/view/dd0473ac-826f-5621-9a10-25319700326e?_g=h@61c5ac8

drewdaemon · 2023-08-08T14:53:57Z

packages/kbn-unified-field-list/src/hooks/use_existing_fields.ts

@@ -178,6 +179,8 @@ export const useExistingFieldsFetcher = (
  const dataViewsHash = getDataViewsHash(params.dataViews);
  const refetchFieldsExistenceInfo = useCallback(
    async (dataViewId?: string) => {
+      const startTime = window.performance.now();


@jughosta does the way we're thinking of measuring field list loading make sense to you?

@drewdaemon Yes, currently we get fields from dataView class and make this additional call to separate "Empty" fields in the sidebar. As long as we specify that it's fetchFieldsExistenceInfo request metrics, it's correct.

The calculations for grouping logic are happening in packages/kbn-unified-field-list/src/hooks/use_grouped_fields.ts

I think what we're really going for the total time it takes to load the field list in Lens.

It sounds like you're saying we can assume that the fields are already present on the client so this existence check is the only network call we need to account for. Is that right?

@drewdaemon Yes, right now it's the only request we make for the field list. But it will change in the future. @mattkime is working on RFC to load fields async and separately from data view info. Once we apply this change, we can sum both loading durations.

jughosta · 2023-08-08T15:20:23Z

packages/kbn-unified-field-list/src/hooks/use_existing_fields.ts

+      reportPerformanceMetricEvent(params.services.core.analytics, {
+        eventName: metricEventName,
+        duration: window.performance.now() - startTime,
+        meta: { dataViews: params.dataViews.map((v) => v.name) },


Do we want to track data view name or data view id to apply the same in both places?

meta: { dataViewId },

vs

meta: { dataViews: params.dataViews.map((v) => v.name) },

@jughosta good catch! Probably name is easier to understand but I'm curious if from development perspective it is better to have id?

Not sure how we would use this meta info. Another idea: store only data views count.

…r-journey

dmlemeshko · 2023-08-16T06:18:01Z

x-pack/performance/journeys/many_fields_lens_editor.ts

+    await page.waitForSelector(subj('table-is-ready'));
+    // wait extra 5 seconds
+    await page.waitForTimeout(5000);
+  })


Without extra sleep metrics are inconsistent

With 5 extra sec wait on landing page

jughosta

Data Discovery changes LGTM 👍

jbudz

ftr_configs.yml

drewdaemon

This is great. I suggest we document the reason for the pause in a code comment.

Thanks for your great work on this!

x-pack/performance/journeys/many_fields_lens_editor.ts

Co-authored-by: Drew Tate <[email protected]>

pheyos

LGTM

kibana-ci · 2023-08-17T09:12:31Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: 3485fc2

Failed CI Steps

Test Failures

[job] [logs] FTR Configs #49 / Actions and Triggers app Home page Loads the app with limited privileges Loads the Alerts page
[job] [logs] FTR Configs #58 / Machine Learning modules get_module lists all modules

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`discoverLogExplorer`	313	317	+4
`eventAnnotation`	322	326	+4
`lens`	1135	1139	+4
total			+12

Async chunks

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

id	before	after	diff
`discover`	557.4KB	557.7KB	+340.0B
`lens`	1.4MB	1.4MB	+775.0B
total			+1.1KB

History

💚 Build #150966 succeeded 3e88562
💔 Build #150797 failed 7364cff
💚 Build #150543 succeeded e770337
💔 Build #150467 failed 9e07ad4
💚 Build #148379 succeeded fef081a
💔 Build #148356 failed 4aab3bd

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

kibanamachine · 2023-08-17T10:07:59Z

💚 All backports created successfully

Status	Branch	Result
✅	8.10

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

…zation and suggestions panel (elastic#163412) ## Summary Related to elastic#163089 Adding the first performance journey for the Lens Editor. It simulated loading existing Lens visualisation with data view having 10k fields. We collect the following metrics: - `fetchFieldsExistenceInfo` reports time it takes to fetch fields in Data Panel - `lensVisualizationRenderTime` reports both time it takes to fetch the data (`time_to_data`) and render the main visualization (`time_to_render`) - `lensSuggestionsRenderTime` reports time it takes to render suggestions panel Metrics consistency <img width="568" alt="image" src="https://github.com/elastic/kibana/assets/10977896/3384bb8e-6152-4bae-93dc-4f7f4167ed07"> Run locally with ``` node scripts/functional_tests --config x-pack/performance/journeys/many_fields_lens_editor.ts ``` Metrics will be available here https://telemetry-v2-staging.elastic.dev/s/kibana-performance/app/dashboards#/view/dd0473ac-826f-5621-9a10-25319700326e?_g=h@61c5ac8 --------- Co-authored-by: Drew Tate <[email protected]> (cherry picked from commit 15b118c)

…visualization and suggestions panel (#163412) (#164153) # Backport This will backport the following commits from `main` to `8.10`: - [[Lens] add performance journey to track rendering time for XY visualization and suggestions panel (#163412)](#163412)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)  Co-authored-by: Dzmitry Lemechko <[email protected]>

dmlemeshko added 3 commits August 8, 2023 12:04

collect metric for 'fetchFieldsExistenceInfo'

61c89d1

collect metrics for loading suggestion panel & main visualization

3d1a134

add journey

5895bd4

dmlemeshko requested a review from drewdaemon August 8, 2023 13:44

dmlemeshko added 4 commits August 8, 2023 15:45

cleanup

4aab3bd

fix wait for listing page to be loaded

bb0fc89

cleanup

9b3f7b0

fix jest test

fef081a

drewdaemon reviewed Aug 8, 2023

View reviewed changes

jughosta reviewed Aug 8, 2023

View reviewed changes

dmlemeshko added release_note:skip Skip the PR/issue when compiling release notes v8.10.0 performance labels Aug 8, 2023

dmlemeshko added 6 commits August 8, 2023 21:39

calculate endTime properly

9c66c7d

use different lens SO

7fa7f99

Merge remote-tracking branch 'upstream/main' into perf/add-lens-edito…

d679929

…r-journey

update meta with data views count

fae400e

update journey

9e07ad4

fix error

e770337

dmlemeshko commented Aug 16, 2023

View reviewed changes

Merge branch 'main' into perf/add-lens-editor-journey

7364cff

dmlemeshko marked this pull request as ready for review August 16, 2023 06:19

dmlemeshko requested review from a team as code owners August 16, 2023 06:19

dmlemeshko requested review from drewdaemon and jughosta August 16, 2023 06:19

jughosta approved these changes Aug 16, 2023

View reviewed changes

Merge branch 'main' into perf/add-lens-editor-journey

3e88562

jbudz approved these changes Aug 16, 2023

View reviewed changes

drewdaemon approved these changes Aug 16, 2023

View reviewed changes

x-pack/performance/journeys/many_fields_lens_editor.ts Outdated Show resolved Hide resolved

dmlemeshko and others added 2 commits August 17, 2023 09:57

Update x-pack/performance/journeys/many_fields_lens_editor.ts

d8dc8f6

Co-authored-by: Drew Tate <[email protected]>

Merge branch 'main' into perf/add-lens-editor-journey

3485fc2

dmlemeshko added the v8.11.0 label Aug 17, 2023

pheyos approved these changes Aug 17, 2023

View reviewed changes

dmlemeshko merged commit 15b118c into elastic:main Aug 17, 2023
30 checks passed

kibanamachine mentioned this pull request Aug 17, 2023

[8.10] [Lens] add performance journey to track rendering time for XY visualization and suggestions panel (#163412) #164153

Merged

This was referenced Oct 1, 2023

[8.10] fix(slo): Handle partial indicator url state (#167247) #167722

Merged

[8.10] backport SLO fixes #168231

Merged

dmlemeshko deleted the perf/add-lens-editor-journey branch November 21, 2023 12:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Lens] add performance journey to track rendering time for XY visualization and suggestions panel #163412

[Lens] add performance journey to track rendering time for XY visualization and suggestions panel #163412

dmlemeshko commented Aug 8, 2023 •

edited by kibanamachine

Loading

drewdaemon Aug 8, 2023

jughosta Aug 8, 2023

jughosta Aug 8, 2023

drewdaemon Aug 8, 2023

jughosta Aug 8, 2023

jughosta Aug 8, 2023

dmlemeshko Aug 8, 2023

jughosta Aug 8, 2023

dmlemeshko Aug 16, 2023

jughosta left a comment

jbudz left a comment

drewdaemon left a comment

pheyos left a comment

kibana-ci commented Aug 17, 2023

kibanamachine commented Aug 17, 2023

[Lens] add performance journey to track rendering time for XY visualization and suggestions panel #163412

[Lens] add performance journey to track rendering time for XY visualization and suggestions panel #163412

Conversation

dmlemeshko commented Aug 8, 2023 • edited by kibanamachine Loading

Summary

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jughosta left a comment

Choose a reason for hiding this comment

jbudz left a comment

Choose a reason for hiding this comment

drewdaemon left a comment

Choose a reason for hiding this comment

pheyos left a comment

Choose a reason for hiding this comment

kibana-ci commented Aug 17, 2023

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

Metrics [docs]

Module Count

Async chunks

History

kibanamachine commented Aug 17, 2023

💚 All backports created successfully

Questions ?

dmlemeshko commented Aug 8, 2023 •

edited by kibanamachine

Loading