Fix redacting log article: pushed code out to snippets and added missing classes

docs/core/extensions/logging/snippets/source-generation/csharp/BasicUsage/DynamicLog.cs

@@ -0,0 +1,16 @@
+using Microsoft.Extensions.Logging;
+
+namespace BasicUsage.Dynamic;
+
+// <DynamicLogLevel>
+public static partial class Log
+{
+    [LoggerMessage(
+        EventId = 0,
+        Message = "Could not open socket to `{HostName}`")]
+    public static partial void CouldNotOpenSocket(
+        ILogger logger,
+        LogLevel level,
+        string hostName);
+}
+// </DynamicLogLevel>

docs/core/extensions/logging/snippets/source-generation/csharp/BasicUsage/ExtensionLog.cs

@@ -0,0 +1,15 @@
+using Microsoft.Extensions.Logging;
+
+namespace BasicUsage.Extension;
+
+// <ExtensionLogMethod>
+public static partial class Log
+{
+    [LoggerMessage(
+        EventId = 0,
+        Level = LogLevel.Critical,
+        Message = "Could not open socket to `{HostName}`")]
+    public static partial void CouldNotOpenSocket(
+        this ILogger logger, string hostName);
+}
+// </ExtensionLogMethod>

docs/core/extensions/logging/snippets/source-generation/csharp/BasicUsage/InstanceLog.cs

@@ -0,0 +1,21 @@
+using Microsoft.Extensions.Logging;
+
+namespace BasicUsage.InstanceField;
+
+// <InstanceLogWithField>
+public partial class InstanceLoggingExample
+{
+    private readonly ILogger _logger;
+
+    public InstanceLoggingExample(ILogger logger)
+    {
+        _logger = logger;
+    }
+
+    [LoggerMessage(
+        EventId = 0,
+        Level = LogLevel.Critical,
+        Message = "Could not open socket to `{HostName}`")]
+    public partial void CouldNotOpenSocket(string hostName);
+}
+// </InstanceLogWithField>

docs/core/extensions/logging/snippets/source-generation/csharp/BasicUsage/PrimaryCtorLog.cs

@@ -0,0 +1,14 @@
+using Microsoft.Extensions.Logging;
+
+namespace BasicUsage.PrimaryConstructor;
+
+// <InstanceLogWithPrimaryCtor>
+public partial class InstanceLoggingExample(ILogger logger)
+{
+    [LoggerMessage(
+        EventId = 0,
+        Level = LogLevel.Critical,
+        Message = "Could not open socket to `{HostName}`")]
+    public partial void CouldNotOpenSocket(string hostName);
+}
+// </InstanceLogWithPrimaryCtor>

docs/core/extensions/logging/snippets/source-generation/csharp/BasicUsage/StaticLog.cs

@@ -0,0 +1,15 @@
+using Microsoft.Extensions.Logging;
+
+namespace BasicUsage.Static;
+
+// <StaticLogMethod>
+public static partial class Log
+{
+    [LoggerMessage(
+        EventId = 0,
+        Level = LogLevel.Critical,
+        Message = "Could not open socket to `{HostName}`")]
+    public static partial void CouldNotOpenSocket(
+        ILogger logger, string hostName);
+}
+// </StaticLogMethod>

docs/core/extensions/logging/snippets/source-generation/csharp/LogMethodAnatomy/CaseInsensitiveExample.cs

@@ -0,0 +1,27 @@
+using Microsoft.Extensions.Logging;
+
+namespace LogMethodAnatomy;
+
+// <CaseInsensitiveNames>
+public partial class LoggingExample
+{
+    private readonly ILogger _logger;
+
+    public LoggingExample(ILogger logger)
+    {
+        _logger = logger;
+    }
+
+    [LoggerMessage(
+        EventId = 10,
+        Level = LogLevel.Information,
+        Message = "Welcome to {City} {Province}!")]
+    public partial void LogMethodSupportsPascalCasingOfNames(
+        string city, string province);
+
+    public void TestLogging()
+    {
+        LogMethodSupportsPascalCasingOfNames("Vancouver", "BC");
+    }
+}
+// </CaseInsensitiveNames>

docs/core/extensions/logging/snippets/source-generation/csharp/LogMethodAnatomy/IndeterminateOrder.cs

@@ -0,0 +1,18 @@
+using Microsoft.Extensions.Logging;
+
+namespace LogMethodAnatomy;
+
+public static partial class IndeterminateOrderLog
+{
+    // <IndeterminateParameterOrder>
+    [LoggerMessage(
+        EventId = 110,
+        Level = LogLevel.Debug,
+        Message = "M1 {Ex3} {Ex2}")]
+    static partial void LogMethod(
+        Exception ex,
+        Exception ex2,
+        Exception ex3,
+        ILogger logger);
+    // </IndeterminateParameterOrder>
+}

docs/core/extensions/logging/snippets/source-generation/csharp/LogMethodAnatomy/LogMethods.cs

@@ -0,0 +1,17 @@
+using Microsoft.Extensions.Logging;
+
+namespace LogMethodAnatomy;
+
+public static partial class LogMethods
+{
+    // <ValidLogMethod>
+    // This is a valid attribute usage
+    [LoggerMessage(
+        EventId = 110, Level = LogLevel.Debug, Message = "M1 {Ex3} {Ex2}")]
+    public static partial void ValidLogMethod(
+        ILogger logger,
+        Exception ex,
+        Exception ex2,
+        Exception ex3);
+    // </ValidLogMethod>
+}

docs/core/extensions/logging/snippets/source-generation/csharp/MoreLoggingExamples/LoggingSample.cs

@@ -0,0 +1,45 @@
+using Microsoft.Extensions.Logging;
+
+namespace MoreLoggingExamples;
+
+// <MoreLoggingExamples>
+public partial class LoggingSample
+{
+    private readonly ILogger _logger;
+
+    public LoggingSample(ILogger logger)
+    {
+        _logger = logger;
+    }
+
+    [LoggerMessage(
+        EventId = 20,
+        Level = LogLevel.Critical,
+        Message = "Value is {Value:E}")]
+    public static partial void UsingFormatSpecifier(
+        ILogger logger, double value);
+
+    [LoggerMessage(
+        EventId = 9,
+        Level = LogLevel.Trace,
+        Message = "Fixed message",
+        EventName = "CustomEventName")]
+    public partial void LogWithCustomEventName();
+
+    [LoggerMessage(
+        EventId = 10,
+        Message = "Welcome to {City} {Province}!")]
+    public partial void LogWithDynamicLogLevel(
+        string city, LogLevel level, string province);
+
+    public void TestLogging()
+    {
+        LogWithCustomEventName();
+
+        LogWithDynamicLogLevel("Vancouver", LogLevel.Warning, "BC");
+        LogWithDynamicLogLevel("Vancouver", LogLevel.Information, "BC");
+
+        UsingFormatSpecifier(_logger, 12345.6789);
+    }
+}
+// </MoreLoggingExamples>

docs/core/extensions/logging/snippets/source-generation/csharp/Program.cs

@@ -0,0 +1 @@
+Console.WriteLine("Hello, World!");

docs/core/extensions/logging/snippets/source-generation/csharp/RedactingSensitiveInformation/RedactionSetup.cs

@@ -0,0 +1,67 @@
+using Microsoft.Extensions.Compliance.Classification;
+using Microsoft.Extensions.Compliance.Redaction;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Logging;
+
+namespace RedactingSensitiveInformation;
+
+// MyTaxonomyClassifications.Private serves two roles:
+// - As a DataClassification value passed to SetRedactor().
+// - As [MyTaxonomyClassifications.Private] on logging parameters, resolved via the
+//   nested PrivateAttribute class (C# drops the "Attribute" suffix in attribute syntax).
+public static class MyTaxonomyClassifications
+{
+    private static string Name => "MyTaxonomy";
+
+    public static DataClassification Private { get; } = new(Name, nameof(Private));
+
+    // Accessible as [MyTaxonomyClassifications.Private] due to C# attribute name convention.
+    public sealed class PrivateAttribute : DataClassificationAttribute
+    {
+        public PrivateAttribute() : base(MyTaxonomyClassifications.Private) { }
+    }
+}
+
+public sealed class StarRedactor : Redactor
+{
+    private const string Stars = "*****";
+
+    public override int GetRedactedLength(ReadOnlySpan<char> input) => Stars.Length;
+
+    public override int Redact(ReadOnlySpan<char> source, Span<char> destination)
+    {
+        Stars.CopyTo(destination);
+        return Stars.Length;
+    }
+}
+
+// <LogPrivateInformation>
+public static partial class LogRedactionExample
+{
+    [LoggerMessage(0, LogLevel.Information, "User SSN: {SSN}")]
+    public static partial void LogPrivateInformation(
+        this ILogger logger,
+        [MyTaxonomyClassifications.Private] string SSN);
+}
+// </LogPrivateInformation>
+
+public static class RedactionSetupExample
+{
+    public static void SetupServices()
+    {
+        // <RedactionSetup>
+        var services = new ServiceCollection();
+        services.AddLogging(builder =>
+        {
+            // Enable redaction.
+            builder.EnableRedaction();
+        });
+
+        services.AddRedaction(builder =>
+        {
+            // Configure redactors for your data classifications.
+            builder.SetRedactor<StarRedactor>(MyTaxonomyClassifications.Private);
+        });
+        // </RedactionSetup>
+    }
+}

docs/core/extensions/logging/snippets/source-generation/csharp/Usings.cs

@@ -0,0 +1,4 @@
+using Microsoft.Extensions.Compliance.Classification;
+using Microsoft.Extensions.Compliance.Redaction;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Logging;

docs/core/extensions/logging/snippets/source-generation/csharp/csharp.csproj

@@ -0,0 +1,17 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>net10.0</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.Extensions.Compliance.Redaction" Version="10.8.0" />
+    <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="10.0.10" />
+    <PackageReference Include="Microsoft.Extensions.Logging" Version="10.0.10" />
+    <PackageReference Include="Microsoft.Extensions.Telemetry" Version="10.8.0" />
+  </ItemGroup>
+
+</Project>