aspire-service-defaults

Aspire Service Defaults

Wann dieses Skill verwenden

Verwende dieses Skill, wenn:

• Du Aspire-basierte verteilte Anwendungen entwickelst
• Du konsistente Observability (Logging, Tracing, Metriken) über mehrere Dienste hinweg benötigst
• Du eine gemeinsame Health-Check-Konfiguration haben möchtest
• Du HttpClient-Resilienz und Service Discovery konfigurieren möchtest

---

Was sind ServiceDefaults?

ServiceDefaults ist ein gemeinsames Projekt, das die Basiskonfiguration für alle Dienste einer Aspire-Anwendung bereitstellt:

• OpenTelemetry - Logging, Tracing und Metriken
• Health Checks - Readiness- und Liveness-Endpunkte
• Service Discovery - Automatische Service-Auflösung
• HTTP-Resilienz - Retry- und Circuit-Breaker-Richtlinien

Jeder Dienst referenziert dieses Projekt und ruft AddServiceDefaults() auf.

---

Projektstruktur

src/
  MyApp.ServiceDefaults/
    Extensions.cs
    MyApp.ServiceDefaults.csproj
  MyApp.Api/
    Program.cs  # Ruft AddServiceDefaults() auf
  MyApp.Worker/
    Program.cs  # Ruft AddServiceDefaults() auf
  MyApp.AppHost/
    Program.cs

---

ServiceDefaults-Projekt

Projektdatei

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <TargetFramework>net9.0</TargetFramework>
    <IsAspireSharedProject>true</IsAspireSharedProject>
  </PropertyGroup>

  <ItemGroup>
    <FrameworkReference Include="Microsoft.AspNetCore.App" />
    <PackageReference Include="Microsoft.Extensions.Http.Resilience" />
    <PackageReference Include="Microsoft.Extensions.ServiceDiscovery" />
    <PackageReference Include="OpenTelemetry.Exporter.OpenTelemetryProtocol" />
    <PackageReference Include="OpenTelemetry.Extensions.Hosting" />
    <PackageReference Include="OpenTelemetry.Instrumentation.AspNetCore" />
    <PackageReference Include="OpenTelemetry.Instrumentation.Http" />
    <PackageReference Include="OpenTelemetry.Instrumentation.Runtime" />
  </ItemGroup>
</Project>

Extensions.cs

using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Diagnostics.HealthChecks;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Diagnostics.HealthChecks;
using Microsoft.Extensions.Logging;
using OpenTelemetry;
using OpenTelemetry.Metrics;
using OpenTelemetry.Trace;

namespace Microsoft.Extensions.Hosting;

public static class Extensions
{
    private const string HealthEndpointPath = "/health";
    private const string AlivenessEndpointPath = "/alive";

    /// <summary>
    /// Fügt gemeinsame Aspire-Dienste hinzu: OpenTelemetry, Health Checks,
    /// Service Discovery und HTTP-Resilienz.
    /// </summary>
    public static TBuilder AddServiceDefaults<TBuilder>(this TBuilder builder)
        where TBuilder : IHostApplicationBuilder
    {
        builder.ConfigureOpenTelemetry();
        builder.AddDefaultHealthChecks();

        builder.Services.AddServiceDiscovery();

        builder.Services.ConfigureHttpClientDefaults(http =>
        {
            // Resilienz: Wiederholungen, Circuit Breaker, Timeouts
            http.AddStandardResilienceHandler();

            // Service Discovery: Dienstnamen in Adressen auflösen
            http.AddServiceDiscovery();
        });

        return builder;
    }

    public static TBuilder ConfigureOpenTelemetry<TBuilder>(this TBuilder builder)
        where TBuilder : IHostApplicationBuilder
    {
        // Logging
        builder.Logging.AddOpenTelemetry(logging =>
        {
            logging.IncludeFormattedMessage = true;
            logging.IncludeScopes = true;
        });

        builder.Services.AddOpenTelemetry()
            // Metriken
            .WithMetrics(metrics =>
            {
                metrics
                    .AddAspNetCoreInstrumentation()
                    .AddHttpClientInstrumentation()
                    .AddRuntimeInstrumentation();
            })
            // Tracing
            .WithTracing(tracing =>
            {
                tracing
                    .AddSource(builder.Environment.ApplicationName)
                    .AddAspNetCoreInstrumentation(options =>
                        // Health Checks von Traces ausschließen
                        options.Filter = context =>
                            !context.Request.Path.StartsWithSegments(HealthEndpointPath) &&
                            !context.Request.Path.StartsWithSegments(AlivenessEndpointPath))
                    .AddHttpClientInstrumentation();
            });

        builder.AddOpenTelemetryExporters();

        return builder;
    }

    private static TBuilder AddOpenTelemetryExporters<TBuilder>(this TBuilder builder)
        where TBuilder : IHostApplicationBuilder
    {
        // OTLP-Exporter verwenden, wenn Endpunkt konfiguriert ist (Aspire Dashboard, Jaeger, etc.)
        var useOtlp = !string.IsNullOrWhiteSpace(
            builder.Configuration["OTEL_EXPORTER_OTLP_ENDPOINT"]);

        if (useOtlp)
        {
            builder.Services.AddOpenTelemetry().UseOtlpExporter();
        }

        return builder;
    }

    public static TBuilder AddDefaultHealthChecks<TBuilder>(this TBuilder builder)
        where TBuilder : IHostApplicationBuilder
    {
        builder.Services.AddHealthChecks()
            .AddCheck("self", () => HealthCheckResult.Healthy(), ["live"]);

        return builder;
    }

    /// <summary>
    /// Mappt Health Check Endpunkte. Nach UseRouting() aufrufen.
    /// </summary>
    public static WebApplication MapDefaultEndpoints(this WebApplication app)
    {
        // Nur in Entwicklungsumgebung verfügbar – siehe Sicherheitshinweis unten
        if (app.Environment.IsDevelopment())
        {
            // Readiness: Alle Health Checks müssen bestehen
            app.MapHealthChecks(HealthEndpointPath);

            // Liveness: Nur "live"-getaggte Prüfungen
            app.MapHealthChecks(AlivenessEndpointPath, new HealthCheckOptions
            {
                Predicate = r => r.Tags.Contains("live")
            });
        }

        return app;
    }
}

---

Verwendung in Diensten

API-Dienst

var builder = WebApplication.CreateBuilder(args);

// Alle Service Defaults hinzufügen
builder.AddServiceDefaults();

// Eigene Dienste hinzufügen
builder.Services.AddControllers();

var app = builder.Build();

// Health-Endpunkte mappen
app.MapDefaultEndpoints();

app.MapControllers();
app.Run();

Worker-Dienst

var builder = Host.CreateApplicationBuilder(args);

// Funktioniert auch für Nicht-Web-Hosts
builder.AddServiceDefaults();

builder.Services.AddHostedService<MyWorker>();

var host = builder.Build();
host.Run();

---

Eigene Health Checks hinzufügen

public static TBuilder AddDefaultHealthChecks<TBuilder>(this TBuilder builder)
    where TBuilder : IHostApplicationBuilder
{
    builder.Services.AddHealthChecks()
        // Grundlegende Liveness
        .AddCheck("self", () => HealthCheckResult.Healthy(), ["live"])

        // Datenbank-Readiness
        .AddNpgSql(
            builder.Configuration.GetConnectionString("postgres")!,
            name: "postgres",
            tags: ["ready"])

        // Redis-Readiness
        .AddRedis(
            builder.Configuration.GetConnectionString("redis")!,
            name: "redis",
            tags: ["ready"])

        // Eigener Check
        .AddCheck<MyCustomHealthCheck>("custom", tags: ["ready"]);

    return builder;
}

---

Eigene Trace-Quellen hinzufügen

Für Akka.NET oder benutzerdefinierte ActivitySources:

public static TBuilder ConfigureOpenTelemetry<TBuilder>(this TBuilder builder)
    where TBuilder : IHostApplicationBuilder
{
    builder.Services.AddOpenTelemetry()
        .WithTracing(tracing =>
        {
            tracing
                .AddSource(builder.Environment.ApplicationName)
                // Akka.NET Tracing
                .AddSource("Akka.NET")
                // Eigene Quellen
                .AddSource("MyApp.Orders")
                .AddSource("MyApp.Payments")
                .AddAspNetCoreInstrumentation()
                .AddHttpClientInstrumentation();
        });

    return builder;
}

---

Health Checks in der Produktion

Schütze Health-Endpunkte in der Produktion oder verwende andere Pfade:

public static WebApplication MapDefaultEndpoints(this WebApplication app)
{
    // Immer für Kubernetes-Probes mappen, aber beachte:
    // - Verwendung interner Ports
    // - Hinzufügen einer Autorisierung
    // - Ratenbegrenzung

    app.MapHealthChecks("/health", new HealthCheckOptions
    {
        // Nur Status zurückgeben, keine Details
        ResponseWriter = (context, report) =>
        {
            context.Response.ContentType = "text/plain";
            return context.Response.WriteAsync(report.Status.ToString());
        }
    });

    app.MapHealthChecks("/alive", new HealthCheckOptions
    {
        Predicate = r => r.Tags.Contains("live"),
        ResponseWriter = (context, report) =>
        {
            context.Response.ContentType = "text/plain";
            return context.Response.WriteAsync(report.Status.ToString());
        }
    });

    return app;
}

---

Integration mit AppHost

Der AppHost konfiguriert automatisch OTLP-Endpunkte:

// AppHost/Program.cs
var builder = DistributedApplication.CreateBuilder(args);

var postgres = builder.AddPostgres("postgres");
var redis = builder.AddRedis("redis");

var api = builder.AddProject<Projects.MyApp_Api>("api")
    .WithReference(postgres)
    .WithReference(redis);

builder.Build().Run();

Dienste erhalten automatisch OTEL_EXPORTER_OTLP_ENDPOINT und senden Telemetriedaten an das Aspire Dashboard.

---

Best Practices

Praxis	Grund
Ein ServiceDefaults-Projekt	Konsistente Konfiguration über alle Dienste hinweg
Health Checks von Traces filtern	Reduziert Rauschen in Observability-Daten
Health Checks taggen	Liveness von Readiness trennen
StandardResilienceHandler verwenden	Integrierte Wiederholungen, Circuit Breaker, Timeouts
Eigene Trace-Quellen hinzufügen	Domain-spezifische Spans erfassen

---

Ressourcen

• Aspire Service Defaults: https://learn.microsoft.com/en-us/dotnet/aspire/fundamentals/service-defaults
• OpenTelemetry .NET: https://opentelemetry.io/docs/languages/net/
• Health Checks: https://learn.microsoft.com/en-us/aspnet/core/host-and-deploy/health-checks