[HOLD for payment 2024-10-10] Improve the metrics doccumentation

[mountiny]

Coming from this thread

Problem

Various performance metrics are currently sent to Firebase for monitoring and analysis. However, team members struggle to understand, interpret, and utilize the performance data effectively. This difficulty can result in misunderstandings, misinterpretations, and challenges in leveraging metrics to drive performance improvements.

Some examples where it’s not clear what metrics are representing and what is the difference between them:

• load_search_options and search_filter_options
• switch_report and open_report

Solution

To resolve this issue, let’s create comprehensive documentation for our performance metrics. The documentation should include:

1. Metric Definitions and Descriptions: Provide clear definitions and detailed descriptions of each performance metric.
2. Data Collection Process: Explain how each metric is collected, including the start and end points of the data collection process.
3. Documentation Maintenance: Outline the steps for updating and maintaining the documentation as new metrics are added or existing metrics are modified.

This documentation will be included in the project’s README to ensure easy access and reference for everyone.

[melvin-bot[bot]]

Current assignee @mountiny is eligible for the AutoAssignerNewDotQuality assigner, not assigning anyone new.

[TMisiukiewicz]

Hi, I'm Tomasz from Callstack, I'd like to work on this issue

[mountiny]

not overdue

[TMisiukiewicz]

I have documented all the metrics we send to Firebase. Should we also include descriptions for the metrics collected exclusively by the Performance module (used by react-native-performance, not being sent anywhere)?

[mountiny]

I think it does not hurt if you document that as well.

[TMisiukiewicz]

PR is open ✅

[melvin-bot[bot]]

Reviewing label has been removed, please complete the "BugZero Checklist".

[melvin-bot[bot]]

The solution for this issue has been :rocket: deployed to production :rocket: in version 9.0.43-6 and is now subject to a 7-day regression period :calendar:. Here is the list of pull requests that resolve this issue:

• https://github.com/Expensify/App/pull/49912

If no regressions arise, payment will be issued on 2024-10-10. :confetti_ball:

For reference, here are some details about the assignees on this issue:

• @TMisiukiewicz does not require payment (Contractor)