From 90f045377dd6ae9d29b7a5012ad408cabe6cac3d Mon Sep 17 00:00:00 2001 From: Nar Saynorath Date: Tue, 21 May 2024 10:19:35 -0400 Subject: [PATCH 1/2] docs(screenloads): Document span conditions for screen loads metrics --- .../sdk/performance/modules/screen-loads.mdx | 24 ++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/src/docs/sdk/performance/modules/screen-loads.mdx b/src/docs/sdk/performance/modules/screen-loads.mdx index 9ea76460f9..7313684ecd 100644 --- a/src/docs/sdk/performance/modules/screen-loads.mdx +++ b/src/docs/sdk/performance/modules/screen-loads.mdx @@ -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 | From 79e90931fc732cffcd99883b0d084de1e61207d6 Mon Sep 17 00:00:00 2001 From: Nar Saynorath Date: Tue, 21 May 2024 12:12:55 -0400 Subject: [PATCH 2/2] Move up transaction level measurements --- src/docs/sdk/performance/modules/screen-loads.mdx | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/src/docs/sdk/performance/modules/screen-loads.mdx b/src/docs/sdk/performance/modules/screen-loads.mdx index 7313684ecd..ccf7383da2 100644 --- a/src/docs/sdk/performance/modules/screen-loads.mdx +++ b/src/docs/sdk/performance/modules/screen-loads.mdx @@ -4,6 +4,14 @@ title: 'Screen Loads Module' 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 @@ -20,8 +28,3 @@ The Screen Loads module records metrics from spans in `ui.load` transactions usi | `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 |