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.

Sign up for GitHub

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

Jump to bottom

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

Merged
merged 2 commits into from
May 22, 2024
Merged

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

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
90f0453
docs(screenloads): Document span conditions for screen loads metrics
narsaynorath May 21, 2024
79e9093
Move up transaction level measurements
narsaynorath May 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 23 additions & 1 deletion src/docs/sdk/performance/modules/screen-loads.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,26 @@
title: 'Screen Loads Module'
---

to be defined ...
The Screen Loads module records metrics from spans in `ui.load` transactions using specific span operations.

# Span Conventions

## Span Operations
| Span OP | Description |
|:--|:--|
| `db.sql.query` | A database query |
| `db.sql.room` | A database query using the Room library on Android |
| `db.sql.transaction` | - |
| `db` | An operation on the database |
| `file.read` | Reading a file from the file system |
| `file.write` | Writing to a file on the file system |
| `http.client` | An outgoing network request |
| `ui.load` | An operation on a mobile UI |
| `ui.load.full_display` | When the screen has fully completed loading |
| `ui.load.initial_display` | When the screen has rendered its first frame |

## 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.

Loading