README
¶
Project Title
A minimal and scalable api for monitoring service health. it registers apis then checks them continouisly if there was a change in its health condition a webhook gets called.
Roadmap
- mail webhook
- add sql, redis, ... support for health check
- add multi endpoint health check for diffrent states
Documentation
Directories
¶
| Path | Synopsis |
|---|---|
|
Package api provides primitives to interact with the openapi HTTP API.
|
Package api provides primitives to interact with the openapi HTTP API. |
|
pkg
|
|
|
checker
hchecker packages provides health check service its core functionalities it reads database each second and checks API's health check status then saves the result in database the package is configurable through MaxConcurrentRequests DatabaseFetchLimit HealthCheckTimeOut usually concurrent should be more than fetch limit because of timeout io time
|
hchecker packages provides health check service its core functionalities it reads database each second and checks API's health check status then saves the result in database the package is configurable through MaxConcurrentRequests DatabaseFetchLimit HealthCheckTimeOut usually concurrent should be more than fetch limit because of timeout io time |
|
storage
Package hcheckdb provides health check service it's database needs This package doesn't validate inputs so everything passed here must be validated first, so every error returned is an internal error
|
Package hcheckdb provides health check service it's database needs This package doesn't validate inputs so everything passed here must be validated first, so every error returned is an internal error |
Click to show internal directories.
Click to hide internal directories.