[Examples] Nullable (open-telemetry#5881)

Co-authored-by: Mikel Blanchard <[email protected]>

Author: ysolomchenko

examples/Console/Examples.Console.csproj

@@ -4,9 +4,6 @@
     <OutputType>Exe</OutputType>
     <TargetFramework>$(DefaultTargetFrameworkForExampleApps)</TargetFramework>
     <NoWarn>$(NoWarn),CS0618</NoWarn>
-
-    <!-- this is temporary. will remove in future PR. -->
-    <Nullable>disable</Nullable>
   </PropertyGroup>
 
   <ItemGroup>

examples/Console/InstrumentationWithActivitySource.cs

@@ -47,13 +47,13 @@ public void Start(string url)
                         var context = this.listener.GetContext();
 
                         using var activity = source.StartActivity(
-                            $"{context.Request.HttpMethod}:{context.Request.Url.AbsolutePath}",
+                            $"{context.Request.HttpMethod}:{context.Request.Url!.AbsolutePath}",
                             ActivityKind.Server);
 
                         var headerKeys = context.Request.Headers.AllKeys;
                         foreach (var headerKey in headerKeys)
                         {
-                            string headerValue = context.Request.Headers[headerKey];
+                            string? headerValue = context.Request.Headers[headerKey];
                             activity?.SetTag($"http.header.{headerKey}", headerValue);
                         }
 
@@ -62,7 +62,7 @@ public void Start(string url)
                         using (var reader = new StreamReader(context.Request.InputStream, context.Request.ContentEncoding))
                         {
                             requestContent = reader.ReadToEnd();
-                            childSpan.AddEvent(new ActivityEvent("StreamReader.ReadToEnd"));
+                            childSpan?.AddEvent(new ActivityEvent("StreamReader.ReadToEnd"));
                         }
 
                         activity?.SetTag("request.content", requestContent);
@@ -90,8 +90,8 @@ public void Dispose()
 
     private class SampleClient : IDisposable
     {
-        private CancellationTokenSource cts;
-        private Task requestTask;
+        private CancellationTokenSource? cts;
+        private Task? requestTask;
 
         public void Start(string url)
         {
@@ -154,7 +154,7 @@ public void Dispose()
             if (this.cts != null)
             {
                 this.cts.Cancel();
-                this.requestTask.Wait();
+                this.requestTask!.Wait();
                 this.requestTask.Dispose();
                 this.cts.Dispose();
             }

examples/Console/Program.cs

@@ -33,16 +33,16 @@ public static void Main(string[] args)
     {
         Parser.Default.ParseArguments<ZipkinOptions, PrometheusOptions, MetricsOptions, LogsOptions, GrpcNetClientOptions, HttpClientOptions, ConsoleOptions, OpenTelemetryShimOptions, OpenTracingShimOptions, OtlpOptions, InMemoryOptions>(args)
             .MapResult(
-                (ZipkinOptions options) => TestZipkinExporter.Run(options.Uri),
-                (PrometheusOptions options) => TestPrometheusExporter.Run(options.Port),
+                (ZipkinOptions options) => TestZipkinExporter.Run(options),
+                (PrometheusOptions options) => TestPrometheusExporter.Run(options),
                 (MetricsOptions options) => TestMetrics.Run(options),
                 (LogsOptions options) => TestLogs.Run(options),
-                (GrpcNetClientOptions options) => TestGrpcNetClient.Run(),
-                (HttpClientOptions options) => TestHttpClient.Run(),
+                (GrpcNetClientOptions options) => TestGrpcNetClient.Run(options),
+                (HttpClientOptions options) => TestHttpClient.Run(options),
                 (ConsoleOptions options) => TestConsoleExporter.Run(options),
                 (OpenTelemetryShimOptions options) => TestOTelShimWithConsoleExporter.Run(options),
                 (OpenTracingShimOptions options) => TestOpenTracingShim.Run(options),
-                (OtlpOptions options) => TestOtlpExporter.Run(options.Endpoint, options.Protocol),
+                (OtlpOptions options) => TestOtlpExporter.Run(options),
                 (InMemoryOptions options) => TestInMemoryExporter.Run(options),
                 errs => 1);
     }
@@ -54,7 +54,7 @@ public static void Main(string[] args)
 internal class ZipkinOptions
 {
     [Option('u', "uri", HelpText = "Please specify the uri of Zipkin backend", Required = true)]
-    public string Uri { get; set; }
+    public required string Uri { get; set; }
 }
 
 [Verb("prometheus", HelpText = "Specify the options required to test Prometheus")]
@@ -83,10 +83,10 @@ internal class MetricsOptions
     public int DefaultCollectionPeriodMilliseconds { get; set; }
 
     [Option("useExporter", Default = "console", HelpText = "Options include otlp or console.", Required = false)]
-    public string UseExporter { get; set; }
+    public string? UseExporter { 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; }
+    public string? Endpoint { get; set; }
 
     [Option('p', "useGrpc", HelpText = "Use gRPC or HTTP when using the OTLP exporter", Required = false, Default = true)]
     public bool UseGrpc { get; set; }
@@ -121,26 +121,26 @@ internal class OpenTracingShimOptions
 internal class OtlpOptions
 {
     [Option('e', "endpoint", HelpText = "Target to which the exporter is going to send traces (default value depends on protocol).", Default = null)]
-    public string Endpoint { get; set; }
+    public string? Endpoint { get; set; }
 
     [Option('p', "protocol", HelpText = "Transport protocol used by exporter. Supported values: grpc and http/protobuf.", Default = "grpc")]
-    public string Protocol { get; set; }
+    public string? Protocol { get; set; }
 }
 
 [Verb("logs", HelpText = "Specify the options required to test Logs")]
 internal class LogsOptions
 {
     [Option("useExporter", Default = "otlp", HelpText = "Options include otlp or console.", Required = false)]
-    public string UseExporter { get; set; }
+    public string? UseExporter { 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; }
+    public string? Endpoint { get; set; }
 
     [Option('p', "protocol", HelpText = "Transport protocol used by OTLP exporter. Supported values: grpc and http/protobuf. Only applicable if Exporter is OTLP", Default = "grpc")]
-    public string Protocol { get; set; }
+    public string? Protocol { get; set; }
 
     [Option("processorType", Default = "batch", HelpText = "export processor type. Supported values: simple and batch", Required = false)]
-    public string ProcessorType { get; set; }
+    public string? ProcessorType { get; set; }
 
     [Option("scheduledDelay", Default = 5000, HelpText = "The delay interval in milliseconds between two consecutive exports.", Required = false)]
     public int ScheduledDelayInMilliseconds { get; set; }

examples/Console/TestConsoleExporter.cs

@@ -15,21 +15,21 @@ internal class TestConsoleExporter
     // (eg: C:\repos\opentelemetry-dotnet\examples\Console\)
     //
     // dotnet run console
-    internal static object Run(ConsoleOptions options)
+    internal static int Run(ConsoleOptions options)
     {
         return RunWithActivitySource();
     }
 
-    private static object RunWithActivitySource()
+    private static int RunWithActivitySource()
     {
         // Enable OpenTelemetry for the sources "Samples.SampleServer" and "Samples.SampleClient"
         // and use Console exporter.
         using var tracerProvider = Sdk.CreateTracerProviderBuilder()
-                .AddSource("Samples.SampleClient", "Samples.SampleServer")
-                .ConfigureResource(res => res.AddService("console-test"))
-                .AddProcessor(new MyProcessor()) // This must be added before ConsoleExporter
-                .AddConsoleExporter()
-                .Build();
+            .AddSource("Samples.SampleClient", "Samples.SampleServer")
+            .ConfigureResource(res => res.AddService("console-test"))
+            .AddProcessor(new MyProcessor()) // This must be added before ConsoleExporter
+            .AddConsoleExporter()
+            .Build();
 
         // The above line is required only in applications
         // which decide to use OpenTelemetry.
@@ -43,7 +43,7 @@ private static object RunWithActivitySource()
             System.Console.ReadLine();
         }
 
-        return null;
+        return 0;
     }
 
     /// <summary>

examples/Console/TestGrpcNetClient.cs

@@ -12,8 +12,10 @@ namespace Examples.Console;
 
 internal class TestGrpcNetClient
 {
-    internal static object Run()
+    internal static int Run(GrpcNetClientOptions options)
     {
+        Debug.Assert(options != null, "options was null");
+
         // Prerequisite for running this example.
         // In a separate console window, start the example
         // ASP.NET Core gRPC service by running the following command
@@ -55,6 +57,6 @@ internal static object Run()
         System.Console.WriteLine("Press Enter key to exit.");
         System.Console.ReadLine();
 
-        return null;
+        return 0;
     }
 }

examples/Console/TestHttpClient.cs

@@ -15,8 +15,10 @@ internal class TestHttpClient
     // (eg: C:\repos\opentelemetry-dotnet\examples\Console\)
     //
     // dotnet run httpclient
-    internal static object Run()
+    internal static int Run(HttpClientOptions options)
     {
+        Debug.Assert(options != null, "options was null");
+
         System.Console.WriteLine("Hello World!");
 
         using var tracerProvider = Sdk.CreateTracerProviderBuilder()
@@ -36,6 +38,6 @@ internal static object Run()
         System.Console.WriteLine("Press Enter key to exit.");
         System.Console.ReadLine();
 
-        return null;
+        return 0;
     }
 }

examples/Console/TestInMemoryExporter.cs

@@ -15,7 +15,7 @@ internal class TestInMemoryExporter
     // (eg: C:\repos\opentelemetry-dotnet\examples\Console\)
     //
     // dotnet run inmemory
-    internal static object Run(InMemoryOptions options)
+    internal static int Run(InMemoryOptions options)
     {
         // List that will be populated with the traces by InMemoryExporter
         var exportedItems = new List<Activity>();
@@ -28,18 +28,18 @@ internal static object Run(InMemoryOptions options)
             System.Console.WriteLine($"ActivitySource: {activity.Source.Name} logged the activity {activity.DisplayName}");
         }
 
-        return null;
+        return 0;
     }
 
     private static void RunWithActivitySource(ICollection<Activity> exportedItems)
     {
         // Enable OpenTelemetry for the sources "Samples.SampleServer" and "Samples.SampleClient"
         // and use InMemory exporter.
         using var tracerProvider = Sdk.CreateTracerProviderBuilder()
-                .AddSource("Samples.SampleClient", "Samples.SampleServer")
-                .ConfigureResource(r => r.AddService("inmemory-test"))
-                .AddInMemoryExporter(exportedItems)
-                .Build();
+            .AddSource("Samples.SampleClient", "Samples.SampleServer")
+            .ConfigureResource(r => r.AddService("inmemory-test"))
+            .AddInMemoryExporter(exportedItems)
+            .Build();
 
         // The above line is required only in applications
         // which decide to use OpenTelemetry.

examples/Console/TestLogs.cs

@@ -9,15 +9,16 @@ namespace Examples.Console;
 
 internal class TestLogs
 {
-    internal static object Run(LogsOptions options)
+    internal static int Run(LogsOptions options)
     {
         using var loggerFactory = LoggerFactory.Create(builder =>
         {
             builder.AddOpenTelemetry((opt) =>
             {
                 opt.IncludeFormattedMessage = true;
                 opt.IncludeScopes = true;
-                if (options.UseExporter.Equals("otlp", StringComparison.OrdinalIgnoreCase))
+
+                if ("otlp".Equals(options.UseExporter, StringComparison.OrdinalIgnoreCase))
                 {
                     /*
                      * Prerequisite to run this example:
@@ -43,31 +44,46 @@ internal static object Run(LogsOptions options)
 
                     var protocol = OpenTelemetry.Exporter.OtlpExportProtocol.Grpc;
 
-                    if (options.Protocol.Trim().ToLower().Equals("grpc"))
-                    {
-                        protocol = OpenTelemetry.Exporter.OtlpExportProtocol.Grpc;
-                    }
-                    else if (options.Protocol.Trim().ToLower().Equals("http/protobuf"))
+                    if (!string.IsNullOrEmpty(options.Protocol))
                     {
-                        protocol = OpenTelemetry.Exporter.OtlpExportProtocol.HttpProtobuf;
+                        switch (options.Protocol.Trim())
+                        {
+                            case "grpc":
+                                protocol = OpenTelemetry.Exporter.OtlpExportProtocol.Grpc;
+                                break;
+                            case "http/protobuf":
+                                protocol = OpenTelemetry.Exporter.OtlpExportProtocol.HttpProtobuf;
+                                break;
+                            default:
+                                System.Console.WriteLine($"Export protocol {options.Protocol} is not supported. Default protocol 'grpc' will be used.");
+                                break;
+                        }
                     }
                     else
                     {
-                        System.Console.WriteLine($"Export protocol {options.Protocol} is not supported. Default protocol 'grpc' will be used.");
+                        System.Console.WriteLine("Protocol is null or empty. Default protocol 'grpc' will be used.");
                     }
 
                     var processorType = ExportProcessorType.Batch;
-                    if (options.ProcessorType.Trim().ToLower().Equals("batch"))
-                    {
-                        processorType = ExportProcessorType.Batch;
-                    }
-                    else if (options.ProcessorType.Trim().ToLower().Equals("simple"))
+
+                    if (!string.IsNullOrEmpty(options.ProcessorType))
                     {
-                        processorType = ExportProcessorType.Simple;
+                        switch (options.ProcessorType.Trim())
+                        {
+                            case "batch":
+                                processorType = ExportProcessorType.Batch;
+                                break;
+                            case "simple":
+                                processorType = ExportProcessorType.Simple;
+                                break;
+                            default:
+                                System.Console.WriteLine($"Export processor type {options.ProcessorType} is not supported. Default processor type 'batch' will be used.");
+                                break;
+                        }
                     }
                     else
                     {
-                        System.Console.WriteLine($"Export processor type {options.ProcessorType} is not supported. Default processor type 'batch' will be used.");
+                        System.Console.WriteLine("Processor type is null or empty. Default processor type 'batch' will be used.");
                     }
 
                     opt.AddOtlpExporter((exporterOptions, processorOptions) =>
@@ -103,6 +119,6 @@ internal static object Run(LogsOptions options)
             logger.LogInformation("Hello from {name} {price}.", "tomato", 2.99);
         }
 
-        return null;
+        return 0;
     }
 }