public BeatPulseContext Add(IBeatPulseLiveness liveness)
{
if (liveness == null)
{
throw new ArgumentNullException(nameof(liveness));
}
var defaultPath = liveness.DefaultPath;
if (!string.IsNullOrEmpty(defaultPath))
{
if (!_activeLiveness.ContainsKey(defaultPath))
{
_activeLiveness.Add(defaultPath, liveness);
}
else
{
throw new InvalidOperationException($"The path {defaultPath} is already configured.");
}
return(this);
}
else
{
throw new InvalidOperationException("The global path is automatically used for beat pulse.");
}
}
async Task <LivenessResult> RunLiveness(IBeatPulseLiveness liveness, HttpContext httpContext, CancellationToken cancellationToken)
{
_logger.LogInformation($"Executing liveness {liveness.Name}.");
var livenessResult = new LivenessResult(liveness.Name, liveness.DefaultPath);
livenessResult.StartCounter();
try
{
var(message, healthy) = await liveness.IsHealthy(httpContext, _environment.IsDevelopment(), cancellationToken);
livenessResult.StopCounter(message, healthy);
_logger.LogInformation($"The liveness {liveness.Name} is executed.");
}
catch (Exception ex)
{
_logger.LogError(ex, $"The liveness {liveness.Name} is unhealthy.");
var message = _environment.IsDevelopment()
? ex.Message : string.Format(BeatPulseKeys.BEATPULSE_HEALTHCHECK_DEFAULT_ERROR_MESSAGE, liveness.Name);
livenessResult.StopCounter(message, false);
}
return(livenessResult);
}
async Task <LivenessResult> RunLiveness(IBeatPulseLiveness liveness, LivenessExecutionContext livenessContext, HttpContext httpContext, BeatPulseOptions beatPulseOptions)
{
_logger.LogInformation($"Executing liveness {livenessContext.Name}.");
var livenessResult = new LivenessResult(livenessContext.Name, livenessContext.Path);
livenessResult.StartCounter();
try
{
using (var cancellationTokenSource = new CancellationTokenSource())
{
var livenessTask = liveness.IsHealthy(httpContext, livenessContext, cancellationTokenSource.Token);
if (await Task.WhenAny(livenessTask, Task.Delay(beatPulseOptions.Timeout, cancellationTokenSource.Token)) == livenessTask)
{
// The liveness is executed successfully and get the results
var(message, healthy) = await livenessTask;
livenessResult.StopCounter(message, healthy);
_logger.LogInformation($"The liveness {livenessContext.Name} is executed.");
}
else
{
// The liveness is timeout ( from configured options)
_logger.LogWarning($"The liveness {livenessContext.Name} is timeout, execution is cancelled.");
cancellationTokenSource.Cancel();
livenessResult.StopCounter(BeatPulseKeys.BEATPULSE_TIMEOUT_MESSAGE, false);
}
}
}
catch (Exception ex)
{
// The uri executed is now well formed, dns not found
// or any unexpected errror
_logger.LogError(ex, $"The liveness {livenessContext.Name} is unhealthy.");
var message = _environment.IsDevelopment()
? ex.Message : string.Format(BeatPulseKeys.BEATPULSE_HEALTHCHECK_DEFAULT_ERROR_MESSAGE, livenessContext.Name);
livenessResult.StopCounter(message, false);
}
return(livenessResult);
}
async Task <LivenessResult> RunLiveness(IBeatPulseLiveness liveness, LivenessExecutionContext executionContext, BeatPulseOptions options)
{
_logger.LogInformation($"Executing liveness {executionContext.Name}.");
var clock = Clock.StartNew();
try
{
using (var cancellationTokenSource = new CancellationTokenSource())
{
var livenessTask = liveness.IsHealthy(executionContext, cancellationTokenSource.Token);
if (await Task.WhenAny(livenessTask, Task.Delay(options.Timeout, cancellationTokenSource.Token)) == livenessTask)
{
_logger.LogInformation($"The liveness {executionContext.Name} is executed.");
return((await livenessTask)
.SetEnforced(name: executionContext.Name, path: executionContext.Path, duration: clock.Elapsed(), detailedErrors: options.DetailedErrors));
}
else
{
_logger.LogWarning($"The liveness {executionContext.Name} return timeout, execution is cancelled.");
cancellationTokenSource.Cancel();
return(LivenessResult.TimedOut()
.SetEnforced(name: executionContext.Name, path: executionContext.Path, duration: clock.Elapsed(), detailedErrors: options.DetailedErrors));
}
}
}
catch (Exception ex)
{
// The uri executed is now well formed, dns not found
// or any other unexpected exceptions from liveness executions.
_logger.LogError(ex, $"The liveness {executionContext.Name} is unhealthy.");
return(LivenessResult.UnHealthy(ex)
.SetEnforced(name: executionContext.Name, path: executionContext.Path, duration: clock.Elapsed(), detailedErrors: options.DetailedErrors));
}
}
public void UseLiveness(IBeatPulseLiveness liveness)
{
Liveness = liveness ?? throw new ArgumentNullException(nameof(liveness));
}
public BeatPulseLivenessInstanceRegistration(IBeatPulseLiveness liveness)
{
_instance = liveness ?? throw new ArgumentNullException(nameof(liveness));
}
public static BeatPulseContext AddLiveness(this BeatPulseContext ctx, IBeatPulseLiveness liveness) => ctx.AddLiveness(new BeatPulseLivenessInstanceRegistration(liveness));
public BeatPulseLivenessInstanceRegistration(IBeatPulseLiveness liveness, string name, string path = null)
{
_instance = liveness ?? throw new ArgumentNullException(nameof(liveness));
Name = name ?? throw new ArgumentNullException(nameof(name));
Path = path ?? name;
}
