department-of-veterans-affairs / va.gov-team

Public resources for building on and in support of VA.gov. Visit complete Knowledge Hub:
https://depo-platform-documentation.scrollhelp.site/index.html
284 stars 206 forks source link

Discovery: Improve ease of debugging #93792

Open kjduensing opened 2 months ago

kjduensing commented 2 months ago

Context

The more we mask and strip PII in our logs the harder it becomes to debug. We need a way to easily debug requests end-to-end so that we can fix issues and make improvements faster and easier.

Details

Some teams use encrypted debug payloads as part of the response that comes back from their service. Maybe we can mask just enough of the sensitive information to make debugging easier, but still prevent PII incidents. Should we develop a hosted 2-way masking/encryption system we can use to easily encrypt/decrypt information? No... but...?

Acceptance Critera

ayush-chak commented 2 months ago

Hey team! Please add your planning poker estimate with Zenhub @hinzed1127 @kjduensing @liztownd

hinzed1127 commented 1 month ago

The recommended approach other teams referenced, assuming we will indeed need the store this somewhere, is the PersonalInformationLog within vets-api (more information here). This isn't ideal, ie, it still requires debugging in Argonaut, but it seems like the most common solution to logging/storing PII right now.

I can add some examples of this elsewhere in vets-api and work with @kjduensing on what situations we'll want to log this info in.