comments

Author: R9 Fundamentals

docs/core/extensions/data-redaction.md

@@ -190,7 +190,7 @@ Logging is a common source of accidental data exposure. Sensitive information su
 
 ### Steps for logging sensitive data
 
-1. **Install logging extensions package**: Install [Microsoft.Extensions.Telemetry](https://www.nuget.org/packages/Microsoft.Extensions.Telemetry) to be able to use the extended logger to enable redaction feature.
+1. **Install the telemetry extensions package**: Install [Microsoft.Extensions.Telemetry](https://www.nuget.org/packages/Microsoft.Extensions.Telemetry) to be able to use the extended logger to enable redaction feature.
 2. **Set up redaction**: Integrate redactors with your logging pipeline by calling the <xref:Microsoft.Extensions.DependencyInjection.RedactionServiceCollectionExtensions.AddRedaction(Microsoft.Extensions.DependencyInjection.IServiceCollection)> method, to automatically sanitize or mask sensitive fields before they are written to logs.
 3. **Identify sensitive fields**: Know which data in your application is sensitive and requires protection, and mark them with appropriate data classification.
 4. **Review log output**: Regularly audit your logs to ensure no sensitive data is exposed.
@@ -212,10 +212,11 @@ services.AddLogging(builder =>
 
 services.AddRedaction(builder =>
 {
+    // configure redactors for your data classifications
     builder.SetRedactor<StarRedactor>(MyTaxonomyClassifications.Private);
 });
-
-// Use StarRedactor to redact SSN data.
+// Use annotations to mark sensitive data.
+// For example, apply the Private classification to SSN data.
 [LoggerMessage(0, LogLevel.Information, "User SSN: {SSN}")]
 public static partial void LogPrivateInformation(
     this ILogger logger,

docs/core/extensions/logger-message-generator.md

@@ -406,6 +406,7 @@ services.AddLogging(builder =>
 
 services.AddRedaction(builder =>
 {
+    // configure redactors for your data classifications
     builder.SetRedactor<StarRedactor>(MyTaxonomyClassifications.Private);
 });