Extended observability configurability

Author: andrey-serdyuk

Directory.Build.props

@@ -4,7 +4,7 @@
 		<ImplicitUsings>enable</ImplicitUsings>
 		<Nullable>enable</Nullable>
 		<IsPackable>true</IsPackable>
-		<Version>2.3.14</Version>
+		<Version>2.3.16</Version>
 		<Authors>Andrey Serdyuk</Authors>
 		<Company>TaskHub</Company>
 		<Title>TaskHub.Shared - Reusable Primitives for .NET Microservices</Title>

….OpenTelemetry/OpenTelemetryBootstrap.cs …etry/Bootstrap/OpenTelemetryBootstrap.csTaskHub.Observability.OpenTelemetry/OpenTelemetryBootstrap.cs renamed to TaskHub.Observability.OpenTelemetry/Bootstrap/OpenTelemetryBootstrap.cs TaskHub.Observability.OpenTelemetry/OpenTelemetryBootstrap.cs renamed to TaskHub.Observability.OpenTelemetry/Bootstrap/OpenTelemetryBootstrap.cs

@@ -4,32 +4,55 @@
 using OpenTelemetry.Metrics;
 using OpenTelemetry.Resources;
 using OpenTelemetry.Trace;
+using TaskHub.Observability.OpenTelemetry.Options;
+using TaskHub.Observability.OpenTelemetry.Tools;
 
-namespace TaskHub.Observability.OpenTelemetry;
+namespace TaskHub.Observability.OpenTelemetry.Bootstrap;
 
 public static class OpenTelemetryBootstrap
 {
-    public static void AddAppOpenTelemetry(this IServiceCollection services, Action<IServiceProvider, OpenTelemetryOptions> action)
+    public static void AddAppOpenTelemetry(this IServiceCollection services, Action<OpenTelemetryOptions> action)
     {
-        using var sp = services.BuildServiceProvider();
         var options = new OpenTelemetryOptions();
-        action(sp, options);
+        action(options);
 
         services.AddOpenTelemetry().ConfigureResource(t =>
         {
             t.AddService(serviceName: options.ServiceName);
             t.AddAttributes([new("deployment.environment", options.Environment)]);
         }).WithTracing(t =>
         {
-            t.AddSource("CommandsBus", "NominatimClient", "NominatimService");
-            t.AddSource([.. options.Sources]);
-
-            if (options.IsHttpTracesEnabled)
+            if (options.Sampling.IsEnabled)
+            {
+                switch (options.Sampling.Type)
+                {
+                    case SamplingType.AlwaysOn:
+                        t.SetSampler(new AlwaysOnSampler());
+                        break;
+                    case SamplingType.AlwaysOff:
+                        t.SetSampler(new AlwaysOffSampler());
+                        break;
+                    case SamplingType.TraceIdRatio:
+                        t.SetSampler(new TraceIdRatioBasedSampler(options.Sampling.Probability));
+                        break;
+                    case SamplingType.ParentBased:
+                        t.SetSampler(new ParentBasedSampler(new TraceIdRatioBasedSampler(options.Sampling.Probability)));
+                        break;
+                    default:
+                        t.SetSampler(new AlwaysOffSampler());
+                        break;
+                }
+            }
+            else
             {
-                t.AddHttpClientInstrumentation(o => o.RecordException = options.RecordException);
+                t.SetSampler(new AlwaysOffSampler());
             }
 
-            t.AddHttpClientInstrumentation(o =>
+            t.SetSampler(new TraceIdRatioBasedSampler(0.1f));
+            t.AddSource("CommandsBus", "NominatimClient", "NominatimService");
+            t.AddSource([.. options.Sources]);
+
+            if (options.IsHttpTracesEnabled) t.AddHttpClientInstrumentation(o =>
             {
                 o.RecordException = options.RecordException;
                 o.FilterHttpRequestMessage = req =>
@@ -45,10 +68,11 @@ public static void AddAppOpenTelemetry(this IServiceCollection services, Action<
                         return false;
                     }
 
-
                     return true;
                 };
-            }).AddAspNetCoreInstrumentation(o =>
+            });
+
+            if (options.IsAspNetTracesEnabled) t.AddAspNetCoreInstrumentation(o =>
             {
                 o.RecordException = options.RecordException;
                 o.Filter = ctx =>
@@ -61,22 +85,26 @@ public static void AddAppOpenTelemetry(this IServiceCollection services, Action<
 
                     return options.Ignore.Any(ignore => path.StartsWithSegments(ignore)) == false;
                 };
-            }).AddEntityFrameworkCoreInstrumentation(cntx => cntx.EnrichWithIDbCommand = (activity, command) =>
+            });
+
+            if (options.IsEFCoreTracesEnabled) t.AddEntityFrameworkCoreInstrumentation(cntx => cntx.EnrichWithIDbCommand = (activity, command) =>
             {
                 var sql = command.CommandText?.TrimStart() ?? string.Empty;
                 var space = sql.IndexOf(' ');
                 var verb = space > 0 ? sql[..space].ToUpperInvariant() : "SQL";
-                var table = Tools.ExtractTableName(sql, verb);
+                var table = OtelTools.ExtractTableName(sql, verb);
 
                 activity.DisplayName = $"SQL {verb} {table}".Trim();
                 activity.SetTag("db.statement", sql);
                 activity.SetTag("db.system", command.Connection?.GetType().Name);
                 activity.SetTag("db.table", table);
                 activity.SetTag("db.name", command.Connection?.Database);
-            }).AddOtlpExporter(cntx =>
+            });
+
+            t.AddOtlpExporter(cntx =>
             {
                 cntx.Endpoint = new Uri(options.TracingEndpoint);
-                cntx.Protocol = OtlpExportProtocol.Grpc;
+                cntx.Protocol = options.Protocol == "grpc" ? OtlpExportProtocol.Grpc : OtlpExportProtocol.HttpProtobuf;
             });
         });
     }

…ty.OpenTelemetry/OpenTelemetryOptions.cs …elemetry/Options/OpenTelemetryOptions.csTaskHub.Observability.OpenTelemetry/OpenTelemetryOptions.cs renamed to TaskHub.Observability.OpenTelemetry/Options/OpenTelemetryOptions.cs TaskHub.Observability.OpenTelemetry/OpenTelemetryOptions.cs renamed to TaskHub.Observability.OpenTelemetry/Options/OpenTelemetryOptions.cs

@@ -1,15 +1,19 @@
-namespace TaskHub.Observability.OpenTelemetry;
+namespace TaskHub.Observability.OpenTelemetry.Options;
 
 public class OpenTelemetryOptions
 {
     public string TracingEndpoint { get; set; } = string.Empty;
+    public string Protocol { get; set; } = string.Empty;
     public string DbName { get; set; } = string.Empty;
     public string ServiceName { get; set; } = string.Empty;
     public string ServiceVersion { get; set; } = string.Empty;
     public string Environment { get; set; } = string.Empty;
     public bool RecordException { get; set; } = false;
     public bool SetDbStatementForText { get; set; } = false;
     public bool IsHttpTracesEnabled { get; set; } = true;
+    public bool IsAspNetTracesEnabled { get; set; } = true;
+    public bool IsEFCoreTracesEnabled { get; set; } = true;
     public List<string> Sources { get; set; } = [];
     public List<string> Ignore { get; set; } = [];
+    public SamplingOptions Sampling { get; set; } = new();
 }

TaskHub.Observability.OpenTelemetry/Options/SamplingOptions.cs

@@ -0,0 +1,8 @@
+namespace TaskHub.Observability.OpenTelemetry.Options;
+
+public class SamplingOptions
+{
+    public bool IsEnabled { get; set; }
+    public SamplingType Type { get; set; } = SamplingType.AlwaysOn;
+    public float Probability { get; set; } = 1.0f;
+}

TaskHub.Observability.OpenTelemetry/Options/SamplingType.cs

@@ -0,0 +1,9 @@
+namespace TaskHub.Observability.OpenTelemetry.Options;
+
+public enum SamplingType
+{
+    AlwaysOn,
+    AlwaysOff,
+    TraceIdRatio,
+    ParentBased
+}

…bility.OpenTelemetry/ExtractTableName.cs ….OpenTelemetry/Tools/ExtractTableName.csTaskHub.Observability.OpenTelemetry/ExtractTableName.cs renamed to TaskHub.Observability.OpenTelemetry/Tools/ExtractTableName.cs TaskHub.Observability.OpenTelemetry/ExtractTableName.cs renamed to TaskHub.Observability.OpenTelemetry/Tools/ExtractTableName.cs

@@ -1,6 +1,6 @@
-namespace TaskHub.Observability.OpenTelemetry;
+namespace TaskHub.Observability.OpenTelemetry.Tools;
 
-public class Tools
+public class OtelTools
 {
     public static string ExtractTableName(string sql, string verb)
     {

TaskHub.Shared.Bootstraper.Full/FullHostBuilder.cs

@@ -5,7 +5,7 @@
 using Prometheus;
 using TaskHub.Observability.Logger;
 using TaskHub.Observability.Metrics.Implementation.Bootstrap;
-using TaskHub.Observability.OpenTelemetry;
+using TaskHub.Observability.OpenTelemetry.Bootstrap;
 using TaskHub.Shared.Authorization.Identity.Bootstrap;
 using TaskHub.Shared.Bootstraper.Basic;
 using TaskHub.Shared.Commands.Implementation.Bootstrap;
@@ -44,10 +44,12 @@ protected override void AppStart()
         base.AppStart();
         Builder.Host.AddAppSerilog();
         Builder.Services.AddServiceInfo();
-        Builder.Services.AddAppOpenTelemetry((sp, o) =>
+
+        Builder.Services.AddAppOpenTelemetry(o =>
         {
             Builder.Configuration.GetSection("OpenTelemetry").Bind(o);
-            var appInfo = sp.GetRequiredService<ServiceInfo>();
+
+            var appInfo = Builder.Configuration.GetSection("ServiceInfo").Get<ServiceInfo>() ?? new();
             o.ServiceName = appInfo.Name;
             o.ServiceVersion = appInfo.Version;
         });