https://github.com/julie-ng/standard-healthcheck

Simple health check endpoint for Express per IETF response format
https://github.com/julie-ng/standard-healthcheck

express express-js health healthcheck http-api ietf node rest

Last synced: 8 days ago
JSON representation

Simple health check endpoint for Express per IETF response format

• Host: GitHub
• URL: https://github.com/julie-ng/standard-healthcheck
• Owner: julie-ng
• License: mit
• Created: 2020-02-19T12:18:50.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2023-03-04T06:06:21.000Z (over 1 year ago)
• Last Synced: 2024-04-20T11:47:20.274Z (7 months ago)
• Topics: express, express-js, health, healthcheck, http-api, ietf, node, rest
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/standard-healthcheck
• Size: 582 KB
• Stars: 6
• Watchers: 3
• Forks: 1
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - julie-ng/standard-healthcheck - Simple health check endpoint for Express per IETF response format (JavaScript)

README

        
# standard-healthcheck

[![CI](https://github.com/julie-ng/standard-healthcheck/actions/workflows/ci.yaml/badge.svg)](https://github.com/julie-ng/standard-healthcheck/actions/workflows/ci.yaml)

[![Test Coverage](https://api.codeclimate.com/v1/badges/d00bb74152c7914dccdd/test_coverage)](https://codeclimate.com/github/julie-ng/standard-healthcheck/test_coverage)

[![codecov](https://codecov.io/gh/julie-ng/standard-healthcheck/branch/main/graph/badge.svg?token=A5PDSL9YJU)](https://codecov.io/gh/julie-ng/standard-healthcheck)

[![Maintainability](https://api.codeclimate.com/v1/badges/d00bb74152c7914dccdd/maintainability)](https://codeclimate.com/github/julie-ng/standard-healthcheck/maintainability)

This tiny library exposes a health check endpoint in a **standard response format** per Internet Engineering Task Force (IETF). The proposed standard includes a few properties not included in standard extensions:

- description

- version number (important for debugging)

- uptime

- details about dependent downstream services

### Example Output

Example JSON response from [https://nodejs-demo.onazure.io/health](https://nodejs-demo.onazure.io/health)

```json

{

  "status": "pass",

  "description": "A multipurpose dummy node.js app for cloud architecture demos",

  "version": "0.2.1",

  "details": {

    "uptime": {

      "component_type": "system",

      "observed_value": 74401.282209224,

      "human_readable": "0 days, 20 hours, 40 minutes, 1 seconds",

      "observed_unit": "s",

      "status": "pass",

      "time": "2020-02-20T13:05:11.307Z"

    },

    "env": {

      "WEBSITE_HOSTNAME": "azure-nodejs-demo.azurewebsites.net",

      "WEBSITE_INSTANCE_ID": "c33cdebf5b0f427fdd331f28322f183c95c5320c0c952d9194ad7ce9867c2eaa"

    }

  }

}

```

For details about schema, see [IETF draft document](https://tools.ietf.org/html/draft-inadarei-api-health-check-04).

## Usage

```

npm install --save standard-healthcheck

```

Then import the library in your [Express.js](https://expressjs.com/) application and add the route to your app:

```javascript

const healthcheck = require('standard-healthcheck')

app.get('/health', healthcheck({

    version: '1.0',

    description: 'My demo app',

    includeEnv: ['NODE_ENV']

})

```

### Optional: Environment variables

The proposed standard because is friendly for debugging. You can ask standard-healthcheck to output some environment variables (not recommended for production!) via the `includeEnv` optional property.

But it will ignore variables ending with `SECRET`, `PASSWORD`, `_KEY` and `_PASS` for security reasons.