[Perfomance] Add `is_initial_load` meta #206645

kpatticha · 2025-01-14T17:26:05Z

closes https://github.com/elastic/observability-dev/issues/4185

Summary

This PR adds the is_initial_load parameter to the meta field to distinguish whether the onPageReady trigger occurs during the initial load or a page refresh.

Refactoring:

Removed the target field. as context.pageName now provides the necessary information
Refactor APM instrumentation to simplify it

Fixes:

https://github.com/elastic/observability-dev/issues/3464

⚠️ Instrumentation

The plugins need to call the following function:

onPageRefreshStart()

This method adds a performance marker start::pageRefresh to indicate when a page refresh begins. This marker is used along with an end marker end::pageReady to determine the total refresh duration.

Screen.Recording.2025-02-14.at.12.39.54.PM.mov

Screen.Recording.2025-02-14.at.12.43.29.PM.mov

How to test

Checkout the PR
make sure you run yarn kbn bootstrap
go to any page that has onPageReady function instrumented (ex services)

TODO

Once approved, update docs

afharo

Approving from the Core POV because a Set is better than a string[].

I added a comment because I'd love to understand what we're trying to track here.

...m/packages/shared/kbn-ebt-tools/src/performance_metrics/context/measure_interaction/index.ts

maryam-saeidi

Awesome! 🥇

Do we also have a way to distinguish whether the event was related to a page load via inside Kibana navigation or the initial load of Kibana?

kpatticha · 2025-01-17T11:13:57Z

Awesome! 🥇

Do we also have a way to distinguish whether the event was related to a page load via inside Kibana navigation or the initial load of Kibana?

with the current implementation we don't have a way to distinguish this. There is another EBT metric, kibana_started, which we might be able to correlate with these two events using their timestamps. However, this would require additional analysis work.

awahab07

is_initial_load changes with date change because selected time range is persisted via URL state. Also, URL could change even against UI actions which do not cause a data reload.

206645-initial-load-meta-url-issue.mov

See if extracting the plugin url or using pathname is better suited here instead of the full url.

kpatticha · 2025-01-20T10:07:11Z

is_initial_load changes with date change because selected time range is persisted via URL state. Also, URL could change even against UI actions which do not cause a data reload.

206645-initial-load-meta-url-issue.mov
See if extracting the plugin url or using pathname is better suited here instead of the full url.

Thanks, I will take a look

kpatticha · 2025-01-23T10:14:01Z

I discovered a bug while addressing the issue Abdul mentioned. The initial marker isn't removed when the page is refreshed, causing it to report an incorrect duration.

elasticmachine · 2025-02-14T10:24:52Z

Pinging @elastic/obs-ux-infra_services-team (Team:obs-ux-infra_services)

kpatticha · 2025-02-14T10:59:17Z

Since I found the bug, I refactored and updated the code. I'm requesting another review. 🙏

kpatticha · 2025-02-17T14:34:23Z

@elasticmachine merge upstream

miloszmarcinkowski

LGTM (code review only)

…4185-initial-load

maryam-saeidi

Checked locally, LGTM! Thanks for the thorough PR description :)

Is my observation correct that only the highlighted tabs in the following screenshot are instrumented with onPageReady? (I didn't see the ttfmp log on other tabs of this page)

maryam-saeidi · 2025-02-18T10:32:21Z

...m/packages/shared/kbn-ebt-tools/src/performance_metrics/context/measure_interaction/index.ts

+        performance.clearMarks(perfomanceMarkers.endPageReady);
+      }
+
+      if (


Just curious, is there a scenario in which the onPageReady is called, but none of these two conditions are called?

You mean startPageRefresh ?

No, I mean the onPageReady function, which has this logic; suppose that it is called, but none of these two conditions are met. Is it possible?

I don't think it's possible. At least the first statement will always be true at least once. In the initial load.

awahab07

When checking locally, I found that for Metrics Explorer, the refresh duration is very low (it seems it's instantaneous) and doesn't account for the network request time.

The initial load duration looks fine.

206645-Refresh-Duration-Very-Low.mov

awahab07 · 2025-02-18T12:32:36Z

...rm/packages/shared/kbn-ebt-tools/src/performance_metrics/context/use_performance_context.tsx

+   * The marker set by this function can later be used in performance measurements
+   * along with an end marker end::pageReady to determine the total refresh duration.
+   */
+  markPerformanceRefreshStart(): void;


Suggested change

markPerformanceRefreshStart(): void;

onPageRefreshStart(): void;

To be consistent with onPageReady and to abstract the performance marking bit. Not a strong opinion though.

Thanks for the suggestion. I will update

kpatticha · 2025-02-18T14:14:21Z

Checked locally, LGTM! Thanks for the thorough PR description :)

Is my observation correct that only the highlighted tabs in the following screenshot are instrumented with onPageReady? (I didn't see the ttfmp log on other tabs of this page)

The service map tab should also report TTFMP .

Metrics tab uses static dashboards to show charts for some of the agents
Infrastructure tab is in beta and we don't invest much time and effort on it
the rest tabs use mainly embeddable for their content

kpatticha · 2025-02-18T16:28:58Z

When checking locally, I found that for Metrics Explorer, the refresh duration is very low (it seems it's instantaneous) and doesn't account for the network request time.

The initial load duration looks fine.

206645-Refresh-Duration-Very-Low.mov

Good catch. Fixed it here 294a3e5

awahab07

The refresh duration on Metrics Explorer is good now. But the date change is still instantaneous.

206645-Refresh-Date-Change-Issue.mov

kpatticha · 2025-02-25T11:39:32Z

@elasticmachine merge upstream

kpatticha · 2025-02-25T11:41:51Z

The refresh duration on Metrics Explorer is good now. But the date change is still instantaneous.

206645-Refresh-Date-Change-Issue.mov

Screen.Recording.2025-02-25.at.1.35.52.PM.mov

@awahab07 should be fixed now by c9be509 . it's been a bit strange how metrics explorer handles the loading state.

elasticmachine · 2025-02-25T13:31:13Z

💚 Build Succeeded

Buildkite Build
Commit: 117d6a2

Metrics [docs]

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
`@kbn/ebt-tools`	29	30	+1

Async chunks

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

id	before	after	diff
`apm`	2.3MB	2.3MB	+83.0B
`infra`	1.1MB	1.1MB	+215.0B
total			+298.0B

Page load bundle

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

id	before	after	diff
`core`	474.6KB	474.6KB	+38.0B
`kbnUiSharedDeps-srcJs`	3.6MB	3.6MB	+38.0B
total			+76.0B

Unknown metric groups

API count

id	before	after	diff
`@kbn/ebt-tools`	38	39	+1

History

awahab07

LGTM!

Thanks for adding the prop.

kibanamachine · 2025-02-25T18:49:10Z

Starting backport for target branches: 9.0

https://github.com/elastic/kibana/actions/runs/13528675783

kibanamachine · 2025-02-25T19:08:25Z

💔 All backports failed

Status	Branch	Result
❌	9.0	Backport failed because of merge conflicts

Manual backport

To create the backport manually run:

node scripts/backport --pr 206645

Questions ?

Please refer to the Backport tool documentation

[Perfomance] Add is_initial_load meta

d61eb1d

kpatticha requested a review from a team as a code owner January 14, 2025 17:26

kpatticha requested review from awahab07 and maryam-saeidi January 14, 2025 17:27

afharo approved these changes Jan 15, 2025

View reviewed changes

...m/packages/shared/kbn-ebt-tools/src/performance_metrics/context/measure_interaction/index.ts Outdated Show resolved Hide resolved

maryam-saeidi approved these changes Jan 16, 2025

View reviewed changes

kpatticha added 2 commits January 17, 2025 15:48

Merge branch 'main' into 4185-initial-load

42bb08a

Merge branch 'main' into 4185-initial-load

d03ad87

awahab07 reviewed Jan 17, 2025

View reviewed changes

kpatticha added 5 commits February 12, 2025 11:29

Merge branch 'main' of github.com:elastic/kibana into 4185-initial-load

06e16e0

[APM] Refactor ttmp instrumentation

4d6fde0

[Performance] Add ability to track ttfmp on refresh

4e914cc

Remove target

08662d7

[Infra] Track tttmp on refresh

7302198

kpatticha requested a review from a team as a code owner February 14, 2025 10:24

botelastic bot added the Team:obs-ux-infra_services Observability Infrastructure & Services User Experience Team label Feb 14, 2025

kpatticha requested review from maryam-saeidi, awahab07, rmyz and afharo February 14, 2025 10:57

Merge branch 'main' into 4185-initial-load

662cb3b

miloszmarcinkowski approved these changes Feb 17, 2025

View reviewed changes

kpatticha added 2 commits February 18, 2025 13:24

Fix eslint

23c098e

Merge branch '4185-initial-load' of github.com:kpatticha/kibana into …

0ec81ef

…4185-initial-load

maryam-saeidi approved these changes Feb 18, 2025

View reviewed changes

awahab07 reviewed Feb 18, 2025

View reviewed changes

Rename markPerformanceRefreshStart to onPageRefreshStart

da1b2c9

kpatticha added 2 commits February 18, 2025 18:14

Fix tests

4dd16aa

Fix onRefresh for metrics explorer

294a3e5

kpatticha requested a review from awahab07 February 18, 2025 16:29

kpatticha added 2 commits February 19, 2025 15:33

Fix lint

8914b20

Merge branch 'main' of github.com:elastic/kibana into 4185-initial-load

8fda218

awahab07 reviewed Feb 19, 2025

View reviewed changes

kpatticha added 4 commits February 25, 2025 12:42

Fix apm tests

4edf641

Fix tests

466045c

trigger onPageReady only when data changes

c9be509

Fix infra tests

3a95be3

Merge branch 'main' into 4185-initial-load

117d6a2

kpatticha requested a review from awahab07 February 25, 2025 11:41

awahab07 approved these changes Feb 25, 2025

View reviewed changes

kpatticha merged commit 9a1d70d into elastic:main Feb 25, 2025
9 checks passed

kibanamachine added the v9.1.0 label Feb 25, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Perfomance] Add `is_initial_load` meta #206645

[Perfomance] Add `is_initial_load` meta #206645

kpatticha commented Jan 14, 2025 •

edited by kibanamachine

Loading

afharo left a comment

maryam-saeidi left a comment

kpatticha commented Jan 17, 2025

awahab07 left a comment

kpatticha commented Jan 20, 2025

kpatticha commented Jan 23, 2025

elasticmachine commented Feb 14, 2025

kpatticha commented Feb 14, 2025

kpatticha commented Feb 17, 2025

miloszmarcinkowski left a comment

maryam-saeidi left a comment

maryam-saeidi Feb 18, 2025

kpatticha Feb 18, 2025

maryam-saeidi Feb 18, 2025

kpatticha Feb 18, 2025

awahab07 left a comment

awahab07 Feb 18, 2025

kpatticha Feb 18, 2025

kpatticha commented Feb 18, 2025

kpatticha commented Feb 18, 2025

awahab07 left a comment

kpatticha commented Feb 25, 2025

kpatticha commented Feb 25, 2025

elasticmachine commented Feb 25, 2025

API count

awahab07 left a comment

kibanamachine commented Feb 25, 2025

kibanamachine commented Feb 25, 2025

	markPerformanceRefreshStart(): void;
	onPageRefreshStart(): void;

[Perfomance] Add is_initial_load meta #206645

[Perfomance] Add is_initial_load meta #206645

Conversation

kpatticha commented Jan 14, 2025 • edited by kibanamachine Loading

Summary

⚠️ Instrumentation

How to test

TODO

afharo left a comment

Choose a reason for hiding this comment

maryam-saeidi left a comment

Choose a reason for hiding this comment

kpatticha commented Jan 17, 2025

awahab07 left a comment

Choose a reason for hiding this comment

kpatticha commented Jan 20, 2025

kpatticha commented Jan 23, 2025

elasticmachine commented Feb 14, 2025

kpatticha commented Feb 14, 2025

kpatticha commented Feb 17, 2025

miloszmarcinkowski left a comment

Choose a reason for hiding this comment

maryam-saeidi left a comment

Choose a reason for hiding this comment

maryam-saeidi Feb 18, 2025

Choose a reason for hiding this comment

kpatticha Feb 18, 2025

Choose a reason for hiding this comment

maryam-saeidi Feb 18, 2025

Choose a reason for hiding this comment

kpatticha Feb 18, 2025

Choose a reason for hiding this comment

awahab07 left a comment

Choose a reason for hiding this comment

awahab07 Feb 18, 2025

Choose a reason for hiding this comment

kpatticha Feb 18, 2025

Choose a reason for hiding this comment

kpatticha commented Feb 18, 2025

kpatticha commented Feb 18, 2025

awahab07 left a comment

Choose a reason for hiding this comment

kpatticha commented Feb 25, 2025

kpatticha commented Feb 25, 2025

elasticmachine commented Feb 25, 2025

💚 Build Succeeded

Metrics [docs]

Public APIs missing comments

Async chunks

Page load bundle

API count

History

awahab07 left a comment

Choose a reason for hiding this comment

kibanamachine commented Feb 25, 2025

kibanamachine commented Feb 25, 2025

💔 All backports failed

Manual backport

Questions ?

[Perfomance] Add `is_initial_load` meta #206645

[Perfomance] Add `is_initial_load` meta #206645

kpatticha commented Jan 14, 2025 •

edited by kibanamachine

Loading