-
Notifications
You must be signed in to change notification settings - Fork 1.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[SG-497] BEEEP - Health Checks API Project #2237
Conversation
I think this is something that needs to be discussed with devops and cloudops first, if it adds anything that they don't already track, it's a lot of added dependencies so if we can get the data some other way that might be preferable. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks really good, super close. Just want to make sure it won't fail on SH installs when they probably won't have a lot of the various azure connection strings we have in cloud.
…ists, moved health check from startup to extension class
Removed AC Team from reviewers, as the only changes are to our package-lock.json. Please request a new review if we need to review any substantive code, thanks! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, great work!
Type of change
Objective
Dotnet core offers health checks middleware and a library that can be used to check the health of infrastructure app components. Health checks are exposed on
{baseUrl}/{path configured}
e.glocalhost:4000/health/extended
, having basic health checks on key infrastructure can be useful in knowing the overall health of an application by just accessing the exposed URL. I decided to add this to theAPI
project with checks onIdentityServer
,Database
, andDevelopment Mail Server
to show how it can be used and the values it might provide. Health reports can also be published toDataDog
,ApplicationInsights
etc.Code changes
This PR adds
HealthCheckServices.cs
extension class which configures the HealthCheck service and also registers infrastructures to be checked.Before you submit
dotnet format --verify-no-changes
) (required)