express-actuator-endpoints v0.2.1

Express Actuator Endpoints

This module is an express middleware that exposes endpoints that somewhat mimic the behavior of Spring Boot Actuator

All responses are in JSON format.

Installation

npm i --S express-actuator-endpoints

Usage

import express from "express";
import actuator from "express-actuator-endpoints";

const app = express();
app.use(actuator());

Endpoints

Configuration

You can pass a configuration object to this middleware and the routes will serve any information you pass, along with the defaults. See example below:

import express from "express";
import actuator from "express-actuator-endpoints";

const actuatorConfig = {
  info: {
    gitInfo: "Some git info"
  },
  health: {
    description: "Jim's API"
  }
};

const app = express();
app.use(actuator(actuatorConfig));