ASP.NET Core'da sistem durumu denetimleri

Tarafından Glenn Condron ve Juergen Gutsch

ASP.NET Core, uygulama altyapısı bileşenlerinin sistem durumunu raporlamak için Sistem Durumu Denetimleri Ara Yazılımı ve kitaplıklar sunar.

Uygulama tarafından sağlık kontrolleri HTTP uç noktaları olarak sağlanır. Sistem durumu denetimi uç noktaları çeşitli gerçek zamanlı izleme senaryoları için yapılandırılabilir:

• Sistem durumu yoklamaları, bir uygulamanın durumunu denetlemek için kapsayıcı düzenleme sistemleri ve yük dengeleyiciler tarafından kullanılabilir. Örneğin, bir kapsayıcı düzenleyicisi, başarısız olan bir sağlık kontrolüne yanıt olarak aşamalı dağıtımı durdurabilir veya bir kapsayıcıyı yeniden başlatabilir. Yük dengeleyici, trafiği hatalı örnekten iyi durumdaki bir örneğe yönlendirerek iyi durumda olmayan bir uygulamaya tepki verebilir.
• İyi durumda bellek, disk ve diğer fiziksel sunucu kaynaklarının kullanımı izlenebilir.
• Sistem durumu denetimleri, kullanılabilirliği ve normal çalışma durumunu onaylamak için bir uygulamanın veritabanları ve dış hizmet uç noktaları gibi bağımlılıklarını test edebilir.

Sağlık kontrolleri, genellikle bir uygulamanın durumunu kontrol etmek için dış bir izleme hizmeti veya kapsayıcı düzenleyici ile birlikte kullanılır. Bir uygulamaya sistem durumu denetimleri eklemeden önce hangi izleme sisteminin kullanılacağına karar verin. İzleme sistemi, hangi tür sağlık kontrollerinin oluşturulacağını ve endpoint'lerin nasıl yapılandırılacağını belirler.

Temel sağlık denetimi

Birçok uygulama için, uygulamanın istekleri işlemek için kullanılabilirliğini (çalışırlık durumu) bildiren temel bir sağlık araştırması yapılandırması, uygulamanın durumunu keşfetmek için yeterlidir.

Temel yapılandırma, sağlık denetimi hizmetlerini kaydeder ve bir URL uç noktasında sağlık yanıtı ile yanıt vermek için Sağlık Denetimleri Ara yazılımını çağırır. Varsayılan olarak, belirli bir bağımlılığı veya alt sistemi test etmek için özgül bir sağlık kontrolü kayıtlı değildir. Uygulama, sistem durumu uç noktası URL'sinde yanıt verebiliyorsa iyi durumda kabul edilir. Varsayılan yanıt yazarı istemciye düz metin yanıtı olarak yazar HealthStatus . HealthStatus, HealthStatus.Healthy, HealthStatus.Degraded veya HealthStatus.Unhealthy.

Sağlık denetimi hizmetlerini AddHealthChecks içinde Program.cs kaydedin. MapHealthChecks çağrısı yaparak bir sağlık kontrolü uç noktası oluşturun.

Aşağıdaki örnek /healthz konumunda bir sağlık denetimi uç noktası oluşturur:

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddHealthChecks();

var app = builder.Build();

app.MapHealthChecks("/healthz");

app.Run();

DockerHEALTHCHECK

Docker , temel sistem durumu denetimi yapılandırmasını kullanan bir uygulamanın durumunu denetlemek için kullanabileceğiniz yerleşik HEALTHCHECK bir yönerge içerir:

HEALTHCHECK CMD curl --fail http://localhost:5000/healthz || exit 1

Yukarıdaki örnek, curl ile /healthz konumundaki sistem durumu denetimi uç noktasına HTTP isteğinde bulunmak için kullanır. curl .NET Linux kapsayıcı görüntülerine dahil değildir, ancak gerekli paketi Dockerfile dosyasına yükleyerek ekleyebilirsiniz. Alpine Linux tabanlı görüntüleri kullanan kapsayıcılar, wget öğesi yerine curl öğesini kullanabilir.

Sağlık denetimleri oluşturma

Arayüzü uygulayarak IHealthCheck sağlık kontrolleri oluşturun. CheckHealthAsync yöntemi, sağlığı HealthCheckResult, Healthy veya Degraded olarak gösteren bir Unhealthy döndürür. Sonuç, yapılandırılabilir durum koduyla düz metin yanıtı olarak yazılır. Sistem durumu denetimi seçenekleri bölümüne bakın. HealthCheckResult isteğe bağlı anahtar-değer çiftleri de döndürebilir.

Aşağıdaki örnekte sağlık kontrolünün yerleşimi gösterilmektedir.

public class SampleHealthCheck : IHealthCheck
{
    public Task<HealthCheckResult> CheckHealthAsync(
        HealthCheckContext context, CancellationToken cancellationToken = default)
    {
        var isHealthy = true;

        // ...

        if (isHealthy)
        {
            return Task.FromResult(
                HealthCheckResult.Healthy("A healthy result."));
        }

        return Task.FromResult(
            new HealthCheckResult(
                context.Registration.FailureStatus, "An unhealthy result."));
    }
}

Sağlık kontrolünün mantığı CheckHealthAsync yöntemine yerleştirilir. Yukarıdaki örnek, isHealthytrueolarak bir kukla değişkeni ayarlar. Eğer isHealthy değeri false olarak ayarlanırsa, HealthCheckRegistration.FailureStatus durumu döndürülür.

Eğer CheckHealthAsync denetim sırasında bir özel durum fırlatırsa, HealthReportEntry değerine ayarlanmış HealthReportEntry.Status ile yeni bir FailureStatus döndürülür. Bu durum AddCheck tarafından tanımlanır (sistem durumu denetim hizmetlerini kaydetme bölümüne bakın) ve denetim hatasına neden olan iç özel durumu içerir. Description, özel durumun iletisi olarak ayarlanır.

Sağlık denetimi hizmetlerini kaydetme

Sağlık kontrolü hizmetini kaydetmek için AddCheck numarasını Program.cs arayın.

builder.Services.AddHealthChecks()
    .AddCheck<SampleHealthCheck>("Sample");

AddCheck Aşağıdaki örnekte gösterilen aşırı yükleme, sistem durumu denetimi hata bildirdiğinde hata durumunu (HealthStatus) bildirecek şekilde ayarlar. Hata durumu (varsayılan) null olarak ayarlanırsa HealthStatus.Unhealthy raporlanır. Bu aşırı yükleme, kitaplık yazarları için yararlı bir senaryodur; sağlık denetimi uygulaması ayarı kabul ederse, sağlık denetimi hatası durumunda kitaplık tarafından belirtilen hata durumunun uygulama tarafından zorunlu kılındığı bir durumdur.

Etiketler , sistem durumu denetimlerini filtrelemek için kullanılabilir. Etiketler, Sistem durumu denetimlerini filtrele bölümünde açıklanmıştır.

builder.Services.AddHealthChecks()
    .AddCheck<SampleHealthCheck>(
        "Sample",
        failureStatus: HealthStatus.Degraded,
        tags: new[] { "sample" });

AddCheck bir lambda işlevini de yürütebilir. Aşağıdaki örnekte, sağlık kontrolü her zaman sağlıklı bir sonuç döndürür.

builder.Services.AddHealthChecks()
    .AddCheck("Sample", () => HealthCheckResult.Healthy("A healthy result."));

Argümanları bir sağlık kontrolü uygulamasına geçirmek için AddTypeActivatedCheck çağırın. Aşağıdaki örnekte, türe dayalı sağlık kontrolü, oluşturucusunda bir tamsayı ve bir dize kabul eder.

public class SampleHealthCheckWithArgs : IHealthCheck
{
    private readonly int _arg1;
    private readonly string _arg2;

    public SampleHealthCheckWithArgs(int arg1, string arg2)
        => (_arg1, _arg2) = (arg1, arg2);

    public Task<HealthCheckResult> CheckHealthAsync(
        HealthCheckContext context, CancellationToken cancellationToken = default)
    {
        // ...

        return Task.FromResult(HealthCheckResult.Healthy("A healthy result."));
    }
}

Önceki sağlık kontrolünü kaydetmek için, bağımsız değişken olarak geçen tamsayı ve dize ile AddTypeActivatedCheck çağrısı yapın.

builder.Services.AddHealthChecks()
    .AddTypeActivatedCheck<SampleHealthCheckWithArgs>(
        "Sample",
        failureStatus: HealthStatus.Degraded,
        tags: new[] { "sample" },
        args: new object[] { 1, "Arg" });

Sağlık Kontrolleri Yönlendirmesini Kullanma

Program.cs içinde, uç nokta URL'si veya göreli yolu ile uç nokta oluşturucusunda MapHealthChecks çağırın.

app.MapHealthChecks("/healthz");

Konağı gerektir

Sistem durumu denetimi uç noktası için bir veya daha fazla izin verilen konak belirtmek için çağrısı RequireHost yapın. Konaklar için punycode yerine Unicode kullanın ve port ekleyebilirsiniz. Bir koleksiyon sağlamazsanız, herhangi bir sunucu kabul edilir.

app.MapHealthChecks("/healthz")
    .RequireHost("www.contoso.com:5001");

Sistem durumu denetimi uç noktasının yanıt vermesini yalnızca belirli bir bağlantı noktasında sınırlamak için RequireHost çağrısında bir bağlantı noktası belirtin. Genellikle, izleme hizmetleri için bir bağlantı noktasını kullanıma açmak için kapsayıcı ortamında bu yaklaşımı kullanın:

app.MapHealthChecks("/healthz")
    .RequireHost("*:5001");

Warning

Konak üst bilgisine dayanan API'ler, örneğin ve HttpRequest.Host, istemciler tarafından olası kimlik sahtekarlığına maruz kalabilir.

Host ve bağlantı noktası kimlik sahtekarlığını önlemek için aşağıdaki yaklaşımlardan birini kullanın:

• Bağlantı HttpContext.Connection (ports) denetlendiği yerde ConnectionInfo.LocalPort kullanın.
• Konak filtresini kullanın.

Yetkisiz istemcilerin bağlantı noktası sahtekarlığına uğramasını önlemek için öğesini çağırın RequireAuthorization:

app.MapHealthChecks("/healthz")
    .RequireHost("*:5001")
    .RequireAuthorization();

Daha fazla bilgi için RequireHost ile yollarda konak eşleştirme bölümüne bakın.

Yetkilendirme gerektir

RequireAuthorization öğesini durum denetimi istek uç noktasında Yetkilendirme Ara Yazılımını çalıştırmak için çağırın. Aşırı RequireAuthorization yükleme bir veya daha fazla yetkilendirme ilkesi kabul eder. İlke sağlanmazsa, varsayılan yetkilendirme ilkesi kullanılır:

app.MapHealthChecks("/healthz")
    .RequireAuthorization();

Kaynaklar Arası İstekleri (CORS) etkinleştirme

Sistem durumu denetimlerini tarayıcıda el ile çalıştırmak yaygın bir senaryo olmasa da, CORS Ara Yazılımı sistem durumu denetimleri uç noktalarına çağrılarak RequireCors etkinleştirilebilir. Aşırı RequireCors yükleme bir CORS ilke oluşturucusu temsilcisini (CorsPolicyBuilder) veya bir ilke adını kabul eder. Daha fazla bilgi için ASP.NET Core'da Kaynaklar Arası İstekler (CORS) Etkinleştirme başlıklı sayfaya bakın.

Sağlık kontrolü seçenekleri

HealthCheckOptions sistem durumu denetimi davranışını özelleştirme fırsatı sağlar:

• Sağlık kontrollerini filtrele
• HTTP durum kodunu özelleştirme
• Önbellek üst bilgilerini gizleme
• Çıktıyı özelleştirme

Sağlık kontrollerini filtrele

Varsayılan olarak, Sistem Durumu Denetimleri Ara Yazılımı tüm kayıtlı sistem durumu denetimlerini çalıştırır. Sistem durumu denetimlerinin bir alt kümesini çalıştırmak için seçeneğine Predicate boole döndüren bir işlev sağlayın.

Aşağıdaki örnek, yalnızca sample etiketiyle işaretlenmiş sağlık kontrollerinin çalıştırılmasını sağlamak için bir filtre uygular.

app.MapHealthChecks("/healthz", new HealthCheckOptions
{
    Predicate = healthCheck => healthCheck.Tags.Contains("sample")
});

HTTP durum kodunu özelleştirme

HTTP durum kodlarına sağlık durumunun eşlemeyi özelleştirmek için ResultStatusCodes kullanın. Aşağıdaki StatusCodes atamalar ara yazılım tarafından kullanılan varsayılan değerlerdir. Durum kodu değerlerini gereksinimlerinizi karşılayacak şekilde değiştirin:

app.MapHealthChecks("/healthz", new HealthCheckOptions
{
    ResultStatusCodes =
    {
        [HealthStatus.Healthy] = StatusCodes.Status200OK,
        [HealthStatus.Degraded] = StatusCodes.Status200OK,
        [HealthStatus.Unhealthy] = StatusCodes.Status503ServiceUnavailable
    }
});

Önbellek üst bilgilerini gizleme

AllowCachingResponses Durum Denetimleri Ara Yazılımının yanıt önbelleğe almayı önlemek için yoklama yanıtına HTTP üst bilgileri ekleyip eklemediğini denetler. Değer false (varsayılan) ise, ara yazılım, Cache-Control, Expires ve Pragma üst bilgilerini ayarlar veya geçersiz kılarak yanıt önbelleğe almayı önler. değeri ise trueara yazılım yanıtın önbellek üst bilgilerini değiştirmez:

app.MapHealthChecks("/healthz", new HealthCheckOptions
{
    AllowCachingResponses = true
});

Çıktıyı özelleştirme

Sistem durumu denetimleri raporunun çıktısını özelleştirmek için, yanıtı yazacak bir temsilci olarak HealthCheckOptions.ResponseWriter özelliğini ayarlayın.

app.MapHealthChecks("/healthz", new HealthCheckOptions
{
    ResponseWriter = WriteResponse
});

Varsayılan temsilci, dize değeriyle en düşük düz metin yanıtını HealthReport.Statusyazar. Aşağıdaki özel temsilci, System.Text.Json kullanarak özel bir JSON yanıtı çıktısı verir:

private static Task WriteResponse(HttpContext context, HealthReport healthReport)
{
    context.Response.ContentType = "application/json; charset=utf-8";

    var options = new JsonWriterOptions { Indented = true };

    using var memoryStream = new MemoryStream();
    using (var jsonWriter = new Utf8JsonWriter(memoryStream, options))
    {
        jsonWriter.WriteStartObject();
        jsonWriter.WriteString("status", healthReport.Status.ToString());
        jsonWriter.WriteStartObject("results");

        foreach (var healthReportEntry in healthReport.Entries)
        {
            jsonWriter.WriteStartObject(healthReportEntry.Key);
            jsonWriter.WriteString("status",
                healthReportEntry.Value.Status.ToString());
            jsonWriter.WriteString("description",
                healthReportEntry.Value.Description);
            jsonWriter.WriteStartObject("data");

            foreach (var item in healthReportEntry.Value.Data)
            {
                jsonWriter.WritePropertyName(item.Key);

                JsonSerializer.Serialize(jsonWriter, item.Value,
                    item.Value?.GetType() ?? typeof(object));
            }

            jsonWriter.WriteEndObject();
            jsonWriter.WriteEndObject();
        }

        jsonWriter.WriteEndObject();
        jsonWriter.WriteEndObject();
    }

    return context.Response.WriteAsync(
        Encoding.UTF8.GetString(memoryStream.ToArray()));
}

Sistem durumu denetimleri API'si, karmaşık JSON dönüş biçimleri için yerleşik destek sağlamaz çünkü biçim, seçtiğiniz izleme sistemine özgüdür. Yukarıdaki örneklerde verilen yanıtı gerektiği gibi özelleştirin. JSON serileştirme hakkında daha fazla bilgi için, System.Text.Json konusuna bakın.

Veritabanı yoklaması

Sistem durumu denetimi, veritabanının normal yanıt verdiğini belirtmek için boole testi olarak çalıştırılacak bir veritabanı sorgusu belirtebilir.

AspNetCore.Diagnostics.HealthChecks, ASP.NET Core uygulamaları için bir sistem durumu denetimi kitaplığı, SQL Server veritabanında çalışan bir sistem durumu denetimi içerir. AspNetCore.Diagnostics.HealthChecks veritabanı bağlantısının iyi durumda olduğunu onaylamak için veritabanına karşı bir SELECT 1 sorgu yürütür.

Warning

Sorgu kullanarak veritabanı bağlantısını denetlerken, hızlı bir şekilde döndüren bir sorgu seçin. Sorgu yaklaşımı veritabanını aşırı yükleme ve performansını düşürme riskini çalıştırır. Çoğu durumda test sorgusu çalıştırmak gerekli değildir. Yalnızca veritabanıyla başarılı bir bağlantı oluşturmak yeterlidir. Sorgu çalıştırmayı gerekli bulursanız, gibi SELECT 1basit bir SELECT sorgusu seçin.

Bu SQL Server sistem durumu denetimini kullanmak için NuGet paketine AspNetCore.HealthChecks.SqlServer bir paket başvurusu ekleyin. Aşağıdaki örnek SQL Server sistem durumu denetimini kaydeder:

var conStr = builder.Configuration.GetConnectionString("DefaultConnection");
if (string.IsNullOrEmpty(conStr))
{
    throw new InvalidOperationException(
                       "Could not find a connection string named 'DefaultConnection'.");
}
builder.Services.AddHealthChecks()
    .AddSqlServer(conStr);

Note

Microsoft bakımını yapmaz veya desteklemez AspNetCore.Diagnostics.HealthChecks.

Entity Framework Core DbContext araştırması

Denetim, uygulamanın DbContextEF Core için yapılandırılan veritabanıyla iletişim kurabildiğini DbContext onaylar. Denetimi destekleyen DbContext uygulamalar:

• Entity Framework (EF) Core kullanın.
• Bir Microsoft.Extensions.Diagnostics.HealthChecks.EntityFrameworkCore NuGet paketi referansı ekleyin.

için bir sağlık kontrolü kaydeder. DbContext yönteme TContext olarak sağlanır. Hata durumunu, etiketleri ve özel test sorgusunu yapılandırmak için bir overload işlevi kullanılabilir.

Varsayılan olarak:

• DbContextHealthCheck, EF Core'nin CanConnectAsync yöntemini çağırır. Yöntem aşırı yüklemelerini kullanarak AddDbContextCheck sistem durumu denetlenirken çalıştırılacak işlemi özelleştirebilirsiniz.
• Sağlık durumu kontrolünün adı, TContext türünün adıdır.

Aşağıdaki örnek bir DbContext ve ilişkili bir DbContextHealthCheck kaydeder:

builder.Services.AddDbContext<SampleDbContext>(options =>
    options.UseSqlServer(
        builder.Configuration.GetConnectionString("DefaultConnection")));

builder.Services.AddHealthChecks()
    .AddDbContextCheck<SampleDbContext>();

Ayrı hazırlık ve canlılık yoklamaları

Bazı barındırma senaryolarında iki uygulama durumunu ayırt etmek için bir çift sistem durumu denetimi kullanın:

• Hazır olma, uygulamanın normal çalışıp çalışmadığını ancak istekleri almaya hazır olmadığını gösterir.
• Çalışırlık durumu, bir uygulamanın kapatılıp kapatılmadığını ve yeniden başlatılması gerekip gerekmediğini belirtir.

Aşağıdaki örneği göz önünde bulundurun: Bir uygulamanın istekleri işlemeye hazır olması için büyük bir yapılandırma dosyasını indirmesi gerekir. İlk indirme başarısız olursa uygulamayı yeniden başlatmak istemezsiniz çünkü uygulama dosyayı birkaç kez indirmeyi yeniden deneyebilir. Sürecin canlılığını tanımlamak için bir canlılık doğrulayıcısı kullanın, başka hiçbir denetim çalıştırılmaz. Yapılandırma dosyası indirme işlemi başarılı olmadan önce isteklerin uygulamaya gönderilmesini de engellemek istiyorsunuz. İndirme başarılı olana ve uygulama istekleri almaya hazır olana kadar "hazır değil" durumunu belirtmek için hazırlık sondası kullanın.

Aşağıdaki arka plan görevi, yaklaşık 15 saniye süren bir başlangıç işleminin benzetimini yapar. İşlem tamamlandıktan sonra StartupHealthCheck.StartupCompleted görev özelliğini true olarak ayarlar:

public class StartupBackgroundService : BackgroundService
{
    private readonly StartupHealthCheck _healthCheck;

    public StartupBackgroundService(StartupHealthCheck healthCheck)
        => _healthCheck = healthCheck;

    protected override async Task ExecuteAsync(CancellationToken stoppingToken)
    {
        // Simulate the effect of a long-running task.
        await Task.Delay(TimeSpan.FromSeconds(15), stoppingToken);

        _healthCheck.StartupCompleted = true;
    }
}

StartupHealthCheck uzun süre çalışan başlangıç görevinin tamamlandığını bildirir ve arka plan hizmetinin ayarladığı StartupCompleted özelliğini kullanıma sunar:

public class StartupHealthCheck : IHealthCheck
{
    private volatile bool _isReady;

    public bool StartupCompleted
    {
        get => _isReady;
        set => _isReady = value;
    }

    public Task<HealthCheckResult> CheckHealthAsync(
        HealthCheckContext context, CancellationToken cancellationToken = default)
    {
        if (StartupCompleted)
        {
            return Task.FromResult(HealthCheckResult.Healthy("The startup task has completed."));
        }

        return Task.FromResult(HealthCheckResult.Unhealthy("That startup task is still running."));
    }
}

Barındırılan hizmetle AddCheck birlikte sistem durumu denetimini de Program.cs kaydedin. Barındırılan hizmet sistem durumu denetiminde özelliğini ayarladığı için, sistem durumu denetimini hizmet kapsayıcısında tekil olarak da kaydedin:

builder.Services.AddHostedService<StartupBackgroundService>();
builder.Services.AddSingleton<StartupHealthCheck>();

builder.Services.AddHealthChecks()
    .AddCheck<StartupHealthCheck>(
        "Startup",
        tags: new[] { "ready" });

İki farklı sağlık kontrolü uç noktası oluşturmak için, çağrısını iki kez yapın.

app.MapHealthChecks("/healthz/ready", new HealthCheckOptions
{
    Predicate = healthCheck => healthCheck.Tags.Contains("ready")
});

app.MapHealthChecks("/healthz/live", new HealthCheckOptions
{
    Predicate = _ => false
});

Yukarıdaki örnek aşağıdaki sistem durumu denetimi uç noktalarını oluşturur:

• /healthz/ready hazır olma denetimi için. Hazır olma denetimi, ready ile etiketlenen sistem durumu kontrollerini filtreler.
• /healthz/live canlılık kontrolü için. Canlılık denetimi, tüm sistem durumu denetimlerini false'u HealthCheckOptions.Predicate delegesinde döndürerek filtreler. Sistem durumu denetimlerini filtreleme hakkında daha fazla bilgi için bu makaledeki Sistem durumu denetimlerini filtreleme bölümüne bakın.

Başlangıç görevi tamamlanmadan önce uç /healthz/ready nokta bir Unhealthy durum bildirir. Başlangıç görevi tamamlandıktan sonra bu uç nokta bir Healthy durum bildirir. Uç /healthz/live tüm kontrolleri devre dışı bırakır ve tüm istekler için bir Healthy durumu raporlar.

Kubernetes örneği

Ayrı hazır olma ve canlılık denetimleri kullanmak Kubernetes gibi bir ortamda kullanışlıdır. Kubernetes'te bir uygulamanın, temel alınan veritabanı kullanılabilirliği testi gibi istekleri kabul etmeden önce zaman alan başlangıç çalışmalarını çalıştırması gerekebilir. Düzenleyici, ayrı denetimler kullanarak uygulamanın çalışıp çalışmadığını ancak henüz hazır olmadığını veya uygulamanın başlatılıp başlatılmadığını anlayabilir. Kubernetes'teki hazır olma ve canlılık yoklamaları hakkında daha fazla bilgi için Kubernetes belgelerindeki Canlılık ve Hazırlık Yoklamalarını Yapılandırma bölümüne bakın.

Aşağıdaki örnekte Kubernetes hazır olma yoklaması yapılandırması gösterilmektedir:

spec:
  template:
  spec:
    readinessProbe:
      # an http probe
      httpGet:
        path: /healthz/ready
        port: 80
      # length of time to wait for a pod to initialize
      # after pod startup, before applying health checking
      initialDelaySeconds: 30
      timeoutSeconds: 1
    ports:
      - containerPort: 80

Sağlık denetimi kitaplığı dağıtma

Bir sağlık kontrolünü (health check) kitaplık olarak dağıtmak için:

1. IHealthCheck arabirimini bağımsız bir sınıf olarak uygulayan bir sağlık denetimi yazın. sınıfı, yapılandırma verilerine erişmek için bağımlılık ekleme (DI), tür etkinleştirme ve adlandırılmış seçenekleri kullanabilir.

2. Tüketici uygulamanın Program.cs yönteminde çağıracağı parametrelerle bir uzatma yöntemi yazın. Aşağıdaki örnek sağlık kontrolünü göz önünde bulundurun; bu kontrol, arg1 ve arg2 öğelerini oluşturucu parametreleri olarak kabul etmektedir.

   public SampleHealthCheckWithArgs(int arg1, string arg2)
       => (_arg1, _arg2) = (arg1, arg2);
   

   Yukarıdaki imza, sağlık kontrolünün yoklama mantığını işlemek için özel verilere ihtiyaç duyduğunu gösterir. Veriler, sağlık durumu denetiminin bir uzantı yöntemiyle kaydedildiği zaman sağlık durumu denetimi örneğini oluşturmak için kullanılan temsilciye sağlanır. Aşağıdaki örnekte, çağıran şunları belirtir:

   • arg1: Sağlık durumu denetimi için bir tamsayı veri noktası.
   • arg2: Sistem durumu denetimi için bir dize bağımsız değişkeni.
   • name: İsteğe bağlı bir sağlık kontrolü adı. ise null, varsayılan bir değer kullanılır.
   • failureStatus: Hata durumu için bildirilen isteğe bağlı bir HealthStatus. null ise HealthStatus.Unhealthykullanılır.
   • tags: İsteğe bağlı IEnumerable<string> bir etiket koleksiyonu.

   public static class SampleHealthCheckBuilderExtensions
   {
       private const string DefaultName = "Sample";
   
       public static IHealthChecksBuilder AddSampleHealthCheck(
           this IHealthChecksBuilder healthChecksBuilder,
           int arg1,
           string arg2,
           string? name = null,
           HealthStatus? failureStatus = null,
           IEnumerable<string>? tags = default)
       {
           return healthChecksBuilder.Add(
               new HealthCheckRegistration(
                   name ?? DefaultName,
                   _ => new SampleHealthCheckWithArgs(arg1, arg2),
                   failureStatus,
                   tags));
       }
   }
   

Sağlık Kontrolü Yayınlayıcısı

Hizmet kapsayıcısına bir IHealthCheckPublisher eklendiğinde, sistem durumu denetimi sistemi düzenli aralıklarla sistem durumu denetimlerinizi yürütür ve sonuçla birlikte PublishAsync çağrısı yapar. Bu işlem, her işlemin sistem durumunu belirlemek için izleme sistemini düzenli aralıklarla çağırmasını bekleyen, anında iletme tabanlı sistem durumu izleme sistemi senaryosunda kullanışlıdır.

HealthCheckPublisherOptions aşağıdakileri ayarlamanıza olanak verir:

• Delay: Uygulama başlatıldıktan sonra IHealthCheckPublisher örneklerini yürütmeden önceki başlangıç gecikmesi. Gecikme başlangıçta bir kez gerçekleşir ve sonraki yinelemeler için geçerli değildir. Varsayılan değer beş saniyedir.
• Period: IHealthCheckPublisher yürütme süresi. Varsayılan değer 30 saniyedir.
• Predicate: Predicatenull (varsayılan) ise, sistem durumu denetimi yayımcı hizmeti tüm kayıtlı sistem durumu denetimlerini çalıştırır. Sistem durumu denetimlerinin bir alt kümesini çalıştırmak için denetim kümesini filtreleyen bir işlev sağlayın. Öngörü her periyot değerlendirilir.
• Timeout: Tüm IHealthCheckPublisher örnekleri için sağlık kontrollerini yürütme zaman aşımı. Zaman aşımı olmadan yürütmek için `InfiniteTimeSpan` kullanın. Varsayılan değer 30 saniyedir.

Aşağıdaki örnek, bir sağlık yayımcısının düzenini göstermektedir:

public class SampleHealthCheckPublisher : IHealthCheckPublisher
{
    public Task PublishAsync(HealthReport report, CancellationToken cancellationToken)
    {
        if (report.Status == HealthStatus.Healthy)
        {
            // ...
        }
        else
        {
            // ...
        }

        return Task.CompletedTask;
    }
}

HealthCheckPublisherOptions sınıfı, sağlık denetimi yayımcısının davranışını yapılandırmak için özellikler sağlar.

Aşağıdaki örnek, bir sağlık kontrolü yayımcısını singleton olarak kaydeder ve yapılandırır HealthCheckPublisherOptions:

builder.Services.Configure<HealthCheckPublisherOptions>(options =>
{
    options.Delay = TimeSpan.FromSeconds(2);
    options.Predicate = healthCheck => healthCheck.Tags.Contains("sample");
});

builder.Services.AddSingleton<IHealthCheckPublisher, SampleHealthCheckPublisher>();

AspNetCore.Diagnostics.HealthChecks:

• Application Insights dahil olmak üzere çeşitli sistemler için yayımcılar içerir.
• Microsoft tarafından korunmaz veya desteklenmez.

Bireysel Sağlık Kontrolleri

Her bir 'i ayrı ayrı ayarlayabilirsiniz. ve Bazı sistem durumu denetimlerini içinde HealthCheckPublisherOptionsayarlanan dönemden farklı bir hızda çalıştırmak istediğinizde bu değerleri ayarlayın.

Aşağıdaki kod, Delay ve Period değerlerini SampleHealthCheck1 için ayarlar.

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddHealthChecks()
   .Add(new HealthCheckRegistration(
       name: "SampleHealthCheck1",
       instance: new SampleHealthCheck(),
       failureStatus: null,
       tags: null,
       timeout: default)
   {
       Delay = TimeSpan.FromSeconds(40),
       Period = TimeSpan.FromSeconds(30)
   });

var app = builder.Build();

app.MapHealthChecks("/healthz");

app.Run();

Bağımlılık Enjeksiyonu ve Sağlık Kontrolleri

Bir Sistem Durumu Denetimi sınıfı içindeki belirli Type bir örneğini kullanmak için bağımlılık ekleme özelliğini kullanmak mümkündür. Bağımlılık ekleme, sistem durumu denetimine seçenekler veya genel yapılandırma eklemek için yararlı olabilir. Bağımlılık enjeksiyonunun kullanılması, Sağlık Kontrollerini yapılandırmak için yaygın bir senaryo değildir. Genellikle, her Health Check, gerçek teste özgüdür ve uzantı yöntemleri kullanılarak IHealthChecksBuilder yapılandırılır.

Aşağıdaki örnekte, bağımlılık ekleme yoluyla bir yapılandırma nesnesi alan örnek bir Sistem Durumu Denetimi gösterilmektedir:

public class SampleHealthCheckWithDI : IHealthCheck
{
    private readonly SampleHealthCheckWithDiConfig _config;

    public SampleHealthCheckWithDI(SampleHealthCheckWithDiConfig config)
        => _config = config;

    public Task<HealthCheckResult> CheckHealthAsync(
        HealthCheckContext context, CancellationToken cancellationToken = default)
    {
        var isHealthy = true;

        // use _config ...

        if (isHealthy)
        {
            return Task.FromResult(
                HealthCheckResult.Healthy("A healthy result."));
        }

        return Task.FromResult(
            new HealthCheckResult(
                context.Registration.FailureStatus, "An unhealthy result."));
    }
}

SampleHealthCheckWithDiConfig ve Sağlık kontrolü hizmet kapsayıcısına eklenmelidir.

builder.Services.AddSingleton<SampleHealthCheckWithDiConfig>(new SampleHealthCheckWithDiConfig
{
    BaseUriToCheck = new Uri("https://sample.contoso.com/api/")
});
builder.Services.AddHealthChecks()
    .AddCheck<SampleHealthCheckWithDI>(
        "With Dependency Injection",
        tags: new[] { "inject" });

UseHealthChecks ile MapHealthChecks karşılaştırması

Sistem durumu denetimlerini arayanlar için iki şekilde erişilebilir hale getirebilirsiniz:

• UseHealthChecks ara yazılım işlem hattında sistem durumu denetimleri isteklerini işlemek için ara yazılımı kaydeder.
• MapHealthChecks sağlık denetimleri uç noktasını kaydeder. Uç nokta, uygulamadaki diğer uç noktalarla birlikte eşleştirilir ve yürütülür.

MapHealthChecks yerine UseHealthChecks kullanarak, yetkilendirme gibi uç noktaya duyarlı ara yazılımlar kullanabilir ve eşleştirme politikası üzerinde daha ayrıntılı denetim elde edebilirsiniz. UseHealthChecks yerine MapHealthChecks kullanarak, sistem durumu denetimlerinin ara yazılım işlem hattında tam olarak nerede çalıştığını kontrol edersiniz.

UseHealthChecks:

• bir istek sistem durumu denetimi uç noktasıyla eşleştiğinde işlem hattını sonlandırır. Kısa devre yapma, günlüğe kaydetme ve diğer ara yazılımlar gibi gereksiz işleri önlediği için genellikle tercih edilir.
• Öncelikle işlem hattında sistem durumu denetimi ara yazılımını yapılandırmak için kullanılır.
• Bir null veya boş PathString ile bir bağlantı noktasındaki herhangi bir yolu eşleştirebilir. Belirtilen bağlantı noktasına yapılan herhangi bir istekte sağlık denetimi gerçekleştirmeye izin verir.
• Kaynak kod

MapHealthChecks izin verir:

• ShortCircuit çağrısı yaparak, bir istek sistem durumu denetimi uç noktasıyla eşleştiğinde işlem hattını sonlandırmak. Örneğin, app.MapHealthChecks("/healthz").ShortCircuit();. Daha fazla bilgi için, Yönlendirmeden sonra ara yazılımının kısa devre edilmesi kısmına bakın.
• Sağlık kontrolleri için belirli yolları veya uç noktaları haritalama.
• Sistem durumu denetimi uç noktasının erişilebilir olduğu URL'nin veya yolun özelleştirilmesi.
• Farklı yollar veya yapılandırmalarla birden çok sağlık kontrolü uç noktalarını eşleme. Birden çok uç nokta desteği:
  • Farklı sistem durumu denetimleri veya bileşenleri için ayrı uç noktaları etkinleştirir.
  • Uygulamanın sistem durumunun farklı yönlerini ayırt etmek veya sistem durumu denetimlerinin alt kümelerine belirli yapılandırmalar uygulamak için kullanılır.
• Kaynak kod

Ek kaynaklar

• Örnek kodu görüntüleme veya indirme (indirme)

Note

Bu makale, kısmen yapay zeka yardımıyla oluşturulmuştur. Yayımlanmadan önce içerik bir yazar tarafından gözden geçirilmiş ve gereken şekilde düzeltilmiştir. Microsoft Learn'de yapay zeka tarafından oluşturulan içerik kullanma ilkelerimize bakın.