https://github.com/inadarei/rfc-healthcheck
Health Check Response RFC Draft for HTTP APIs
https://github.com/inadarei/rfc-healthcheck
healthcheck rfc
Last synced: 25 days ago
JSON representation
Health Check Response RFC Draft for HTTP APIs
- Host: GitHub
- URL: https://github.com/inadarei/rfc-healthcheck
- Owner: inadarei
- License: mit
- Created: 2018-01-15T05:01:43.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-10-16T12:44:45.000Z (over 3 years ago)
- Last Synced: 2025-02-03T14:28:35.094Z (3 months ago)
- Topics: healthcheck, rfc
- Language: HTML
- Homepage: https://inadarei.github.io/rfc-healthcheck/
- Size: 7.39 MB
- Stars: 117
- Watchers: 26
- Forks: 13
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - inadarei/rfc-healthcheck - Health Check Response RFC Draft for HTTP APIs (HTML)
README
# api-healthcheck
Health Check Response RFC Draft for HTTP APIs
Published RFC Draft:
## Workspace Setup
```
> git clone https://github.com/inadarei/rfc-healthcheck.git
> sudo -H gem install kramdown-rfc2629
> sudo -H easy_install pip # optional, if you don't already have it
> sudo -H sudo pip install xml2rfc
> .githooks/install.sh # to enable automated rebuilds on git push
```## Using
1. Edit draft.md
2. To regenerate the latest version of XML/TXT/HTML;```
make latest
```## Known Implementations
1. Node.js: https://github.com/inadarei/maikai
2. Golang: https://github.com/nelkinda/health-go
3. .NET: https://github.com/RockLib/RockLib.HealthChecks
4. Python: https://github.com/Colin-b/healthpy## References
In creation of this RFC following existing standards were reviewed and taken
into account:1. [Kubernetes health](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/#define-a-liveness-http-request)
1. [Azure health](https://docs.microsoft.com/en-us/azure/architecture/patterns/health-endpoint-monitoring)
1. [Spring Boot](https://docs.spring.io/spring-boot/docs/current/reference/html/production-ready-endpoints.html#_writing_custom_healthindicators)
1. [Node Terminus](https://github.com/godaddy/terminus)