Redact PII from Logs Before Shipping
Pipe logs through a redaction filter that masks email and phone fields so PII never reaches the aggregation system.
Task
Instrument const redact = (log) => log.replace(/\b[\w.-]+@[\w.-]+\b/g, '[REDACTED]'); so on-call engineers can diagnose an incident without guessing at log lines.
When to use this
An outage lasts 47 minutes because the team cannot correlate const redact = (log) => log.replace(/\b[\w.-]+@[\w.-]+\b/g, '[REDACTED]'); across services without structured traces.
Prerequisites
- An application with structured logging available
- A metrics or tracing backend configured
Steps
1. Configure const redact = (log) => log.replace(/\b[\w.-]+@[\w.-]+\b/g, '[REDACTED]'); in the project configuration file with the recommended defaults.
const redact = (log) => log.replace(/\b[\w.-]+@[\w.-]+\b/g, '[REDACTED]');
Expected output: The configuration is accepted and const redact = (log) => log.replace(/\b[\w.-]+@[\w.-]+\b/g, '[REDACTED]'); runs without errors on the first invocation.
2. Run the check locally to verify const redact = (log) => log.replace(/\b[\w.-]+@[\w.-]+\b/g, '[REDACTED]'); produces the expected result before pushing.
pnpm test
Expected output: Local run matches CI behavior; no surprises after push.
3. Add the gate to the CI pipeline so const redact = (log) => log.replace(/\b[\w.-]+@[\w.-]+\b/g, '[REDACTED]'); blocks merge on failure.
- name: Run add log redaction pii
run: pnpm test
Expected output: Pull requests with failing const redact = (log) => log.replace(/\b[\w.-]+@[\w.-]+\b/g, '[REDACTED]'); are blocked from merging.
Troubleshooting
Problem
The check passes locally but fails in CI
Solution
Pin dependency versions and the runtime to match CI exactly; reproduce with the same Docker image or act.
Problem
Configuration is rejected with a schema error
Solution
Check the tool version matches the config schema; older versions may not support newer fields.
Limitations
- The gate only runs on events that trigger the workflow; locally pushed commits bypass it.
- Configuration drift is possible if someone edits settings outside version control.
Make the system observable
Start by measuring the problem. Pipe logs through a redaction filter that masks email and phone fields so PII never reaches the aggregation system. The most common mistake is adding the gate without first confirming it catches the issue you care about. Run const redact = (log) => log.replace(/\b[\w.-]+@[\w.-]+\b/g, ‘[REDACTED]’); against the current codebase and inspect the output before wiring it into CI.
const redact = (log) => log.replace(/\b[\w.-]+@[\w.-]+\b/g, '[REDACTED]');Correlate across services
Once the gate is in place, make failures actionable. A failing const redact = (log) => log.replace(/\b[\w.-]+@[\w.-]+\b/g, ‘[REDACTED]’); should point to the exact file and line, not a generic error. Pin the tool version in the lockfile so a upstream release does not silently change behavior. Review the gate output in every pull request just like a test result.