Repository navigation
[HOLD for payment 2024-10-10] Improve the metrics doccumentation #49376
Description
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:
- Metric Definitions and Descriptions: Provide clear definitions and detailed descriptions of each performance metric.
- Data Collection Process: Explain how each metric is collected, including the start and end points of the data collection process.
- 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.
Metadata
Metadata
Assignees
Labels
Type
Projects
- Status
Activity
melvin-bot commentedon Sep 18, 2024
Current assignee @mountiny is eligible for the AutoAssignerNewDotQuality assigner, not assigning anyone new.
TMisiukiewicz commentedon Sep 18, 2024
Hi, I'm Tomasz from Callstack, I'd like to work on this issue
mountiny commentedon Sep 22, 2024
not overdue
TMisiukiewicz commentedon Sep 24, 2024
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 commentedon Sep 24, 2024
I think it does not hurt if you document that as well.
TMisiukiewicz commentedon Sep 30, 2024
PR is open ✅
[-]Improve the metrics doccumentation[/-][+][HOLD for payment 2024-10-10] Improve the metrics doccumentation[/+]melvin-bot commentedon Oct 3, 2024
Reviewinglabel has been removed, please complete the "BugZero Checklist".melvin-bot commentedon Oct 3, 2024
The solution for this issue has been 🚀 deployed to production 🚀 in version 9.0.43-6 and is now subject to a 7-day regression period 📆. Here is the list of pull requests that resolve this issue:
If no regressions arise, payment will be issued on 2024-10-10. 🎊
For reference, here are some details about the assignees on this issue: