/// <summary>
/// Creates a new instance of <see cref="T:Collector.Common.Heartbeat.HeartbeatMiddleware" />
/// </summary>
/// <param name="next">The delegate representing the next middleware in the request pipeline.</param>
/// <param name="loggerFactory">The Logger to use.</param>
/// <param name="options">The middleware options.</param>
/// <param name="healthCheckFunc">The <see cref="Func{T, TResult}"/> to excute on <see cref="T"/>.</param>
public HeartbeatMiddleware(RequestDelegate next, ILoggerFactory loggerFactory, HeartbeatOptions options, Func <T, Task <DiagnosticsResults> > healthCheckFunc)
{
_next = next ?? throw new ArgumentNullException(nameof(next));
_logger = loggerFactory?.CreateLogger(typeof(HeartbeatMiddleware <T>)) ?? throw new ArgumentNullException(nameof(loggerFactory));
_options = options ?? throw new ArgumentNullException(nameof(options));
_healthCheckFunc = healthCheckFunc ?? throw new ArgumentNullException(nameof(healthCheckFunc));
}
/// <summary>
/// Will register a heartbeat route endpoint and run health check
/// </summary>
/// <typeparam name="T">Type of the health monitor</typeparam>
/// <param name="applicationBuilder">The <see cref="T:Microsoft.AspNetCore.Builder.IApplicationBuilder" /></param>
/// <param name="options">Options for heartbeat.</param>
/// <param name="healthCheckFunc">Function to execute on <see cref="T"/></param>
public static IApplicationBuilder UseHeartbeat <T>(this IApplicationBuilder applicationBuilder,
Func <T, Task <DiagnosticsResults> > healthCheckFunc, Action <HeartbeatOptions> options = null)
{
var heartbeatOptions = new HeartbeatOptions();
options?.Invoke(heartbeatOptions);
return(UseHeartbeat(applicationBuilder, healthCheckFunc, heartbeatOptions));
}
/// <summary>
/// Will register a heartbeat route endpoint and run health check
/// </summary>s
/// <param name="applicationBuilder">The <see cref="T:Microsoft.AspNetCore.Builder.IApplicationBuilder" /></param>
/// <param name="options">Options for heartbeat.</param>
public static IApplicationBuilder UseHeartbeat(this IApplicationBuilder applicationBuilder,
Action <HeartbeatOptions> options = null)
{
var heartbeatOptions = new HeartbeatOptions();
options?.Invoke(heartbeatOptions);
return(UseHeartbeat <IHeartbeatMonitor>(applicationBuilder, null, heartbeatOptions));
}
/// <summary>
/// Will register a heartbeat route endpoint and run health check
/// </summary>
/// <typeparam name="T">Type of the health monitor</typeparam>
/// <typeparam name="TR">Type of the health monitor invokation result type</typeparam>
/// <param name="applicationBuilder">The <see cref="T:Microsoft.AspNetCore.Builder.IApplicationBuilder" /></param>
/// <param name="options">Options for heartbeat.</param>
/// <param name="healthCheckFunc">Function to execute on <see cref="T"/></param>
public static IApplicationBuilder UseHeartbeat <T>(this IApplicationBuilder applicationBuilder,
Func <T, Task <DiagnosticsResults> > healthCheckFunc, HeartbeatOptions options = null)
{
if (applicationBuilder == null)
{
throw new ArgumentNullException(nameof(applicationBuilder));
}
options = options ?? new HeartbeatOptions();
if (string.IsNullOrWhiteSpace(options.HeartbeatRoute))
{
throw new ArgumentNullException(nameof(options.HeartbeatRoute));
}
if (!string.IsNullOrWhiteSpace(options.ApiKey) && string.IsNullOrWhiteSpace(options.ApiKeyHeaderKey))
{
throw new ArgumentNullException(nameof(options.ApiKeyHeaderKey));
}
return(applicationBuilder.Map(options.HeartbeatRoute, app =>
{
app.UseMiddleware <HeartbeatMiddleware <T> >(options, healthCheckFunc);
}));
}
/// <summary>
/// Will register a heartbeat route endpoint and run health check
/// </summary>s
/// <param name="applicationBuilder">The <see cref="T:Microsoft.AspNetCore.Builder.IApplicationBuilder" /></param>
/// <param name="options">Options for heartbeat.</param>
public static IApplicationBuilder UseHeartbeat(this IApplicationBuilder applicationBuilder, HeartbeatOptions options = null)
{
return(applicationBuilder.UseHeartbeat <IHeartbeatMonitor>(monitor => monitor.RunAsync(), options));
}