Skip to content

Commit da2e5b8

Browse files
committed
Integrate Sentry naming convention
to define a better mapping between the spec and implementation.
1 parent 1b40d5e commit da2e5b8

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

docs/ex_perfomance_metrics.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,15 @@ Crashes are already tracked on Sentry. Performance metrics are also useful healt
1111

1212
This document specifies what metrics we track and how we measure them. It focuses on EX but it could be extended (and renamed) to track any matrix client app performance.
1313

14+
## Sentry semantics
15+
As we use Sentry, we need to adopt its naming conventions for `Transaction(name: String, operation: String)` and `Span(operation: String, description: String)`.
16+
More information can be found in the Sentry documentation about [Transaction Name](https://docs.sentry.io/platforms/native/enriching-events/transaction-name/) and [Span Operations](https://develop.sentry.dev/sdk/performance/span-operations/).
17+
1418
## UX metrics
1519

16-
| Title | Android name / Description | What is it measuring? | Initial and final conditions | Tech metrics | Notes |
20+
There are tracked using Sentry transactions. `Transaction.operation` is `ux` to reflect high-level, user journey metrics.
21+
22+
| Metric (Sentry Transaction Name) | Description | What is it measuring? | Initial and final conditions | Tech metrics | Notes |
1723
| :---- | :---- | :---- | :---- | :---- | :---- |
1824
| Cold start | Cold start until the cached room list is displayed | How long it takes from launching the app to displaying cached data on the screen | From:<ul><li>The user is already connected</li><li>The app is not running in background</li><li> The user taps on the app icon</li></ul> To:<ul><li>The room list is fully loaded from the permanent cached and displayed to the end user | <ul><li>First rooms displayed after login or restoration (**TBD**) </li></ul> | The clock starts after the Sentry is initialised. |
1925
| Catch-up | The app syncs and the room list becomes up-to-date | How long until the room list is up-to-date | From:<ul><li>The app was inactive in background and get debackgrounded</li><li>Or the app just finished its cold start</li></ul> To:<ul><li>The room list service state becomes [`Running`](https://github.com/matrix-org/matrix-rust-sdk/blob/matrix-sdk-ui-0.14.0/bindings/matrix-sdk-ffi/src/sync_service.rs#L36)</li><li>No more Syncing spinner | | The expected final conditions should be:<ul><li>The room list is updated</li><li>Properly sorted</li><li>Last messages are up-to-date</li></ul> But we need more work to compute this metric |

0 commit comments

Comments
 (0)