Enhance production documentation and update telemetry safety#119
Merged
Conversation
…ate telemetry to redact sensitive data
There was a problem hiding this comment.
Pull request overview
This PR strengthens ServiceHub’s production-safety guidance and tightens telemetry privacy controls to reduce the risk of sensitive data reaching Application Insights, while improving onboarding UX around DEV/UAT/PROD adoption.
Changes:
- Adds a recommended DEV → UAT → PROD adoption flow in the README and Welcome page, plus reinforced UI messaging around production safety.
- Hardens telemetry redaction by expanding sensitive key handling in the backend telemetry processor and tightening frontend App Insights settings.
- Updates tooltips / confirmations to further discourage destructive actions without lower-environment validation.
Reviewed changes
Copilot reviewed 7 out of 8 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| services/api/src/ServiceHub.Api/Telemetry/SensitiveDataTelemetryProcessor.cs | Adds property-bag redaction/removal logic and extends processing to more telemetry types. |
| apps/web/src/pages/WelcomePage.tsx | Adds a “Recommended Adoption Path” section with DEV/UAT/PROD guidance. |
| apps/web/src/pages/ConnectPage.tsx | Improves environment selection helper text to emphasize validation before PROD. |
| apps/web/src/lib/telemetry.ts | Tightens App Insights configuration (cookies off, excluded endpoints, excluded domains). |
| apps/web/src/lib/helpContent.ts | Updates replay tooltip copy to emphasize DEV/UAT validation and PROD blocking. |
| apps/web/src/components/messages/MessageDetailPanel.tsx | Updates replay confirmation messaging with best-practice guidance. |
| README.md | Adds recommended usage flow and expands Security & Privacy / telemetry guarantees. |
| .gitignore | Adjusts ignored docs paths (adds docs/linkedin; normalizes How-To-Use.md entry). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+43
to
+47
| "connectionString", | ||
| "connection_string", | ||
| "correlationId", // Service Bus message-level correlation IDs (not infra tracing IDs) | ||
| "userInput", | ||
| "payload", |
Comment on lines
+93
to
+97
| /// <summary> | ||
| /// Removes or redacts known-sensitive property keys from a telemetry property bag. | ||
| /// Runs LogRedactor over all remaining values to catch any accidental leakage. | ||
| /// </summary> | ||
| private static void RedactProperties(IDictionary<string, string> properties) |
Comment on lines
152
to
+156
| // Redact the outer message stored in telemetry properties | ||
| exception.Message = LogRedactor.Redact(exception.Message); | ||
|
|
||
| // Redact any custom properties that may contain secrets | ||
| foreach (var key in exception.Properties.Keys.ToList()) | ||
| { | ||
| exception.Properties[key] = LogRedactor.Redact(exception.Properties[key]); | ||
| } | ||
| // Redact / remove sensitive custom properties | ||
| RedactProperties(exception.Properties); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request focuses on strengthening ServiceHub's safety and privacy posture, especially around production usage and telemetry. It introduces a recommended adoption flow for connecting environments, improves user guidance and warnings in the UI, and hardens telemetry redaction to prevent sensitive data leakage.
Environment adoption guidance and UI improvements:
README.mdand the Welcome page, emphasizing the importance of validating replay and destructive actions before connecting to production. [1] [2]Security and privacy documentation:
README.mdto detail what data ServiceHub does and does not collect/store, the privacy guarantees of Application Insights telemetry, and the explicit exclusions from telemetry.Telemetry and sensitive data handling:
SensitiveDataTelemetryProcessorto remove or redact sensitive property keys from all telemetry types (including custom events), ensuring message bodies, connection strings, and user data never reach Application Insights. [1] [2] [3] [4]…ate telemetry to redact sensitive data