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
+26 −1
Merged

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

Changes from all commits
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
27 changes: 26 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,29 @@
title: 'Screen Loads Module'
---

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

# Transaction Conventions

## Transaction Measurements
| Key | Unit | Description | Conditions |
|:--|:--|:--|:--|
| `time_to_initial_display` | milliseconds | The time it took to load the first frame | required |
| `time_to_full_display` | milliseconds | The time it took to fully load the screen | optional, requires manual instrumentation |

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