docs(example): update Console example with formatter option (#6391)

Author: sgryphon

examples/Console/Program.cs

@@ -76,6 +76,9 @@ internal sealed class MetricsOptions
     [Option("useExporter", Default = "console", HelpText = "Options include otlp or console.", Required = false)]
     public string? UseExporter { get; set; }
 
+    [Option("useFormatter", Default = "compact", HelpText = "Formatter for console exporter include Compact or Detail).", Required = false)]
+    public string? UseFormatter { get; set; }
+
     [Option('e', "endpoint", HelpText = "Target to which the exporter is going to send metrics (default value depends on protocol).", Default = null)]
     public string? Endpoint { get; set; }
 
@@ -96,6 +99,8 @@ internal sealed class HttpClientOptions
 [Verb("console", HelpText = "Specify the options required to test console exporter")]
 internal sealed class ConsoleOptions
 {
+    [Option("useFormatter", Default = "compact", HelpText = "Formatter for console exporter include Compact or Detail).", Required = false)]
+    public string? UseFormatter { get; set; }
 }
 
 [Verb("otelshim", HelpText = "Specify the options required to test OpenTelemetry Shim with console exporter")]
@@ -124,6 +129,9 @@ internal sealed class LogsOptions
     [Option("useExporter", Default = "otlp", HelpText = "Options include otlp or console.", Required = false)]
     public string? UseExporter { get; set; }
 
+    [Option("useFormatter", Default = "compact", HelpText = "Formatter for console exporter include Compact or Detail).", Required = false)]
+    public string? UseFormatter { get; set; }
+
     [Option('e', "endpoint", HelpText = "Target to which the OTLP exporter is going to send logs (default value depends on protocol).", Default = null)]
     public string? Endpoint { get; set; }
 

examples/Console/TestConsoleExporter.cs

@@ -16,11 +16,6 @@ internal sealed class TestConsoleExporter
     //
     // dotnet run console
     internal static int Run(ConsoleOptions options)
-    {
-        return RunWithActivitySource();
-    }
-
-    private static int RunWithActivitySource()
     {
         // Enable OpenTelemetry for the sources "Samples.SampleServer" and "Samples.SampleClient"
         // and use Console exporter.
@@ -30,7 +25,7 @@ private static int RunWithActivitySource()
 #pragma warning disable CA2000 // Dispose objects before losing scope
             .AddProcessor(new MyProcessor()) // This must be added before ConsoleExporter
 #pragma warning restore CA2000 // Dispose objects before losing scope
-            .AddConsoleExporter()
+            .AddConsoleExporter(config => config.Formatter = options.UseFormatter ?? "Compact")
             .Build();
 
         // The above line is required only in applications

examples/Console/TestLogs.cs

@@ -1,6 +1,7 @@
 // Copyright The OpenTelemetry Authors
 // SPDX-License-Identifier: Apache-2.0
 
+using System.Diagnostics;
 using Microsoft.Extensions.Logging;
 using OpenTelemetry;
 using OpenTelemetry.Logs;
@@ -11,8 +12,17 @@ internal sealed class TestLogs
 {
     internal static int Run(LogsOptions options)
     {
+        // Add ActivitySource listener to enable activity (span) creation
+        using var listener = new ActivityListener
+        {
+            ShouldListenTo = _ => true,
+            Sample = (ref ActivityCreationOptions<ActivityContext> options) => ActivitySamplingResult.AllData,
+        };
+        ActivitySource.AddActivityListener(listener);
+
         using var loggerFactory = LoggerFactory.Create(builder =>
         {
+            builder.SetMinimumLevel(LogLevel.Debug);
             builder.AddOpenTelemetry((opt) =>
             {
                 opt.IncludeFormattedMessage = true;
@@ -107,16 +117,41 @@ internal static int Run(LogsOptions options)
                 }
                 else
                 {
-                    opt.AddConsoleExporter();
+                    opt.AddConsoleExporter(config => config.Formatter = options.UseFormatter ?? "Compact");
                 }
             });
         });
 
+        using var activitySource = new ActivitySource("Examples.Console");
         var logger = loggerFactory.CreateLogger<TestLogs>();
+
         using (logger.BeginCityScope("Seattle"))
         using (logger.BeginStoreTypeScope("Physical"))
         {
             logger.HelloFrom("tomato", 2.99);
+
+            using (var activity = activitySource.StartActivity("TestLogs", ActivityKind.Internal))
+            {
+                try
+                {
+#pragma warning disable CA1848 // For example purposes
+                    logger.LogWarning(1234, "Size exceeds {Limit}.", 5);
+#pragma warning restore CA1848
+
+                    using (var activity2 = activitySource.StartActivity("Inner", ActivityKind.Internal))
+                    {
+#pragma warning disable CA1848 // For example purposes
+                        logger.LogDebug("Random {Guid}", Guid.NewGuid());
+#pragma warning restore CA1848
+
+                        throw new NotImplementedException("TEST EXCEPTION");
+                    }
+                }
+                catch (NotImplementedException ex)
+                {
+                    logger.CrashMessage("test", ex);
+                }
+            }
         }
 
         return 0;

examples/Console/TestLogsExtensions.cs

@@ -16,4 +16,7 @@ internal static partial class TestLogsExtensions
 
     [LoggerMessage(LogLevel.Information, "Hello from {Name} {Price}.")]
     public static partial void HelloFrom(this ILogger logger, string name, double price);
+
+    [LoggerMessage(LogLevel.Critical, "Critical Error from {Source}.")]
+    public static partial void CrashMessage(this ILogger logger, string source, Exception ex);
 }

examples/Console/TestMetrics.cs

@@ -71,6 +71,7 @@ internal static int Run(MetricsOptions options)
                 .AddConsoleExporter((exporterOptions, metricReaderOptions) =>
                 {
                     exporterOptions.Targets = ConsoleExporterOutputTargets.Console;
+                    exporterOptions.Formatter = options.UseFormatter ?? "Compact";
 
                     metricReaderOptions.PeriodicExportingMetricReaderOptions.ExportIntervalMilliseconds = options.DefaultCollectionPeriodMilliseconds;
                     metricReaderOptions.TemporalityPreference = options.IsDelta ? MetricReaderTemporalityPreference.Delta : MetricReaderTemporalityPreference.Cumulative;