Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/firstandthird/hapi-health
server monitoring
https://github.com/firstandthird/hapi-health
hapi-plugin hapi-v17
Last synced: 3 days ago
JSON representation
server monitoring
- Host: GitHub
- URL: https://github.com/firstandthird/hapi-health
- Owner: firstandthird
- License: mit
- Created: 2017-12-30T08:34:44.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2021-03-17T18:30:07.000Z (almost 4 years ago)
- Last Synced: 2025-01-18T00:03:45.178Z (5 days ago)
- Topics: hapi-plugin, hapi-v17
- Language: JavaScript
- Size: 20.5 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# hapi-health
[hapi](https://hapi.dev/) plugin that exposes a '/health' route that can be
used for checking basic health metrics for your server.
## Installation
```
npm install hapi-health
```
## Basic Usage
```js
await server.register({
plugin: require('hapi-health')
});
```
Then GET _/health_ you will get back something like:
```json
{
"host": "sorrynotsorry.local",
"env": "test",
"uptime": 0,
"cpu": { "user": 384085, "system": 48978 },
"memory": {
"rss": 47497216,
"heapTotal": 32874496,
"heapUsed": 18066608,
"external": 518509
}
}
```
## Custom Checks
You can also use hapi [server methods](https://hapi.dev/api/?v=20.1.0#-servermethodname-method-options) to run and return custom checks that will then be returned along with the other metrics. These server methods must accept the parameter signature _(request, options)_, where _request_ will be the hapi [request object](https://hapi.dev/api/?v=20.1.0#request) and _options_ is an object that you specify when you register the plugin. The server must return a JSON object, but they can be either sync or async.
Pass _checks_ as an array, each item in the array should have the following fields:
- _name_ (required)
Name of the check, hapi-health will add a field with this name containined the output of the server.method.
- _method_ (required)
Name of the server method to call (nested server methods can be called like 'foo.bar.bat').
- _options_ (optional)
You can specify an _options_ object that will be passed to the server method when it is invoked.
For example:
```js
server.method('foo', async(request, options) => {
return {
user: request.auth.credentials.user,
result: options.arg1 + 1
};
});
await server.register({
plugin: require('hapi-health'),
options: {
checks: [
{
name: 'My Custom Check',
method 'foo',
options: {
arg1: 2
}},
]
}
});
```
Now when you call _/health_ you will get something like:
```json
{
"host": "sorrynotsorry.local",
"env": "test",
"uptime": 0,
"cpu": { "user": 384085, "system": 48978 },
"memory": {
"rss": 47497216,
"heapTotal": 32874496,
"heapUsed": 18066608,
"external": 518509
},
"My Custom Check": {
"user": "myself",
"result": 3
}
}
```
## Other Options:
- _auth_
By default the _/health_ route is unprotected, but you can specify a standard hapi [auth route config](https://hapi.dev/api/?v=20.1.0#-routeoptionsauth), which will be applied to the route config.
- _token_
When specified, hapi-health will also internally require a '?token=' parameter when calling the _/health_ route. If it does not match or is not present then it will return a 401 Unauthorized. This is in addition to any _auth_ config that has been applied to the route.
- _endpoint_
By default hapi-health uses _/health_ as the endpoint, but you can use this option to specify a different route to use as your health endpoint.