DR | Add Datadog logging for validation errors that prevent submission

Mottie commented 10 months ago

Value Statement

As a developer I want to investigate why form submission is blocked So that we can fix the issue preventing Veteran's from submitting our form

Background Context

After working on #71344 and finding it difficult to find and evaluate Veterans having similar validation issues, we split out the work into this ticket...

When a Veteran has validation issues after attempting to submit their form, a generic error message is shown, and a "Validation issue not displayed" event is logged in Sentry. This event includes all the validation issues & error messages, but we aren't able to see this in Datadog. So we need to add logs specific for Datadog so we can see & cross-reference the problem within our dashboard (reference docs)

Acceptance Criteria

[ ] When a Veteran encounters a validation error and is shown the generic error alert, a Datadog event is logged
[ ] Datadog dashboards include details for "Validation issue not displayed" events
[ ] No PHI/PII exposed in Datadog dashboard

Tasks

[ ] Investigate Datadog logging
[ ] Investigate adding Slack notifications for known validation issues (e.g. contact info problems)
[ ] Add Datadog logging which will include the same data logged to Sentry
[ ] Ensure no PHI/PII is included in the logs
[ ] Add tests
[ ] Test logging in staging

Definition of Ready

[ ] Investigation work is timeboxed to 2 hours
[x] Logging events discussed with Steve Albers

Definition of Done

[x] Meets acceptance criteria
[ ] Passed E2E testing (90% coverage)
[ ] Passed unit testing (90% coverage)
[x] Passed integration testing (if applicable)
[x] Code reviewed (internal)
[x] Submitted to staging
[x] Reviewed and approved by product and/or design

Mottie commented 10 months ago

I'm meeting with another team that has more experience with Datadog logging on 1/12/2024. I also have a plan to meet with Steve Albers about adding Datadog JavaScript logging to the site — not sure if it's implemented or needed, but I'll have a better idea after the meeting with the other team.

saderagsdale commented 10 months ago

Steve is going to confirm the cost before the work is approved. Blocked for now.

Mottie commented 10 months ago

Steve Albers has told me to go ahead and proceed 🎉

HeatherWidmont commented 10 months ago

DD team will review his PR to ensure its set up properly & will get back to him (hopefully today). Once its reviewed Robin will take it out of draft, have our team & Platform team review it