Skip to content
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

docs(screenloads): Document span conditions for screen loads metrics #1284

Merged
merged 2 commits into from
May 22, 2024

Conversation

narsaynorath
Copy link
Member

Documents the conditions for collecting span metrics to satisfy the screen loads module.

The screen loads module filters for specifically ui.load transactions and will surface data from the following spans.

Copy link

vercel bot commented May 21, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
develop ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 21, 2024 4:16pm

Comment on lines 23 to 27
## Span Measurements
| Key | Unit | Description |
|:--|:--|:--|
| `time_to_initial_display` | milliseconds | The time it took to load the first frame |
| `time_to_full_display` | milliseconds | The time it took to fully load the screen |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are these required?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good question. I actually realized these are required on the transaction level at the moment (some of the widgets here still query transaction metrics) so I've split it out into a similar "Transaction Conventions" section.

time_to_initial_display is required for the module but time_to_full_display is optional and we prompt the user to manually instrument it.

@narsaynorath narsaynorath merged commit 77049e7 into master May 22, 2024
5 checks passed
@narsaynorath narsaynorath deleted the nar/documentation-for-screen-loads-module branch May 22, 2024 13:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants