https://github.com/flowcore-io/health-check-container
A simple service that responds to the health check endpoint based on configuration
https://github.com/flowcore-io/health-check-container
Last synced: 5 days ago
JSON representation
A simple service that responds to the health check endpoint based on configuration
- Host: GitHub
- URL: https://github.com/flowcore-io/health-check-container
- Owner: flowcore-io
- Created: 2023-03-14T19:48:36.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-15T10:09:21.000Z (over 3 years ago)
- Last Synced: 2025-02-26T19:37:31.874Z (over 1 year ago)
- Language: TypeScript
- Size: 221 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Simple Health Check Image
A simple service that responds to the /health endpoint depending on how it is configured.
## Configuration
environment variables that can be set to configure the service
| Environment Variable | Description | Type | Default Value | Required |
|----------------------|-------------|:----:|---------------|:--------:|
| PORT | The port the service will listen on | `number` | `3000` | |
| LOG_LEVEL | The log level the service will log at | `string` | `info` | |
| LOG_PRETTY_PRINT | Whether the logs should be pretty printed | `boolean` | `true` | |
| HEALTH_ENDPOINT | The endpoint that will return the health status | `string` | `health` | |
| HEALTH_CHECK_DELAY | The delay in ms before the health check will return | `number` | `0` | |
| SHOULD_PASS_HEALTH_CHECK | Whether the health check should pass or fail | `boolean` | `true` | |
| SHOULD_THROW_ERROR_ON_HEALTH_CHECK | Whether the health check should throw an error | `boolean` | `false` | |