Merge branch 'main' into otlp-exporter-limits-by-env-vars

docs/logs/redaction/MyRedactionProcessor.cs

@@ -14,12 +14,11 @@
 // limitations under the License.
 // </copyright>
 
+using System.Collections;
 using OpenTelemetry;
 using OpenTelemetry.Logs;
 
-namespace Redaction;
-
-internal class MyRedactionProcessor : BaseProcessor<LogRecord>
+internal sealed class MyRedactionProcessor : BaseProcessor<LogRecord>
 {
     public override void OnEnd(LogRecord logRecord)
     {
@@ -28,4 +27,44 @@ public override void OnEnd(LogRecord logRecord)
             logRecord.Attributes = new MyClassWithRedactionEnumerator(logRecord.Attributes);
         }
     }
+
+    internal sealed class MyClassWithRedactionEnumerator : IReadOnlyList<KeyValuePair<string, object>>
+    {
+        private readonly IReadOnlyList<KeyValuePair<string, object>> state;
+
+        public MyClassWithRedactionEnumerator(IReadOnlyList<KeyValuePair<string, object>> state)
+        {
+            this.state = state;
+        }
+
+        public int Count => this.state.Count;
+
+        public KeyValuePair<string, object> this[int index]
+        {
+            get
+            {
+                var item = this.state[index];
+                var entryVal = item.Value;
+                if (entryVal != null && entryVal.ToString() != null && entryVal.ToString().Contains("<secret>"))
+                {
+                    return new KeyValuePair<string, object>(item.Key, "newRedactedValueHere");
+                }
+
+                return item;
+            }
+        }
+
+        public IEnumerator<KeyValuePair<string, object>> GetEnumerator()
+        {
+            for (var i = 0; i < this.Count; i++)
+            {
+                yield return this[i];
+            }
+        }
+
+        IEnumerator IEnumerable.GetEnumerator()
+        {
+            return this.GetEnumerator();
+        }
+    }
 }

docs/logs/redaction/Program.cs

@@ -17,22 +17,26 @@
 using Microsoft.Extensions.Logging;
 using OpenTelemetry.Logs;
 
-namespace Redaction;
-
-public class Program
+var loggerFactory = LoggerFactory.Create(builder =>
 {
-    public static void Main()
+    builder.AddOpenTelemetry(logging =>
     {
-        using var loggerFactory = LoggerFactory.Create(builder =>
-            builder.AddOpenTelemetry(options =>
-            {
-                options.AddProcessor(new MyRedactionProcessor());
-                options.AddConsoleExporter();
-            }));
+        logging.AddProcessor(new MyRedactionProcessor());
+        logging.AddConsoleExporter();
+    });
+});
+
+var logger = loggerFactory.CreateLogger<Program>();
 
-        var logger = loggerFactory.CreateLogger<Program>();
+// Message will be redacted by MyRedactionProcessor
+logger.FoodPriceChanged("<secret>", 9.99);
 
-        // message will be redacted by MyRedactionProcessor
-        logger.LogInformation("OpenTelemetry {sensitiveString}.", "<secret>");
-    }
+// Dispose logger factory before the application ends.
+// This will flush the remaining logs and shutdown the logging pipeline.
+loggerFactory.Dispose();
+
+public static partial class ApplicationLogs
+{
+    [LoggerMessage(EventId = 1, Level = LogLevel.Information, Message = "Food `{name}` price changed to `{price}`.")]
+    public static partial void FoodPriceChanged(this ILogger logger, string name, double price);
 }

docs/metrics/getting-started-console/Program.cs

@@ -18,16 +18,14 @@
 using OpenTelemetry;
 using OpenTelemetry.Metrics;
 
-namespace GettingStarted;
-
 public class Program
 {
     private static readonly Meter MyMeter = new("MyCompany.MyProduct.MyLibrary", "1.0");
     private static readonly Counter<long> MyFruitCounter = MyMeter.CreateCounter<long>("MyFruitCounter");
 
     public static void Main()
     {
-        using var meterProvider = Sdk.CreateMeterProviderBuilder()
+        var meterProvider = Sdk.CreateMeterProviderBuilder()
             .AddMeter("MyCompany.MyProduct.MyLibrary")
             .AddConsoleExporter()
             .Build();
@@ -38,5 +36,9 @@ public static void Main()
         MyFruitCounter.Add(2, new("name", "apple"), new("color", "green"));
         MyFruitCounter.Add(5, new("name", "apple"), new("color", "red"));
         MyFruitCounter.Add(4, new("name", "lemon"), new("color", "yellow"));
+
+        // Dispose meter provider before the application ends.
+        // This will flush the remaining metrics and shutdown the metrics pipeline.
+        meterProvider?.Dispose();
     }
 }

docs/trace/getting-started-console/Program.cs

@@ -18,16 +18,13 @@
 using OpenTelemetry;
 using OpenTelemetry.Trace;
 
-namespace GettingStarted;
-
 public class Program
 {
-    private static readonly ActivitySource MyActivitySource = new(
-        "MyCompany.MyProduct.MyLibrary");
+    private static readonly ActivitySource MyActivitySource = new("MyCompany.MyProduct.MyLibrary");
 
     public static void Main()
     {
-        using var tracerProvider = Sdk.CreateTracerProviderBuilder()
+        var tracerProvider = Sdk.CreateTracerProviderBuilder()
             .AddSource("MyCompany.MyProduct.MyLibrary")
             .AddConsoleExporter()
             .Build();
@@ -39,5 +36,9 @@ public static void Main()
             activity?.SetTag("baz", new int[] { 1, 2, 3 });
             activity?.SetStatus(ActivityStatusCode.Ok);
         }
+
+        // Dispose tracer provider before the application ends.
+        // This will flush the remaining spans and shutdown the tracing pipeline.
+        tracerProvider?.Dispose();
     }
 }