SAKURUG TECHBLOG

ASP.NET CoreとAzure App Serviceでの正常性チェック

技術記事

2023-08-14 author-name

Tomomitsu

正常性チェックとは？

正常性チェックとは通常、アプリの状態を確認する目的で外部の監視サービスまたは、コンテナオーケストレータとともに使用されます。

監視システムからは作成するアプリの正常性チェックの種類とエンドポイントの設定方法が指示されます。

また、そのアプリケーションが例えばデータベースを使用していたならば一般にデータベースの応答確認、ストレージを使用していたならばストレージの応答確認までがチェック内容です。

基本的な正常性プローブ

多くのアプリでは、アプリが要求を処理できることを報告することで基本的な正常性チェックができます。

基本的な構成では、正常性チェックサービスを登録して、正常性チェックミドルウェアを呼び出します。このミドルウェアがURLエンドポイントにおける正常性を返します。

既定では、特定の依存関係だとかデータベース・ストレージといったものをテストする正常性チェックは登録されていません。必要に応じてこれらを登録する必要があります。

正常性エンドポイントが応答できる場合、このアプリは正常であると見なします。

構成例は以下の通りです。

program.cs

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddHealthChecks();

var app = builder.Build();

app.MapHealthChecks("/healthz");

app.Run();

Blazor Serverアプリに正常性チェックを登録してみる

.NET 7のBlazor Serverのテンプレートに正常性チェックを追加してApp Serviceにデプロイしてみたいと思います。

まず、Program.csに次のようにコードを追加します。

using HealthCheckTest.Data;
using Microsoft.AspNetCore.Components;
using Microsoft.AspNetCore.Components.Web;

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.
builder.Services.AddRazorPages();
builder.Services.AddServerSideBlazor();
builder.Services.AddSingleton<WeatherForecastService>();
builder.Services.AddHealthChecks(); // 追加

var app = builder.Build();

// Configure the HTTP request pipeline.
if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
    // The default HSTS value is 30 days. You may want to change this for production scenarios, see https://aka.ms/aspnetcore-hsts.
    app.UseHsts();
}

app.UseHttpsRedirection();

app.UseStaticFiles();

app.UseRouting();

app.MapBlazorHub();
app.MapFallbackToPage("/_Host");
app.MapHealthChecks("/healthz"); // 追加


app.Run();