Description:
OFA's data team is preparing documentation that includes all possible errors that TDP can detect to replace legacy system error documentation. This will include error codes to help in organizing error messages by section and error type. This could also help with aggregating errors to track trends over time.
As such, the system error logs should also reference these codes to help with the investigation, in addition to have more meaningful KPIs for each error code and category which can be done using PLG.
Additionally, during #3224 we realized that major portion of logs don't have any reference to file, user and are simply static logs, which make such logs worthless. It is essential to have meaningful references in the logs that help associating exceptions and errors to submissions. References such as ids, UUIDs, file, user, STT, etc while considering PII and sensitive information.
Acceptance Criteria:Create a list of functional outcomes that must be achieved to complete this issue
[ ] Outcome 1
[ ] Outcome 2
[ ] Outcome 3
[ ] Testing Checklist has been run and all tests pass
[ ] README is updated, if necessary
Tasks:Create a list of granular, specific work items that must be completed to deliver the desired outcomes of this issue
[ ] Task 1
[ ] Task 2
[ ] Task 3
[ ] Run Testing Checklist and confirm all tests pass
Notes:Add additional useful information, such as related issues and functionality that isn't covered by this specific issue, and other considerations that will be helpful for anyone reading this
Note 1
Note 2
Note 3
Supporting Documentation:Please include any relevant log snippets/files/screen shots
Description: OFA's data team is preparing documentation that includes all possible errors that TDP can detect to replace legacy system error documentation. This will include error codes to help in organizing error messages by section and error type. This could also help with aggregating errors to track trends over time.
As such, the system error logs should also reference these codes to help with the investigation, in addition to have more meaningful KPIs for each error code and category which can be done using PLG.
Additionally, during #3224 we realized that major portion of logs don't have any reference to file, user and are simply static logs, which make such logs worthless. It is essential to have meaningful references in the logs that help associating exceptions and errors to submissions. References such as ids, UUIDs, file, user, STT, etc while considering PII and sensitive information.
Acceptance Criteria: Create a list of functional outcomes that must be achieved to complete this issue
Tasks: Create a list of granular, specific work items that must be completed to deliver the desired outcomes of this issue
Notes: Add additional useful information, such as related issues and functionality that isn't covered by this specific issue, and other considerations that will be helpful for anyone reading this
Supporting Documentation: Please include any relevant log snippets/files/screen shots
Open Questions: Please include any questions or decisions that must be made before beginning work or to confidently call this issue complete