EntityFrameworkCoreHealthChecksBuilderExtensions.AddDbContextCheck<TContext> 메서드

정의

네임스페이스:

Microsoft.Extensions.DependencyInjection

어셈블리:

Microsoft.Extensions.Diagnostics.HealthChecks.EntityFrameworkCore.dll

패키지:

Microsoft.Extensions.Diagnostics.HealthChecks.EntityFrameworkCore v8.0.4

Source:

EntityFrameworkCoreHealthChecksBuilderExtensions.cs

지정된 DbContext 형식에 대한 상태 검사 추가합니다.

public static Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder AddDbContextCheck<TContext> (this Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder builder, string? name = default, Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus? failureStatus = default, System.Collections.Generic.IEnumerable<string>? tags = default, Func<TContext,System.Threading.CancellationToken,System.Threading.Tasks.Task<bool>>? customTestQuery = default) where TContext : Microsoft.EntityFrameworkCore.DbContext;

static member AddDbContextCheck : Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder * string * Nullable<Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus> * seq<string> * Func<'Context, System.Threading.CancellationToken, System.Threading.Tasks.Task<bool> (requires 'Context :> Microsoft.EntityFrameworkCore.DbContext)> -> Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder (requires 'Context :> Microsoft.EntityFrameworkCore.DbContext)

<Extension()>
Public Function AddDbContextCheck(Of TContext As DbContext) (builder As IHealthChecksBuilder, Optional name As String = Nothing, Optional failureStatus As Nullable(Of HealthStatus) = Nothing, Optional tags As IEnumerable(Of String) = Nothing, Optional customTestQuery As Func(Of TContext, CancellationToken, Task(Of Boolean)) = Nothing) As IHealthChecksBuilder

형식 매개 변수

TContext

DbContext 형식입니다.

매개 변수

builder

IHealthChecksBuilder

IHealthChecksBuilder

name

String

상태 검사 이름입니다. 선택 사항입니다. 의 형식 이름이 이름 TContext 에 사용되는 경우null.

failureStatus

Nullable<HealthStatus>

HealthStatus 상태 검사 실패할 때 보고해야 하는 입니다. 선택 사항입니다. 이 경우 null 의 기본 상태 Unhealthy 보고됩니다.

tags

IEnumerable<String>

상태 검사 집합을 필터링하는 데 사용할 수 있는 태그 목록입니다. 선택 사항입니다.

customTestQuery

Func<TContext,CancellationToken,Task<Boolean>>

상태 검사 실행되어 데이터베이스 연결 및 구성의 상태를 테스트할 때 실행될 사용자 지정 테스트 쿼리입니다.

반환

IHealthChecksBuilder

IHealthChecksBuilder

설명

이 메서드에 의해 추가된 상태 검사 구현은 종속성 주입 컨테이너를 사용하여 의 TContextinstance 만듭니다.

기본적으로 상태 검사 구현은 메서드를 CanConnectAsync(CancellationToken) 사용하여 데이터베이스에 대한 연결을 테스트합니다. 이 메서드를 사용하려면 데이터베이스 공급자가 인터페이스를 올바르게 구현해야 합니다 IDatabaseCreator . 데이터베이스 공급자가 이 인터페이스를 구현하지 않은 경우 상태 검사 오류를 보고합니다.

customTestQuery 를 제공하면 의 사용 CanConnectAsync(CancellationToken) 이 데이터베이스 연결을 테스트하는 데 대체됩니다. 테스트 쿼리의 구현은 연결 실패로 인해 발생할 수 있는 예외를 처리해야 하며 통과/실패 결과를 반환해야 합니다. 테스트 쿼리는 짧고 예측 가능한 시간 안에 완료되도록 설계되어야 합니다.