[Perfomance] Add is_initial_load meta

[kpatticha]

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.

[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]

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]

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]

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]

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

[kpatticha]

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

[kpatticha]

@elasticmachine merge upstream

[kpatticha]

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]

💚 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

• 💔 Build #277682 failed 8914b20
• 💔 Build #277336 failed 294a3e5
• 💔 Build #277273 failed da1b2c9
• 💔 Build #277194 failed 0ec81ef
• 💔 Build #276946 failed 662cb3b

[awahab07]

LGTM!

Thanks for adding the prop.

[kibanamachine]

Starting backport for target branches: 9.0

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

[kibanamachine]

💔 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

[kibanamachine]

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add a backport:* label or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 206645 locally

[kibanamachine]

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add a backport:* label or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 206645 locally

[kibanamachine]

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add a backport:* label or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 206645 locally

[kibanamachine]

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add a backport:* label or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 206645 locally