Add documentation for kibana:plugin_render_time
#184206
Conversation
🤖 GitHub commentsExpand to view the GitHub comments
Just comment with:
|
kpatticha
added
release_note:skip
|
adding @yngrdyn as reviewer, as you might use this in the future. Let me know if anything is missing or unclear |
| @@ -181,7 +186,132 @@ Please contact the #kibana-performance team if you need more help visualizing an | |||
| All users who are opted in to report telemetry will start reporting event based telemetry as well. | |||
| The data is available to be analyzed on the production telemetry cluster. | |||
|
|
|||
| # Report `kibana:plugin_render_time` metric event. | |||
|
|
|||
| The metric `kibana:plugin_render_time` measures the time from the start of navigation to the point at which the most meaningful component appears on the screen. | |||
There was a problem hiding this comment.
Question. Are we sure its the start of the navigation? Not the Kibana plugin start time ?
There was a problem hiding this comment.
What we want is form the browser navigation start time. I am not sure if we are capturing that, If not we need to change the implementation.
There was a problem hiding this comment.
The performance mark start::pageChange is set on route change and the kibana:plugin_render_time is the duration between the start::pageChange and the end::pageReady.
However, I've noticed that there are more than one markers for start::pageChange per route and the performance.measure gets the latest marker for start::pageChange. it seems to be due to re-render.
I believe I need to fix this.
There was a problem hiding this comment.
There is other way to do this, Where you don't need to set marks on mount start/end. To truly measure based on the navigation time, we could do performance.measure("render-time)" this would get the metric between the Nav time and when the page is ready.
Thanks for checking, it seems as you mentioned we need a followup to fix this.
There was a problem hiding this comment.
we could do performance.measure("render-time)"
Where should we do the performance.measure("render-time) ? I think I missed this part
There was a problem hiding this comment.
fyi the ticket: https://github.com/elastic/kibana/issues/184390
Feel free to update it
dev_docs/tutorials/performance/adding_custom_performance_metrics.mdx
Outdated
Show resolved
Hide resolved
dev_docs/tutorials/performance/adding_custom_performance_metrics.mdx
Outdated
Show resolved
Hide resolved
dev_docs/tutorials/performance/adding_custom_performance_metrics.mdx
Outdated
Show resolved
Hide resolved
…cs.mdx Co-authored-by: Vignesh Shanmugam <vignesh.shanmugam22@gmail.com>
…cs.mdx Co-authored-by: Vignesh Shanmugam <vignesh.shanmugam22@gmail.com>
…cs.mdx Co-authored-by: Vignesh Shanmugam <vignesh.shanmugam22@gmail.com>
## Summary closes elastic/observability-dev#3374 1. Added the section # Report `kibana:plugin_render_time` metric event. 2. The rest changes are just auto-format --------- Co-authored-by: Vignesh Shanmugam <vignesh.shanmugam22@gmail.com>
Summary
closes https://github.com/elastic/observability-dev/issues/3374
kibana:plugin_render_timemetric event.