docs: Update PII Scrubbing in Logs doc

[crazyuploader]

Closes: #2003

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
signoz-web	Ready	Preview	Comment	Nov 13, 2025 7:13am

[makeavish]

@gemini-cli /review

[github-actions]

🤖 Hi @makeavish, I've received your request, and I'm working on it now! You can track my progress in the logs for more details.

[github-actions]

📋 Review Summary

This Pull Request updates the PII Scrubbing in Logs documentation, improving clarity, completeness, and adherence to documentation standards. The changes enhance the guide by providing more comprehensive options for log ingestion and better formatting for code examples.

🔍 General Feedback

• The addition of a description in the frontmatter is a good improvement for SEO and discoverability.
• The reformatting of the sample log JSON and the <figure> component significantly improves readability.
• Ensure consistency in terminology and code block formatting for a polished user experience.

[claude]

Claude finished @crazyuploader's task —— View job

---

Review of PR #2156

I've reviewed the documentation updates for the PII Scrubbing guide. Here's my comprehensive feedback based on the repository's CONTRIBUTING.md standards:

---

✅ Positive Changes

1. Metadata improvement - Added description field to frontmatter (SEO enhancement)
2. Better formatting - Improved JSON code block readability with proper indentation
3. Enhanced prerequisites - Expanded to include OTLP and other receiver options
4. Clearer structure - Added proper spacing between sections
5. Better <figure> component usage - Improved formatting and readability

---

🔍 Issues Found

I've posted inline comments on the specific lines that need attention:

1. Typos (Critical) ⚠️

• Line 52: Trasform → Transform
• Line 116: trasform processsor → transform processor (also note: "processsor" has extra 's')

2. Inconsistent Code Block Language 📝

• Line 93-101: The Result section uses yaml syntax highlighting for JSON data. Should use json for consistency with the input sample log.
• Also uses single quotes instead of double quotes - should match the input format for consistency.

---

📋 PR Checklist Review (from CONTRIBUTING.md)

✅ Frontmatter includes date, id, title, description, and tags
✅ Primary keywords appear in title, description, and content
✅ Commands are explained (transform processor usage is clear)
✅ Code snippets are annotated with context
⚠️ Typos present - "Trasform" and "trasform processsor" need correction
⚠️ Code block language - Result section uses yaml for JSON content
✅ Images use WebP format with proper alt text and Figure component
✅ Links use absolute URLs where appropriate
✅ Cross-links to existing SigNoz docs (filelog, send logs documentation)

---

🎯 Recommendations

1. Fix the typos on lines 52 and 116 (see inline comments)
2. Change code block language from yaml to json on line 93 for the Result section
3. Consider using double quotes in the result JSON for consistency with the input example

---

📊 Overall Assessment

This is a solid documentation improvement that enhances clarity and SEO. The structural changes and expanded prerequisites are excellent. Once the typos and code block language are corrected, this will be ready to merge.

Estimated effort to fix: ~2 minutes (3 quick edits)

---

[claude]

Claude finished @crazyuploader's task —— View job

---

Review Complete

I've reviewed the PII Scrubbing documentation update against the repository's CONTRIBUTING.md standards.

---

Issues Identified

1. Critical Typo on Line 116 ⚠️

The word "processsor" has an extra 's' and should be "processor":

Line 116: "transform processsor" → "transform processor"

Reference: data/docs/logs-management/guides/pii-scrubbing.mdx:116

2. Code Block Language Inconsistency (Lines 93-101) 📝

The Result section uses yaml syntax highlighting for JSON data. This should be json to match the input sample log format (lines 38-46):

# Currently using 'yaml' but contains JSON
{
  'timestamp': '2024-07-05T12:34:56Z',
  ...
}

Additionally, the result uses single quotes ('timestamp') while valid JSON requires double quotes ("timestamp"). For consistency with the input example and JSON standards, this should use double quotes.

Reference: data/docs/logs-management/guides/pii-scrubbing.mdx:93

---

What's Working Well ✅

1. Metadata Enhancement - Added description field to frontmatter (SEO improvement)
2. Improved Structure - Better formatting and spacing between sections
3. Enhanced Prerequisites - Expanded to include OTLP and other receiver options
4. Clear Documentation - Good use of the <figure> component with proper alt text
5. Comprehensive Guide - The step-by-step process is clear and well-structured

---

PR Checklist Review (from CONTRIBUTING.md)

✅ Frontmatter includes date, id, title, description, and tags
✅ Primary keywords appear in title, description, and content
✅ Commands are explained with context
✅ Code snippets are annotated
⚠️ Typo present - "processsor" needs correction (line 116)
⚠️ Code block language - Result section should use json not yaml (line 93)
✅ Images use WebP format with proper alt text and Figure component
✅ Links use absolute URLs where appropriate
✅ Cross-links to existing SigNoz docs included

---

Recommendations

1. Fix the typo on line 116: "processsor" → "processor"
2. Change code block language from yaml to json on line 93
3. Update quote style in the result JSON to use double quotes for consistency and valid JSON syntax

Estimated effort to fix: ~2 minutes (2 quick edits)

Once these issues are addressed, this documentation will be ready to merge!

[claude]

Claude finished @crazyuploader's task —— View job

---

Documentation Review Complete

Todo List

• Read CONTRIBUTING.md for documentation standards
• Read the changed file (pii-scrubbing.mdx)
• Review changes against CONTRIBUTING.md standards
• Post comprehensive review feedback

---

Summary

Good news! The latest commits have successfully addressed the previously identified issues. The documentation now meets the repository's CONTRIBUTING.md standards.

What Was Fixed ✅

The recent commits (663ddd1 and ca7a003) have corrected:

1. Code block language (Line 93): Changed from yaml to json for the Result section
2. Quote style (Lines 95-99): Changed from single quotes to double quotes for valid JSON syntax
3. Typo (Line 116): Fixed "processsor" → "processor"

Note: I see previous review comments mentioned a typo "Trasform" on line 52, but this doesn't exist in the current version of the file (data/docs/logs-management/guides/pii-scrubbing.mdx:52). The text correctly reads "Transform processor" throughout.

Review Against CONTRIBUTING.md PR Checklist

Reviewing against the Docs PR Checklist:

✅ Frontmatter: Includes date, id, title, description, and tags (data/docs/logs-management/guides/pii-scrubbing.mdx:1-7)
✅ SEO: Keywords "PII scrubbing", "OpenTelemetry", and "SigNoz" appear in title, description, and content
✅ Cloud vs Self-Host: Tagged as SigNoz Cloud only; could benefit from a drop-in snippet for Self-Host users (see recommendation below)
✅ Commands explained: Transform processor configuration is well-explained with context (data/docs/logs-management/guides/pii-scrubbing.mdx:69-73)
✅ Code snippets annotated: All code blocks have proper language tags and explanations
✅ Placeholders defined: N/A - no placeholders used
✅ Validation section: Shows the result after scrubbing with screenshot (data/docs/logs-management/guides/pii-scrubbing.mdx:89-113)
✅ Troubleshooting: Not applicable for this type of guide (configuration guide)
✅ Next steps: Links to transform processor documentation for deeper learning (data/docs/logs-management/guides/pii-scrubbing.mdx:116)
✅ Links: Uses absolute URL for external link, proper cross-links to SigNoz docs
✅ Images: Uses WebP format with proper alt text and Figure component (data/docs/logs-management/guides/pii-scrubbing.mdx:103-111)
✅ Cross-linking: Includes links to related documentation (filelog receiver, send logs docs)

Minor Recommendation (Optional)

Since this guide is tagged for SigNoz Cloud only, consider adding a brief info note for Self-Host users. Per CONTRIBUTING.md lines 186-192, you could add:

<Admonition type="info">
  Using self-hosted SigNoz? Most steps are identical. To adapt this guide, update the endpoint
  and remove the ingestion key header as shown in [Cloud →
  Self-Hosted](https://signoz.io/docs/ingestion/cloud-vs-self-hosted/#cloud-to-self-hosted).
</Admonition>

However, this is optional since the PII scrubbing configuration itself is identical for both Cloud and Self-Host - only the collector endpoint configuration differs, which is covered in the linked documentation.

Conclusion

Status: ✅ Approved - Ready to Merge

The documentation is well-structured, clear, and meets all the repository standards. All previously identified issues have been fixed in the latest commits. Great work!

---

[makeavish]

@gemini-cli /review

[github-actions]

🤖 Hi @makeavish, I've received your request, and I'm working on it now! You can track my progress in the logs for more details.

[github-actions]

📋 Review Summary

This Pull Request updates the PII Scrubbing in Logs documentation. The changes improve clarity, expand on log collection methods, and enhance the formatting of code snippets and figures.

🔍 General Feedback

• The overall content improvements are good, making the guide more comprehensive and easier to follow.
• Minor adjustments were suggested for adherence to documentation guidelines regarding tags, external link attributes, and acronym definitions.