Graph Health Checks for HotChocolate.
The purpose of this middleware is to provide feedback in regards to the health of the schema.
HotChocolate Version | DataAnnotatedModelValidations Version | .NET Version |
---|---|---|
14.0.0-rc.0 or higher | 3.0.0-beta.1 | .NET 8 |
HotChocolate Version | Last DataAnnotatedModelValidations Version | .NET Version |
---|---|---|
13.7.0 or higher | 2.0.1 | .NET 6, 8 |
13.3.3 or higher | 1.0.2 | .NET 6, 7 |
📝For more information please visit https://www.nuget.org/packages/GraphHealthChecks/#versions-body-tab
There appears to be a compatibility issue for projects targeting .NET 7 and assembly
Assembly Microsoft.Extensions.Hosting, Version=7.0.0.0
and more specifically
OptionsBuilderExtensions.ValidateOnStart
resulting in error:
The call is ambiguous between the following methods or properties:
Microsoft.Extensions.DependencyInjection.OptionsBuilderExtensions.ValidateOnStart<TOptions>(Microsoft.Extensions.Options.OptionsBuilder<TOptions>)
andMicrosoft.Extensions.DependencyInjection.OptionsBuilderExtensions.ValidateOnStart<TOptions>(Microsoft.Extensions.Options.OptionsBuilder<TOptions>)
Until resolved please consider using a version of the package targeting .NET 7.
Locate the services registration and append one of:
.AddGraphHealthWithNoLogger
- use when no logging is required.AddGraphHealthWithILogger
- use when the ILogger provider is available.AddGraphHealthWithILoggerFactory
- use when the ILoggerFactory provider is available
IHealthChecksBuilder
needs to be appended before any of the aforementioned.
ex.
// Startup.cs
public void ConfigureServices(IServiceCollection services)
{
// ...
services
.AddHealthChecks()
.AddGraphHealthWithILogger();
// ...
}
📝 If further customization is required, consider wiring up any of the factories manually or use the GraphHealthCheck
class itself as required.
If separate schemas are present, multiple registrations can be done for each schema.
ex.
// Startup.cs
public void ConfigureServices(IServiceCollection services)
{
// ...
services
.AddHealthChecks()
.AddGraphHealthWithILogger(healthName: "health1", schemaName: "schema1")
.AddGraphHealthWithILogger(healthName: "health2", schemaName: "schema2");
// ...
}