@maxdome/health

Provides an `/health` endpoint response with the health of the app in the [Spring Boot format](https://docs.spring.io/spring-boot/docs/current/reference/html/production-ready-monitoring.html#production-ready-health-access-restrictions).

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
00Feb 25, 2019May 22, 2017Minified + gzip package size for @maxdome/health in KB

Readme

Provides an /health endpoint response with the health of the app in the Spring Boot format.

Usage

app.get('/health', require('@maxdome/health').controller({
  example: () => {},
}));

Example response

{
  "example": { status: "UP" },
  "status":"UP"
}

Plugins

Swagger

paths:
  /health:
    get:
      summary: "Healthcheck if the app is running correctly"
      responses:
        200:
          description: "OK"
          schema:
            type: object
            properties:
              status:
                type: string
                example: "UP"
        500:
          description: "Internal Server Error"

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.