|
| 1 | +using Microsoft.AspNetCore.Builder; |
| 2 | +using Microsoft.AspNetCore.Diagnostics.HealthChecks; |
| 3 | +using Microsoft.Extensions.DependencyInjection; |
| 4 | +using Microsoft.Extensions.Diagnostics.HealthChecks; |
| 5 | +using Microsoft.Extensions.Logging; |
| 6 | +using Microsoft.Extensions.ServiceDiscovery; |
| 7 | +using OpenTelemetry; |
| 8 | +using OpenTelemetry.Metrics; |
| 9 | +using OpenTelemetry.Trace; |
| 10 | + |
| 11 | +namespace Microsoft.Extensions.Hosting; |
| 12 | + |
| 13 | +// Adds common Aspire services: service discovery, resilience, health checks, and OpenTelemetry. |
| 14 | +// This project should be referenced by each service project in your solution. |
| 15 | +// To learn more about using this project, see https://aka.ms/dotnet/aspire/service-defaults |
| 16 | +public static class Extensions |
| 17 | +{ |
| 18 | + private const string HealthEndpointPath = "/health"; |
| 19 | + private const string AlivenessEndpointPath = "/alive"; |
| 20 | + |
| 21 | + public static TBuilder AddServiceDefaults<TBuilder>(this TBuilder builder) where TBuilder : IHostApplicationBuilder |
| 22 | + { |
| 23 | + builder.ConfigureOpenTelemetry(); |
| 24 | + |
| 25 | + builder.AddDefaultHealthChecks(); |
| 26 | + |
| 27 | + builder.Services.AddServiceDiscovery(); |
| 28 | + |
| 29 | + builder.Services.ConfigureHttpClientDefaults(http => |
| 30 | + { |
| 31 | + // Turn on resilience by default |
| 32 | + http.AddStandardResilienceHandler(); |
| 33 | + |
| 34 | + // Turn on service discovery by default |
| 35 | + http.AddServiceDiscovery(); |
| 36 | + }); |
| 37 | + |
| 38 | + // Uncomment the following to restrict the allowed schemes for service discovery. |
| 39 | + // builder.Services.Configure<ServiceDiscoveryOptions>(options => |
| 40 | + // { |
| 41 | + // options.AllowedSchemes = ["https"]; |
| 42 | + // }); |
| 43 | + |
| 44 | + return builder; |
| 45 | + } |
| 46 | + |
| 47 | + public static TBuilder ConfigureOpenTelemetry<TBuilder>(this TBuilder builder) where TBuilder : IHostApplicationBuilder |
| 48 | + { |
| 49 | + builder.Logging.AddOpenTelemetry(logging => |
| 50 | + { |
| 51 | + logging.IncludeFormattedMessage = true; |
| 52 | + logging.IncludeScopes = true; |
| 53 | + }); |
| 54 | + |
| 55 | + builder.Services.AddOpenTelemetry() |
| 56 | + .WithMetrics(metrics => |
| 57 | + { |
| 58 | + metrics.AddAspNetCoreInstrumentation() |
| 59 | + .AddHttpClientInstrumentation() |
| 60 | + .AddRuntimeInstrumentation() |
| 61 | + .AddMeter("Duende.IdentityServer", "Duende.IdentityServer.Expirimental", "IdentityServer"); |
| 62 | + }) |
| 63 | + .WithTracing(tracing => |
| 64 | + { |
| 65 | + tracing.AddSource(builder.Environment.ApplicationName) |
| 66 | + .AddAspNetCoreInstrumentation(tracing => |
| 67 | + // Exclude health check requests from tracing |
| 68 | + tracing.Filter = context => |
| 69 | + !context.Request.Path.StartsWithSegments(HealthEndpointPath) |
| 70 | + && !context.Request.Path.StartsWithSegments(AlivenessEndpointPath) |
| 71 | + ) |
| 72 | + // Uncomment the following line to enable gRPC instrumentation (requires the OpenTelemetry.Instrumentation.GrpcNetClient package) |
| 73 | + //.AddGrpcClientInstrumentation() |
| 74 | + .AddHttpClientInstrumentation() |
| 75 | + .AddSource("Duende.IdentityServer"); |
| 76 | + }); |
| 77 | + |
| 78 | + builder.AddOpenTelemetryExporters(); |
| 79 | + |
| 80 | + return builder; |
| 81 | + } |
| 82 | + |
| 83 | + private static TBuilder AddOpenTelemetryExporters<TBuilder>(this TBuilder builder) where TBuilder : IHostApplicationBuilder |
| 84 | + { |
| 85 | + var useOtlpExporter = !string.IsNullOrWhiteSpace(builder.Configuration["OTEL_EXPORTER_OTLP_ENDPOINT"]); |
| 86 | + |
| 87 | + if (useOtlpExporter) |
| 88 | + { |
| 89 | + builder.Services.AddOpenTelemetry().UseOtlpExporter(); |
| 90 | + } |
| 91 | + |
| 92 | + // Uncomment the following lines to enable the Azure Monitor exporter (requires the Azure.Monitor.OpenTelemetry.AspNetCore package) |
| 93 | + //if (!string.IsNullOrEmpty(builder.Configuration["APPLICATIONINSIGHTS_CONNECTION_STRING"])) |
| 94 | + //{ |
| 95 | + // builder.Services.AddOpenTelemetry() |
| 96 | + // .UseAzureMonitor(); |
| 97 | + //} |
| 98 | + |
| 99 | + return builder; |
| 100 | + } |
| 101 | + |
| 102 | + public static TBuilder AddDefaultHealthChecks<TBuilder>(this TBuilder builder) where TBuilder : IHostApplicationBuilder |
| 103 | + { |
| 104 | + builder.Services.AddHealthChecks() |
| 105 | + // Add a default liveness check to ensure app is responsive |
| 106 | + .AddCheck("self", () => HealthCheckResult.Healthy(), ["live"]); |
| 107 | + |
| 108 | + return builder; |
| 109 | + } |
| 110 | + |
| 111 | + public static WebApplication MapDefaultEndpoints(this WebApplication app) |
| 112 | + { |
| 113 | + // Adding health checks endpoints to applications in non-development environments has security implications. |
| 114 | + // See https://aka.ms/dotnet/aspire/healthchecks for details before enabling these endpoints in non-development environments. |
| 115 | + if (app.Environment.IsDevelopment()) |
| 116 | + { |
| 117 | + // All health checks must pass for app to be considered ready to accept traffic after starting |
| 118 | + app.MapHealthChecks(HealthEndpointPath); |
| 119 | + |
| 120 | + // Only health checks tagged with the "live" tag must pass for app to be considered alive |
| 121 | + app.MapHealthChecks(AlivenessEndpointPath, new HealthCheckOptions |
| 122 | + { |
| 123 | + Predicate = r => r.Tags.Contains("live") |
| 124 | + }); |
| 125 | + } |
| 126 | + |
| 127 | + return app; |
| 128 | + } |
| 129 | +} |
0 commit comments