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.

Sistem durumu denetimleri bir uygulama tarafından HTTP uç noktaları olarak kullanıma sunulur. 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üzenleyicileri ve yük dengeleyiciler tarafından kullanılabilir. Örneğin, kapsayıcı düzenleyici sıralı dağıtımı durdurarak veya kapsayıcıyı yeniden başlatarak başarısız olan sistem durumu denetimine yanıt verebilir. 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.

Sistem durumu denetimleri genellikle bir uygulamanın durumunu denetlemek için bir dış 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 sistem durumu denetimlerinin oluşturulacağını ve uç noktalarının nasıl yapılandıracağını belirler.

Temel sistem durumu yoklaması

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

Temel yapılandırma, sistem durumu denetimi hizmetlerini kaydeder ve sistem durumu yanıtıyla BIR URL uç noktasında yanıt vermek için Sistem Durumu Denetimleri Ara Yazılımını çağırır. Varsayılan olarak, belirli bir bağımlılığı veya alt sistemi test etmek için belirli bir sistem durumu denetimi kaydedilmez. 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, veya HealthStatus.UnhealthyşeklindedirHealthStatus.HealthyHealthStatus.Degraded.

ile sistem durumu denetimi hizmetlerini AddHealthChecks ile Program.cskaydedin. çağrısı MapHealthChecksyaparak bir sistem durumu denetimi uç noktası oluşturun.

Aşağıdaki örnek konumunda /healthzbir sistem durumu denetimi uç noktası oluşturur:

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddHealthChecks();

var app = builder.Build();

app.MapHealthChecks("/healthz");

app.Run();

Docker karşılaştırması hakkında daha fazla bilgi edininHEALTHCHECK

Docker , temel sistem durumu denetimi yapılandırmasını kullanan bir uygulamanın durumunu denetlemek için kullanılabilecek yerleşik HEALTHCHECK bir yönerge sunar:

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

Yukarıdaki örnek, konumundaki /healthzsistem durumu denetimi uç noktasına http isteğinde bulunmak için kullanırcurl. curl .NET Linux kapsayıcı görüntülerine dahil değildir, ancak gerekli paketi Dockerfile dosyasına yükleyerek eklenebilir. Alpine Linux tabanlı görüntüleri kullanan kapsayıcılar, yerine dahil wget edilen öğesini curlkullanabilir.

Sistem durumu denetimleri oluşturma

Sistem durumu denetimleri arabirimi uygulanarak IHealthCheck oluşturulur. yöntemi, CheckHealthAsync sistem durumunu , Degradedveya Unhealthyolarak Healthygösteren bir HealthCheckResult döndürür. Sonuç, yapılandırılabilir durum koduyla düz metin yanıtı olarak yazılır. Yapılandırma, Sistem durumu denetimi seçenekleri bölümünde açıklanmıştır. HealthCheckResult isteğe bağlı anahtar-değer çiftleri de döndürebilir.

Aşağıdaki örnekte sistem durumu denetiminin düzeni 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."));
    }
}

Sistem durumu denetiminin mantığı yöntemine CheckHealthAsync yerleştirilir. Yukarıdaki örnek, isHealthytrueolarak bir kukla değişkeni ayarlar. değeri isHealthy olarak ayarlanırsafalseHealthCheckRegistration.FailureStatus, durum döndürülür.

Denetim sırasında bir özel durum oluşturursaCheckHealthAsync, değerine ayarlanmış FailureStatusyeni bir döndürülür HealthReportEntry HealthReportEntry.Status. Bu durum tarafından AddCheck tanımlanır (sistem durumu denetimi hizmetlerini kaydetme bölümüne bakın) ve denetim hatasına neden olan iç özel durumu içerir. Description, özel durumun iletisine ayarlanır.

Sistem durumu denetimi hizmetlerini kaydetme

Sistem durumu denetimi hizmetini kaydetmek için öğesini Program.csarayınAddCheck:

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) HealthStatus.Unhealthy olarak ayarlanırsa null raporlanır. Bu aşırı yükleme, kitaplık yazarları için yararlı bir senaryodur ve sistem durumu denetimi uygulaması ayarı kabul ederse sistem durumu denetimi hatası oluştuğunda kitaplık tarafından belirtilen hata durumunun uygulama tarafından zorlandığı bir senaryodur.

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, sistem durumu denetimi her zaman iyi durumda bir sonuç döndürür:

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

Bir sistem durumu denetimi uygulamasına bağımsız değişkenleri geçirmek için çağrısı AddTypeActivatedCheck . Aşağıdaki örnekte, tür etkinleştirilmiş sistem durumu denetimi, oluşturucusunda bir tamsayı ve 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 sistem durumu denetimini kaydetmek için, bağımsız değişken olarak geçirilen tamsayı ve dizeyle çağrısı AddTypeActivatedCheck yapın:

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

Sistem Durumu Denetimleri Yönlendirmeyi Kullanma

içinde uç nokta URL'si Program.csveya göreli yolu ile uç nokta oluşturucusunu çağırın MapHealthChecks :

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 punycode yerine Unicode olmalıdır ve bir bağlantı noktası içerebilir. Koleksiyon sağlanmazsa, herhangi bir konak kabul edilir:

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

Sistem durumu denetimi uç noktasını yalnızca belirli bir bağlantı noktasında yanıt verecek şekilde kısıtlamak için RequireHostçağrısında bir bağlantı noktası belirtin. Bu yaklaşım genellikle izleme hizmetleri için bir bağlantı noktasını kullanıma sunma amacıyla kapsayıcı ortamında kullanılır:

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

Uyarı

ve RequireHostgibi HttpRequest.Host Konak üst bilgisini kullanan API, istemciler tarafından olası kimlik sahtekarlığına tabidir.

Konak ve bağlantı noktası kimlik sahtekarlığına engel olmak için aşağıdaki yaklaşımlardan birini kullanın:

• BağlantıConnectionInfo.LocalPort noktalarının denetlendiği yeri () kullanın HttpContext.Connection .
• Konak filtrelemeyi 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 bkz . RequireHost ile yollarda konak eşleştirme.

Yetkilendirme gerektir

Durum denetimi isteği uç noktasında Yetkilendirme Ara Yazılımını çalıştırmak için çağırın RequireAuthorization . 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 bkz . ASP.NET Core'da Çıkış Noktaları Arası İstekleri (CORS) Etkinleştirme.

Sistem durumu denetimi seçenekleri

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

• Sistem durumu denetimlerini filtrele
• HTTP durum kodunu özelleştirme
• Önbellek üst bilgilerini gizleme
• Çıktıyı özelleştirme

Sistem durumu denetimlerini 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, sistem durumu denetimlerini yalnızca çalıştır ile etiketlenenlerin çalışması için sample filtreler:

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

HTTP durum kodunu özelleştirme

Durum durumunu HTTP durum kodlarıyla eşlemeyi özelleştirmek için kullanın ResultStatusCodes . 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 (varsayılan) ise false , ara yazılım yanıt önbelleğe almayı önlemek için , Expiresve Pragma üst bilgilerini ayarlar veya geçersiz kılarCache-Control. 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 çıkışını özelleştirmek için, özelliğini yanıtı yazan bir temsilci olarak ayarlayın HealthCheckOptions.ResponseWriter :

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 kullanarak System.Text.Jsonözel bir JSON yanıtı 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. ile System.Text.JsonJSON serileştirmesi hakkında daha fazla bilgi için bkz . .NET'te JSON'ı seri hale getirme ve seri durumdan çıkarma.

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.

Uyarı

Bir sorguyla 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);

Not

AspNetCore.Diagnostics.HealthChecks microsoft tarafından korunmuyor veya desteklenmiyor.

Entity Framework Core DbContext araştırması

Denetim, DbContext uygulamanın için EF CoreDbContextyapılandırılan veritabanıyla iletişim kurabildiğini onaylar. Denetim DbContext , aşağıdaki uygulamalarda desteklenir:

• Entity Framework (EF) Core kullanın.
• NuGet paketine Microsoft.Extensions.Diagnostics.HealthChecks.EntityFrameworkCore bir paket başvurusu ekleyin.

AddDbContextCheck için bir sistem durumu denetimi DbContextkaydeder. DbContext yöntemine olarak TContextsağlanır. Hata durumunu, etiketleri ve özel test sorgusunu yapılandırmak için bir aşırı yükleme kullanılabilir.

Varsayılan olarak:

• 'DbContextHealthChecknin CanConnectAsync yöntemini çağırırEF Core. Yöntem aşırı yüklemelerini kullanarak AddDbContextCheck sistem durumu denetlenirken çalıştırılacak işlemi özelleştirebilirsiniz.
• Sistem durumu denetiminin adı türün TContext adıdır.

Aşağıdaki örnek ve DbContext ilişkili DbContextHealthCheckbir 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ılır:

• Hazır olma, uygulamanın normal çalışıp çalışmadığını ancak istekleri almaya hazır olmadığını gösterir.
• Canlılık , bir uygulamanın kilitlenip kilitlenmediğini ve yeniden başlatılması gerektiğ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 uygulamanın yeniden başlatılmasını istemiyoruz çünkü uygulama dosyayı birkaç kez indirmeyi yeniden deneyebilir. İşlemin canlılığını açıklamak için canlılık araştırması kullanırız, başka hiçbir denetim çalıştırılır. Yapılandırma dosyası indirme başarılı olmadan önce isteklerin uygulamaya gönderilmesini de engellemek istiyoruz. İndirme başarılı olana ve uygulama istekleri almaya hazır olana kadar "hazır değil" durumunu belirtmek için hazır olma araştırması kullanırız.

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

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;
    }
}

uzun StartupHealthCheck süre çalışan başlangıç görevinin tamamlandığını bildirir ve arka plan hizmeti tarafından ayarlanan özelliği kullanıma sunar StartupCompleted :

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."));
    }
}

Sistem durumu denetimi ile birlikte barındırılan hizmetle AddCheck Program.cs birlikte kaydedilir. Barındırılan hizmetin sistem durumu denetiminde özelliğini ayarlaması gerektiğinden, sistem durumu denetimi de hizmet kapsayıcısında tekil olarak kaydedilir:

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

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

İki farklı sistem durumu denetimi uç noktası oluşturmak için iki kez çağrısında MapHealthChecks bulunur:

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, ile readyetiketlenenlere sistem durumu denetimlerini filtreler.
• /healthz/live canlılık kontrolü için. Canlılık denetimi, temsilciyi geri döndürerek false HealthCheckOptions.Predicate tüm sistem durumu denetimlerini 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 nokta tüm denetimleri dışlar ve tüm çağrılar için bir Healthy durum bildirir.

Kubernetes örneği

Ayrı hazır olma ve canlılık denetimleri kullanmak Kubernetes gibi bir ortamda kullanışlıdır. Kubernetes'te, temel alınan veritabanı kullanılabilirliği testi gibi istekleri kabul etmeden önce zaman alan başlangıç çalışmalarını çalıştırmak için bir uygulama gerekebilir. Ayrı denetimler kullanmak, düzenleyicinin uygulamanın çalışıp çalışmadığını ancak henüz hazır olup olmadığını veya uygulamanın başlatılamadığını ayırt etmesini sağlar. 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

Sistem durumu denetimi kitaplığı dağıtma

Sistem durumu denetimini kitaplık olarak dağıtmak için:

1. Arabirimi tek başına sınıf olarak uygulayan IHealthCheck bir sistem durumu 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. Kullanan uygulamanın yönteminde Program.cs çağıran parametrelerle bir uzantı yöntemi yazın. Ve'yi oluşturucu parametreleri olarak kabul arg1 arg2 eden aşağıdaki örnek sistem durumu denetimini göz önünde bulundurun:

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

   Yukarıdaki imza, sistem durumu denetiminin sistem durumu denetimi yoklama mantığını işlemek için özel veriler gerektirdiğini gösterir. Veriler, durum denetimi bir uzantı yöntemiyle kaydedildiğinde sistem durumu denetimi örneğini oluşturmak için kullanılan temsilciye sağlanır. Aşağıdaki örnekte, çağıran şunları belirtir:

   • arg1: Sistem 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 sistem durumu denetimi adı. ise null, varsayılan bir değer kullanılır.
   • failureStatus: Hata durumu için bildirilen isteğe bağlı HealthStatusbir . HealthStatus.Unhealthy ise nullkullanı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));
       }
   }
   

Sistem Durumu Denetimi Yayımcısı

hizmet kapsayıcısına bir IHealthCheckPublisher eklendiğinde sistem durumu denetimi sistemi, sistem durumu denetimlerinizi düzenli aralıklarla yürütür ve sonuçla birlikte çağrılar PublishAsync gerçekleştirir. 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 şunları ayarlamanıza izin verir:

• Delay: Örnekleri yürütmeden IHealthCheckPublisher önce uygulama başlatıldıktan sonra uygulanan ilk gecikme. Gecikme başlangıçta bir kez uygulanır ve sonraki yinelemeler için geçerli değildir. Varsayılan değer beş saniyedir.
• Period: Yürütme süresi IHealthCheckPublisher . Varsayılan değer 30 saniyedir.
• Predicate: (varsayılan) ise Predicate null , 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. Koşul her dönem değerlendirilir.
• Timeout: Tüm IHealthCheckPublisher örnekler için sistem durumu denetimlerini yürütmek için zaman aşımı. Zaman aşımı olmadan yürütmek için kullanın InfiniteTimeSpan . Varsayılan değer 30 saniyedir.

Aşağıdaki örnekte sistem durumu yayımcısının düzeni gösterilmektedir:

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

        return Task.CompletedTask;
    }
}

sınıfı, HealthCheckPublisherOptions sistem durumu denetimi yayımcısının davranışını yapılandırmaya yönelik özellikler sağlar.

Aşağıdaki örnek, bir sistem durumu denetimi yayımcısını tekil olarak kaydeder ve yapılandırılı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 Sistem Durumu Denetimleri

Delay ve Period her HealthCheckRegistration birinde ayrı ayrı ayarlanabilir. Bazı sistem durumu denetimlerini içinde HealthCheckPublisherOptionsayarlanan süreden farklı bir hızda çalıştırmak istediğinizde bu yararlı olur.

Aşağıdaki kod, için ve'yi Period SampleHealthCheck1ayarlarDelay:

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 Ekleme ve Sistem Durumu Denetimleri

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 eklemenin kullanılması, Sistem Durumu Denetimlerini yapılandırmak için yaygın bir senaryo değildir. Genellikle, her Sistem Durumu Denetimi gerçek teste oldukça özeldir 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 Sistem Durumu denetiminin hizmet kapsayıcısına eklenmesi gerekir:

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 erişilebilir hale getirmenin iki yolu vardır:

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

Over UseHealthChecks kullanmanın MapHealthChecks avantajı, yetkilendirme gibi uç nokta kullanan ara yazılımları kullanabilmek ve eşleşen ilke üzerinde daha ayrıntılı denetime sahip olmaktır. over MapHealthChecks kullanmanın UseHealthChecks birincil avantajı, sistem durumu denetimlerinin ara yazılım işlem hattında tam olarak nerede çalıştığını denetlemektir.

UseHealthChecks:

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

MapHealthChecks Sağ -lar:

• bir istek sistem durumu denetimi uç noktasıyla eşleştiğinde çağrısı yaparak ShortCircuitişlem hattını sonlandırma. Örneğin, app.MapHealthChecks("/healthz").ShortCircuit();. Daha fazla bilgi için bkz . Yönlendirmeden sonra kısa devre ara yazılımı.
• Sistem durumu denetimleri için belirli yolları veya uç noktaları eşleme.
• 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 sistem durumu denetimi uç noktası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)

Not

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.