feat: add actuator endpoints to expose health/metrics

config/env/default.js

@@ -416,6 +416,13 @@ module.exports = {
 		path: '/api-docs'
 	},
 
+	actuator: {
+		enabled: true,
+		options: {
+			basePath: '/actuator'
+		}
+	},
+
 	// The port to use for the application (defaults to the environment variable if present)
 	port: process.env.PORT || 3001,
 

package.json

@@ -61,6 +61,7 @@
     "cors": "^2.8.5",
     "csv-stringify": "4.0",
     "express": "4.17",
+    "express-actuator": "^1.8.4",
     "express-async-errors": "^3.1.1",
     "express-json-validator-middleware": "^2.2.1",
     "express-session": "1.15",

src/lib/express.ts

@@ -9,6 +9,7 @@ import express, { Express, Request, Response } from 'express';
 // Patches express to support async/await.  Should be called immediately after express.
 // Must still use require vs. import
 require('express-async-errors');
+import actuator from 'express-actuator';
 import session from 'express-session';
 import helmet from 'helmet';
 import _ from 'lodash';
@@ -205,12 +206,22 @@ function initErrorRoutes(app: Express) {
 	});
 }
 
+function initActuator(app: Express) {
+	if (!config.actuator.enabled) {
+		return;
+	}
+	logger.info('Configuring actuator endpoints');
+	app.use(actuator(config.actuator.options));
+}
+
 function initSwaggerAPI(app: Express) {
 	if (!config.apiDocs || config.apiDocs.enabled !== true) {
 		// apiDocs must be enabled explicitly in the config
 		return;
 	}
 
+	logger.info('Configuring api docs');
+
 	// eslint-disable-next-line @typescript-eslint/no-explicit-any
 	const swaggerOptions: any = {
 		swaggerDefinition: {
@@ -315,6 +326,9 @@ export const init = async (db: Mongoose): Promise<Express> => {
 	// Initialize Swagger API
 	initSwaggerAPI(app);
 
+	// Initialize Actuator routes
+	initActuator(app);
+
 	// Initialize error routes
 	initErrorRoutes(app);