Skip to content
This repository has been archived by the owner on Aug 14, 2024. It is now read-only.

Commit

Permalink
docs(screenloads): Document span conditions for screen loads metrics (#…
Browse files Browse the repository at this point in the history
…1284)

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.
  • Loading branch information
narsaynorath committed May 22, 2024
1 parent 93d4f1b commit 77049e7
Showing 1 changed file with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion src/docs/sdk/performance/modules/screen-loads.mdx
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 |

0 comments on commit 77049e7

Please sign in to comment.