Skip to content

Enhance production documentation and update telemetry safety#120

Merged
debdevops merged 2 commits into
releasefrom
main
Apr 26, 2026
Merged

Enhance production documentation and update telemetry safety#120
debdevops merged 2 commits into
releasefrom
main

Conversation

@debdevops
Copy link
Copy Markdown
Owner

This pull request focuses on improving the safety, privacy, and user guidance for ServiceHub, particularly around connecting to production environments and handling sensitive data. The changes introduce a recommended adoption path for environment validation, enhance user interface messaging to encourage safe practices, and strengthen telemetry redaction to ensure privacy.

User Guidance & Safe Adoption

  • Added a clear, multi-step recommended usage/adoption path in both the README.md and the app UI (WelcomePage, ConnectPage) to guide users through DEV, UAT, and PROD environments, emphasizing validation in lower environments before connecting to production. [1] [2] [3]
  • Updated tooltips and confirmation dialogs to reinforce best practices, warning users to validate replay actions in DEV/UAT and explaining that production blocks destructive actions by default. [1] [2]

Security & Privacy Enhancements

  • Expanded the security and privacy section in the README.md to clarify what data is (and is not) collected or stored, and detailed how telemetry is privacy-safe and disabled by default.
  • Improved Application Insights telemetry configuration to explicitly exclude message bodies, user input, and sensitive endpoints from tracking, and to avoid sending correlation headers to external domains.

Backend Telemetry Redaction

  • Strengthened the SensitiveDataTelemetryProcessor to remove or redact sensitive property keys (like message bodies, connection strings, and user input) from all telemetry, including custom events and exceptions, ensuring no sensitive data reaches Application Insights. [1] [2] [3] [4]

Enhance production documentation and update telemetry safety
Copilot AI review requested due to automatic review settings April 26, 2026 15:35
@debdevops debdevops merged commit 1d4b9a0 into release Apr 26, 2026
15 checks passed
@debdevops debdevops review requested due to automatic review settings April 26, 2026 16:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant