-
Notifications
You must be signed in to change notification settings - Fork 8.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add documentation for kibana:plugin_render_time
#184206
Add documentation for kibana:plugin_render_time
#184206
Conversation
🤖 GitHub commentsExpand to view the GitHub comments
Just comment with:
|
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Question. Are we sure its the start of the navigation? Not the Kibana plugin start time ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
kibana/packages/kbn-ebt-tools/src/performance_metrics/context/performance_context.tsx
Line 41 in a4f468b
const interaction = measureInteraction(); |
I believe I need to fix this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Summary
closes https://github.com/elastic/observability-dev/issues/3374
kibana:plugin_render_time
metric event.