Add open telemetry (#137)

* Add basic tracing from OpenTelemetry * Added Mongo instrumentation * Added gRPC instrumentation * Hid console exporter behind development flag * Merge branch 'add_open_telemetry_#58' of https://github.com/sillsdev/serval into add_open_telemetry_#58
sillsdev · Sep 22, 2023 · 1055c05 · 1055c05
1 parent 321019c
commit 1055c05
Show file tree

Hide file tree

Showing 6 changed files with 27 additions and 1 deletion.
diff --git a/src/SIL.DataAccess/IServiceCollectionExtensions.cs b/src/SIL.DataAccess/IServiceCollectionExtensions.cs
@@ -32,6 +32,7 @@ Action<IMongoDataAccessConfigurator> configure
         services.Configure<MongoDataAccessOptions>(options => options.Url = new MongoUrl(connectionString));
         services.AddTransient<SIL.DataAccess.IIdGenerator, ObjectIdGenerator>();
         var clientSettings = MongoClientSettings.FromConnectionString(connectionString);
+        clientSettings.ClusterConfigurator = cb => cb.Subscribe(new DiagnosticsActivityEventSubscriber());
         clientSettings.LinqProvider = LinqProvider.V2;
         services.AddSingleton<IMongoClient>(sp => new MongoClient(clientSettings));
         services.AddSingleton(

diff --git a/src/SIL.DataAccess/SIL.DataAccess.csproj b/src/SIL.DataAccess/SIL.DataAccess.csproj
@@ -14,6 +14,7 @@
 		<PackageReference Include="Microsoft.Extensions.Hosting.Abstractions" Version="6.0.0" />
 		<PackageReference Include="Microsoft.Extensions.Options" Version="6.0.0" />
 		<PackageReference Include="MongoDB.Driver" Version="2.20.0" />
+		<PackageReference Include="MongoDB.Driver.Core.Extensions.DiagnosticSources" Version="1.3.0" />
 		<PackageReference Include="Newtonsoft.Json" Version="13.0.2" />
 		<PackageReference Include="Nito.AsyncEx" Version="5.1.2" />
 		<PackageReference Include="SIL.Core" Version="12.0.1" />

diff --git a/src/SIL.DataAccess/Usings.cs b/src/SIL.DataAccess/Usings.cs
@@ -13,6 +13,7 @@
 global using MongoDB.Bson.Serialization;
 global using MongoDB.Bson.Serialization.Conventions;
 global using MongoDB.Bson.Serialization.Serializers;
+global using MongoDB.Driver.Core.Extensions.DiagnosticSources;
 global using MongoDB.Driver;
 global using MongoDB.Driver.Linq;
 global using Nito.AsyncEx;

diff --git a/src/Serval.ApiServer/Serval.ApiServer.csproj b/src/Serval.ApiServer/Serval.ApiServer.csproj
@@ -21,6 +21,11 @@
 			<PrivateAssets>all</PrivateAssets>
 			<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
 		</PackageReference>
+		<PackageReference Include="OpenTelemetry.Exporter.Console" Version="1.6.0" />
+		<PackageReference Include="OpenTelemetry.Extensions.Hosting" Version="1.6.0" />
+		<PackageReference Include="OpenTelemetry.Instrumentation.AspNetCore" Version="1.5.1-beta.1" />
+		<PackageReference Include="OpenTelemetry.Instrumentation.GrpcNetClient" Version="1.5.1-beta.1" />
+		<PackageReference Include="OpenTelemetry.Instrumentation.Http" Version="1.5.1-beta.1" />
 	</ItemGroup>
 
 	<ItemGroup>

diff --git a/src/Serval.ApiServer/Startup.cs b/src/Serval.ApiServer/Startup.cs
@@ -2,13 +2,16 @@
 
 public class Startup
 {
-    public Startup(IConfiguration configuration)
+    public Startup(IConfiguration configuration, IWebHostEnvironment environment)
     {
         Configuration = configuration;
+        Environment = environment;
     }
 
     public IConfiguration Configuration { get; }
 
+    public IWebHostEnvironment Environment { get; }
+
     public void ConfigureServices(IServiceCollection services)
     {
         services.AddRouting(o => o.LowercaseUrls = true);
@@ -157,6 +160,18 @@ public void ConfigureServices(IServiceCollection services)
                 };
             });
         }
+        if (Environment.IsDevelopment())
+            services
+                .AddOpenTelemetry()
+                .WithTracing(builder =>
+                {
+                    builder
+                        .AddAspNetCoreInstrumentation()
+                        .AddHttpClientInstrumentation()
+                        .AddGrpcClientInstrumentation()
+                        .AddSource("MongoDB.Driver.Core.Extensions.DiagnosticSources")
+                        .AddConsoleExporter();
+                });
     }
 
     public void Configure(IApplicationBuilder app, IWebHostEnvironment env)

diff --git a/src/Serval.ApiServer/Usings.cs b/src/Serval.ApiServer/Usings.cs
@@ -13,12 +13,15 @@
 global using Microsoft.AspNetCore.Authorization;
 global using Microsoft.AspNetCore.Diagnostics.HealthChecks;
 global using Microsoft.Extensions.Diagnostics.HealthChecks;
+global using Microsoft.Extensions.DependencyInjection;
 global using Microsoft.IdentityModel.Tokens;
 global using NJsonSchema;
 global using NJsonSchema.Generation;
 global using NSwag;
 global using NSwag.AspNetCore;
 global using NSwag.Generation.Processors.Security;
+global using OpenTelemetry;
+global using OpenTelemetry.Trace;
 global using Serval.Shared.Contracts;
 global using Serval.Shared.Controllers;
 global using Serval.Shared.Models;