Add IHealthCheckPublisher for push-based checks #498
Conversation
IHealthCheckPublisher allows you to configure and run health checks regularly inside an application, and push the notifications elsewhere. All publishers are part of a single queue with a configurable period and timeout.
| /// <returns>A <see cref="Task"/> which will complete when publishing is complete.</returns> | ||
| Task PublishAsync(HealthReport report, CancellationToken cancellationToken); | ||
| } | ||
| } |
There was a problem hiding this comment.
OK, this is going to go in sometime soon, please let us know if you have any feedback because it will be hard to change in about a week 😆
src/Microsoft.Extensions.Diagnostics.HealthChecks/HealthCheckPublisherHostedService.cs
Show resolved
Hide resolved
src/Microsoft.Extensions.Diagnostics.HealthChecks/HealthCheckPublisherOptions.cs
Show resolved
Hide resolved
src/Microsoft.Extensions.Diagnostics.HealthChecks/HealthCheckPublisherHostedService.cs
Show resolved
Hide resolved
| cancellation = CancellationTokenSource.CreateLinkedTokenSource(_stopping.Token); | ||
| if (timeout != Timeout.InfiniteTimeSpan) | ||
| { | ||
| cancellation.CancelAfter(timeout); |
There was a problem hiding this comment.
CancelAfter understands InfiniteTimeSpan, you don't need an explicit check.
| _publishers = publishers.ToArray(); | ||
| } | ||
|
|
||
| internal bool IsCancelled => _stopping == null || _stopping.IsCancellationRequested; |
There was a problem hiding this comment.
Yeah, more bad races, don't null out _stopping
| } | ||
| catch (Exception ex) | ||
| { | ||
| // Handle any exceptions that are thrown synchronously - this allows us to start |
There was a problem hiding this comment.
async/await methods don't throw exceptions synchronously, they capture all exceptions and throw them later.
There was a problem hiding this comment.
Yeah, I think this here from before I wrote RunPublisherAsync. This code used to call the publisher directly.
I can't imagine a world where we make RunPublisherAsync into a sync implementation - so I'm ok with this change.
| /// <see cref="IHealthCheckPublisher"/> instances. The delay is applied once at startup, and does | ||
| /// not apply to subsequent iterations. The default value is 5 seconds. | ||
| /// </summary> | ||
| public TimeSpan Delay { get; set; } = TimeSpan.FromSeconds(5); |
There was a problem hiding this comment.
Valid range? What if I set 0 or InfinateTimeSpan?
| /// Gets or sets the period of <see cref="IHealthCheckPublisher"/> execution. The default value is | ||
| /// 30 seconds. | ||
| /// </summary> | ||
| public TimeSpan Period { get; set; } = TimeSpan.FromSeconds(30); |
There was a problem hiding this comment.
Valid range? What if I set 0 or InfinateTimeSpan?
|
@Tratcher Updated |
samples/WelcomePageSample/web.config
Outdated
| @@ -4,6 +4,8 @@ | |||
| <handlers> | |||
There was a problem hiding this comment.
Why is this file even here? It's not needed.
| @@ -77,6 +77,8 @@ public Task StartAsync(CancellationToken cancellationToken = default) | |||
|
|
|||
| public Task StopAsync(CancellationToken cancellationToken = default) | |||
| { | |||
| _stopping.Cancel(); | |||
There was a problem hiding this comment.
try/catch Exception, callbacks are invoked synchronously and can throw.
rynowak
force-pushed
the
rynowak/push-health-checks
branch
from
a341d8c to
e0f1710
Compare
IHealthCheckPublisher allows you to configure and run health checks
regularly inside an application, and push the notifications elsewhere.
All publishers are part of a single queue with a configurable period and
timeout.