kibana/dev_docs/tutorials/performance
Kibana Machine d5d94ac66f
[9.0] Update TTFMP documentation for meta fields. (#221807) (#223317)
# Backport

This will backport the following commits from `main` to `9.0`:
- [Update TTFMP documentation for meta fields.
(#221807)](https://github.com/elastic/kibana/pull/221807)

<!--- Backport version: 9.6.6 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sorenlouv/backport)

<!--BACKPORT [{"author":{"name":"Abdul Wahab
Zahid","email":"awahab07@yahoo.com"},"sourceCommit":{"committedDate":"2025-06-10T22:14:05Z","message":"Update
TTFMP documentation for meta fields. (#221807)\n\nEnhances the
performance metrics documentation by explaining how\nto use the
`meta.description` field for contextualizing render time\nevents and how
to track subsequent page or section loads
using\n`onPageRefreshStart`.\n\n\n- Added a section describing the
default meaning of render time and how\nto provide a custom
`description` in the `meta` field of `onPageReady`\nfor more precise
event context.\n- Documented the use of `onPageRefreshStart` to
distinguish between\ninitial loads and subsequent refreshes, clarifying
that\n`meta.isInitialLoad` is set to `false` for refreshes and `true`
by\ndefault.\n- Included code examples and sample indexed event
structures for
both\nfeatures.","sha":"ca05a06f00e013a18198cb46ce051d64f0d3f4b1","branchLabelMapping":{"^v9.1.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","backport:prev-minor","v8.18.0","v9.1.0","v8.19.0"],"title":"Update
TTFMP documentation for meta
fields.","number":221807,"url":"https://github.com/elastic/kibana/pull/221807","mergeCommit":{"message":"Update
TTFMP documentation for meta fields. (#221807)\n\nEnhances the
performance metrics documentation by explaining how\nto use the
`meta.description` field for contextualizing render time\nevents and how
to track subsequent page or section loads
using\n`onPageRefreshStart`.\n\n\n- Added a section describing the
default meaning of render time and how\nto provide a custom
`description` in the `meta` field of `onPageReady`\nfor more precise
event context.\n- Documented the use of `onPageRefreshStart` to
distinguish between\ninitial loads and subsequent refreshes, clarifying
that\n`meta.isInitialLoad` is set to `false` for refreshes and `true`
by\ndefault.\n- Included code examples and sample indexed event
structures for
both\nfeatures.","sha":"ca05a06f00e013a18198cb46ce051d64f0d3f4b1"}},"sourceBranch":"main","suggestedTargetBranches":["9.0","8.18","8.19"],"targetPullRequestStates":[{"branch":"9.0","label":"v9.0.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.18","label":"v8.18.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/221807","number":221807,"mergeCommit":{"message":"Update
TTFMP documentation for meta fields. (#221807)\n\nEnhances the
performance metrics documentation by explaining how\nto use the
`meta.description` field for contextualizing render time\nevents and how
to track subsequent page or section loads
using\n`onPageRefreshStart`.\n\n\n- Added a section describing the
default meaning of render time and how\nto provide a custom
`description` in the `meta` field of `onPageReady`\nfor more precise
event context.\n- Documented the use of `onPageRefreshStart` to
distinguish between\ninitial loads and subsequent refreshes, clarifying
that\n`meta.isInitialLoad` is set to `false` for refreshes and `true`
by\ndefault.\n- Included code examples and sample indexed event
structures for
both\nfeatures.","sha":"ca05a06f00e013a18198cb46ce051d64f0d3f4b1"}},{"branch":"8.19","label":"v8.19.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Abdul Wahab Zahid <awahab07@yahoo.com>
2025-06-11 02:04:49 +02:00
..
adding_api_capacity_test.mdx [docs] escape code with curly brackets to fix docs build 2023-01-18 13:16:07 -07:00
adding_custom_performance_metrics.mdx [9.0] Update TTFMP documentation for meta fields. (#221807) (#223317) 2025-06-11 02:04:49 +02:00
adding_performance_journey.mdx [9.0] SKA: Relocate "platform" packages that remain on /packages (#208704) (#212224) 2025-02-28 10:10:29 +01:00
running_performance_journey_in_cloud.mdx [9.0] SKA: Relocate "platform" packages that remain on /packages (#208704) (#212224) 2025-02-28 10:10:29 +01:00