diff --git a/docs/ex_performance_metrics.md b/docs/ex_performance_metrics.md new file mode 100644 index 0000000..d72626b --- /dev/null +++ b/docs/ex_performance_metrics.md @@ -0,0 +1,80 @@ +# EX Performance metrics + +| Status | Last updated | +|--|--| +| In progress | December 22, 2025 | + +
+ +## Objective +Crashes are already tracked on Sentry. Performance metrics are also useful health metrics to check. They can be tracked by Sentry too. + +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. + +## Sentry semantics +As we use Sentry, we need to adopt its naming conventions for `Transaction(name: String, operation: String)` and `Span(operation: String, description: String)`. +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/). + +## UX metrics + +They are tracked using Sentry transactions. `Transaction.operation` is `ux` to reflect high-level, user journey metrics. + +| Metric (Sentry Transaction Name) | Description | Initial and final conditions | Tech metrics | Notes | +| :---- | :---- | :---- | :---- | :---- | +| Cached room list | Cold start until the cached room list is displayed | From: To: