23.273. Class GrpcHealthCheckServiceBase
Namespace: ArmoniK.Core.Common.gRPC
Assembly: ArmoniK.Core.Common.dll
Provides a base implementation of a gRPC health check service for ArmoniK, integrating with ASP.NET Core health checks. Supports readiness checks for multiple gRPC services and returns health status responses according to gRPC conventions.
[PublicAPI]
public abstract class GrpcHealthCheckServiceBase : Health.HealthBase
23.273.1. Inheritance
23.273.2. Derived
23.273.3. Inherited Members
Health.HealthBase.Check(HealthCheckRequest, ServerCallContext), Health.HealthBase.Watch(HealthCheckRequest, IServerStreamWriter<HealthCheckResponse>, ServerCallContext), object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()
23.273.4. Constructors
23.273.4.1. GrpcHealthCheckServiceBase(HealthCheckService, string[])
Initializes a new instance of the
protected GrpcHealthCheckServiceBase(HealthCheckService healthCheckService, string[] grpcServices)
23.273.4.1.1. Parameters
healthCheckService HealthCheckService
The ASP.NET Core health check service to use for health status reporting.
grpcServices string[]
An array of gRPC service names that this health check service supports.
23.273.5. Methods
23.273.5.1. Check(HealthCheckRequest, ServerCallContext)
Check gets the health of the specified service. If the requested service is unknown, the call will fail with status NOT_FOUND. If the caller does not specify a service name, the server should respond with its overall health status.
Clients should set a deadline when calling Check, and can declare the server unhealthy if they do not receive a timely response.
Check implementations should be idempotent and side effect free.
public override Task<HealthCheckResponse> Check(HealthCheckRequest request, ServerCallContext context)
23.273.5.1.1. Parameters
request HealthCheckRequest
The request received from the client.
context ServerCallContext
The context of the server-side call handler being invoked.
23.273.5.1.2. Returns
The response to send back to the client (wrapped by a task).