enable opentelemetry

Barsonax · May 24, 2024 · c715a24 · c715a24
1 parent eceaf85
commit c715a24
Show file tree

Hide file tree

Showing 6 changed files with 100 additions and 51 deletions.
diff --git a/CleanAspCore.Api.Tests/CleanAspCore.Api.Tests.csproj b/CleanAspCore.Api.Tests/CleanAspCore.Api.Tests.csproj
@@ -18,7 +18,7 @@
     <PackageReference Include="Microsoft.EntityFrameworkCore.Relational" Version="8.0.4"/>
 
     <PackageReference Include="Testcontainers.PostgreSql" Version="3.8.0"/>
-    <PackageReference Include="Npgsql" Version="8.0.2"/>
+    <PackageReference Include="Npgsql" Version="8.0.3"/>
     <PackageReference Include="Respawn" Version="6.2.1"/>
 
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.9.0"/>

diff --git a/CleanAspCore/AppConfiguration.cs b/CleanAspCore/AppConfiguration.cs
@@ -1,7 +1,15 @@
-using System.Net;
+using System.Reflection;
 using CleanAspCore.Endpoints.Departments;
 using CleanAspCore.Endpoints.Employees;
 using CleanAspCore.Endpoints.Jobs;
+using MicroElements.Swashbuckle.FluentValidation.AspNetCore;
+using Microsoft.AspNetCore.Authentication.JwtBearer;
+using Microsoft.AspNetCore.Authorization;
+using Microsoft.OpenApi.Models;
+using OpenTelemetry.Logs;
+using OpenTelemetry.Metrics;
+using OpenTelemetry.Resources;
+using OpenTelemetry.Trace;
 
 namespace CleanAspCore;
 
@@ -19,8 +27,66 @@ internal static void AddAppRoutes(this IEndpointRouteBuilder host)
         host.AddJobsRoutes();
     }
 
-    public static RouteHandlerBuilder RequireAuthorization(this RouteHandlerBuilder builder, params string[] policyNames) =>
-        AuthorizationEndpointConventionBuilderExtensions.RequireAuthorization(builder, policyNames)
-            .Produces((int)HttpStatusCode.Unauthorized)
-            .Produces((int)HttpStatusCode.Forbidden);
+    internal static void AddAuthServices(this WebApplicationBuilder builder)
+    {
+        builder.Services.AddAuthorizationBuilder()
+            .AddFallbackPolicy("Fallback", new AuthorizationPolicyBuilder()
+                .RequireAuthenticatedUser()
+                .Build());
+
+        builder.Services.AddAuthentication(JwtBearerDefaults.AuthenticationScheme)
+            .AddJwtBearer(JwtBearerDefaults.AuthenticationScheme);
+    }
+
+    internal static void AddSwaggerServices(this WebApplicationBuilder builder)
+    {
+        builder.Services.AddEndpointsApiExplorer();
+        builder.Services.AddSwaggerGen(options =>
+        {
+            options.SupportNonNullableReferenceTypes();
+
+            var xmlDocPath = Path.Combine(AppContext.BaseDirectory, $"{Assembly.GetExecutingAssembly().GetName().Name}.xml");
+            options.IncludeXmlComments(xmlDocPath);
+
+            var jwtSecurityScheme = new OpenApiSecurityScheme
+            {
+                BearerFormat = "JWT",
+                Name = "JWT Authentication",
+                In = ParameterLocation.Header,
+                Type = SecuritySchemeType.Http,
+                Scheme = JwtBearerDefaults.AuthenticationScheme,
+                Description = "Put **_ONLY_** your JWT Bearer token on textbox below!",
+                Reference = new OpenApiReference
+                {
+                    Id = JwtBearerDefaults.AuthenticationScheme,
+                    Type = ReferenceType.SecurityScheme
+                }
+            };
+
+            options.AddSecurityDefinition(jwtSecurityScheme.Reference.Id, jwtSecurityScheme);
+
+            options.AddSecurityRequirement(new OpenApiSecurityRequirement { { jwtSecurityScheme, Array.Empty<string>() } });
+        });
+        builder.Services.AddFluentValidationRulesToSwagger();
+    }
+
+    internal static void AddOpenTelemetryServices(this WebApplicationBuilder builder)
+    {
+        builder.Logging.AddOpenTelemetry(options =>
+        {
+            options
+                .SetResourceBuilder(
+                    ResourceBuilder.CreateDefault()
+                        .AddService(builder.Environment.ApplicationName))
+                .AddOtlpExporter();
+        });
+        builder.Services.AddOpenTelemetry()
+            .ConfigureResource(resource => resource.AddService(builder.Environment.ApplicationName))
+            .WithTracing(tracing => tracing
+                .AddAspNetCoreInstrumentation()
+                .AddOtlpExporter())
+            .WithMetrics(metrics => metrics
+                .AddAspNetCoreInstrumentation()
+                .AddOtlpExporter());
+    }
 }
diff --git a/CleanAspCore/CleanAspCore.csproj b/CleanAspCore/CleanAspCore.csproj
@@ -20,6 +20,9 @@
     </PackageReference>
     <PackageReference Include="Microsoft.Extensions.Http.Polly" Version="8.0.4"/>
     <PackageReference Include="Npgsql.EntityFrameworkCore.PostgreSQL" Version="8.0.2"/>
+    <PackageReference Include="OpenTelemetry.Exporter.OpenTelemetryProtocol" Version="1.8.1"/>
+    <PackageReference Include="OpenTelemetry.Extensions.Hosting" Version="1.8.1"/>
+    <PackageReference Include="OpenTelemetry.Instrumentation.AspNetCore" Version="1.8.1"/>
     <PackageReference Include="Polly.Contrib.WaitAndRetry" Version="1.1.1"/>
     <PackageReference Include="Swashbuckle.AspNetCore" Version="6.5.0"/>
   </ItemGroup>

diff --git a/CleanAspCore/Extensions/RouteHandler/RouteHandlerExtensions.cs b/CleanAspCore/Extensions/RouteHandler/RouteHandlerExtensions.cs
@@ -0,0 +1,11 @@
+using System.Net;
+
+namespace CleanAspCore.Extensions.RouteHandler;
+
+public static class RouteHandlerExtensions
+{
+    public static RouteHandlerBuilder RequireAuthorization(this RouteHandlerBuilder builder, params string[] policyNames) =>
+        AuthorizationEndpointConventionBuilderExtensions.RequireAuthorization(builder, policyNames)
+            .Produces((int)HttpStatusCode.Unauthorized)
+            .Produces((int)HttpStatusCode.Forbidden);
+}
diff --git a/CleanAspCore/Program.cs b/CleanAspCore/Program.cs
@@ -1,54 +1,13 @@
 using System.Reflection;
 using CleanAspCore;
 using CleanAspCore.Data;
-using MicroElements.Swashbuckle.FluentValidation.AspNetCore;
-using Microsoft.AspNetCore.Authentication.JwtBearer;
-using Microsoft.AspNetCore.Authorization;
-using Microsoft.OpenApi.Models;
 
 var builder = WebApplication.CreateBuilder(args);
 
-builder.Services.AddEndpointsApiExplorer();
-builder.Services.AddSwaggerGen(options =>
-{
-    options.SupportNonNullableReferenceTypes();
-
-    var xmlDocPath = Path.Combine(AppContext.BaseDirectory, $"{Assembly.GetExecutingAssembly().GetName().Name}.xml");
-    options.IncludeXmlComments(xmlDocPath);
-
-    var jwtSecurityScheme = new OpenApiSecurityScheme
-    {
-        BearerFormat = "JWT",
-        Name = "JWT Authentication",
-        In = ParameterLocation.Header,
-        Type = SecuritySchemeType.Http,
-        Scheme = JwtBearerDefaults.AuthenticationScheme,
-        Description = "Put **_ONLY_** your JWT Bearer token on textbox below!",
-
-        Reference = new OpenApiReference
-        {
-            Id = JwtBearerDefaults.AuthenticationScheme,
-            Type = ReferenceType.SecurityScheme
-        }
-    };
-
-    options.AddSecurityDefinition(jwtSecurityScheme.Reference.Id, jwtSecurityScheme);
-
-    options.AddSecurityRequirement(new OpenApiSecurityRequirement
-    {
-        { jwtSecurityScheme, Array.Empty<string>() }
-    });
-});
-builder.Services.AddFluentValidationRulesToSwagger();
-
-builder.Services.AddAuthorizationBuilder()
-    .AddFallbackPolicy("Fallback", new AuthorizationPolicyBuilder()
-    .RequireAuthenticatedUser()
-    .Build());
-
-builder.Services.AddAuthentication(JwtBearerDefaults.AuthenticationScheme)
-    .AddJwtBearer(JwtBearerDefaults.AuthenticationScheme);
+builder.AddSwaggerServices();
+builder.AddAuthServices();
 builder.AddAppServices();
+builder.AddOpenTelemetryServices();
 
 builder.Services.AddValidatorsFromAssembly(Assembly.GetExecutingAssembly(), includeInternalTypes: true);
 builder.Services.AddDbContext<HrContext>();
@@ -73,5 +32,7 @@
 
 namespace CleanAspCore
 {
-    public partial class Program { }
+    public partial class Program
+    {
+    }
 }
diff --git a/docker-compose.yaml b/docker-compose.yaml
@@ -10,3 +10,11 @@ services:
       - POSTGRES_DB=postgres
     ports:
       - "5432:5432"
+  telemetryDashboard:
+    image: mcr.microsoft.com/dotnet/nightly/aspire-dashboard:latest
+    container_name: "telemetryDashboard"
+    environment:
+      - DOTNET_DASHBOARD_UNSECURED_ALLOW_ANONYMOUS=true
+    ports:
+      - "127.0.0.1:18888:18888"
+      - "127.0.0.1:4317:18889"