Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/qiwi/health-indicator
Health indicator for server-side monitoring & balancing
https://github.com/qiwi/health-indicator
js-platform
Last synced: 4 days ago
JSON representation
Health indicator for server-side monitoring & balancing
- Host: GitHub
- URL: https://github.com/qiwi/health-indicator
- Owner: qiwi
- License: mit
- Created: 2018-02-09T20:14:22.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-11-01T21:03:20.000Z (14 days ago)
- Last Synced: 2024-11-10T23:37:21.753Z (5 days ago)
- Topics: js-platform
- Language: TypeScript
- Size: 1.59 MB
- Stars: 2
- Watchers: 5
- Forks: 1
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Health indicator
[](https://github.com/qiwi/health-indicator/actions)
[](https://codeclimate.com/github/qiwi/health-indicator/maintainability)
[](https://codeclimate.com/github/qiwi/health-indicator/test_coverage)
[](https://www.npmjs.com/package/@qiwi/health-indicator)
Health indicator kit for server-side monitoring and balancing.
Inspired by [Part V. Spring Boot Actuator: Production-ready feature 47.6.2 Writing custom HealthIndicators](https://docs.spring.io/spring-boot/docs/current/reference/html/production-ready-endpoints.html)
## Install
```bash
npm i @qiwi/health-indicator
yarn add @qiwi/health-indicator
```
## Usage
```javascript
import express from 'express'
import {SemaphoreIndicator, Endpoint} from '@qiwi/health-indicator'
const app = express()
const indicator = new SemaphoreIndicator()
const endpoint = new Endpoint(indicator)
// Override 'getStatus' impl in accordance with your business logic
indicator.getStatus = () => {
...
return 'GREEN'
}
// ... or use separate class MyIndicator extends SemaphoreIndicator {...}
// ... or just directly set indicator status property
indicator.status = 'RED'
app.get('/health', endpoint.middleware)
```
Indicator composes aggregator logic, so its health status may be resolved from deps.
```javascript
const dep1 = new SemaphoreIndicator({status: 'RED', critical: true})
const dep2 = new SemaphoreIndicator({status: 'GREEN'})
const dep3 = new SemaphoreIndicator({deps: {dep1, dep2}})
const indicator = new SemaphoreIndicator({deps: {dep3}})
indicator.health()
/*
{
status: 'RED',
critical: true,
deps: {
status: 'RED',
critical: true,
deps: {
dep1: {
status: 'RED',
critical: true
},
dep2: {
status: 'GREEN'
}
}
}
}
*/
```
### Customization
The lib exports only a couple of indicator implementations:
* `StandardIndicator` (DOWN, OUT_OF_SERVICE, UNKNOWN, UP)
* `SemaphoreIndicator` (RED, BROKEN, GREEN)
To declare any `CustomIndicator` you may easily extend the `AbstractIndicator`
```javascript
import {AbstractIndicator} from '@qiwi/health-indicator'
const OK = 200
const SERVICE_UNAVAILABLE = 503
export const GREEN = 'GREEN'
export const RED = 'RED'
export const BROKEN = 'BROKEN'
export const STATUS_MAP = {GREEN, BROKEN, RED}
export const SEVERITY_ORDER = [RED, BROKEN, GREEN]
export const DEFAULT_HTTP_CODE = OK
export const HTTP_MAP = {[GREEN]: OK, [RED]: SERVICE_UNAVAILABLE, [BROKEN]: SERVICE_UNAVAILABLE}
export default class SemaphoreIndicator extends AbstractIndicator {
static getDefaultStatus (): string {
return BROKEN
}
static getDefaultHttpCode (): number {
return DEFAULT_HTTP_CODE
}
static getHttpMap (): Object {
return HTTP_MAP
}
static getStatusMap (): Object {
return STATUS_MAP
}
static getSeverityOrder (): string[] {
return SEVERITY_ORDER
}
}
```
## License
[MIT](./LICENSE)