@mimik/init 3.7.4 → 3.8.0

package/README.md

@@ -32,7 +32,8 @@ The `return` object has the following strucuture:
    config: The configuration object,
  }
 ```
-For the preOps, postOps and exitOps the function are executed with 3 parameters (correlationId, config, server)  
+For the preOps, postOps and exitOps the function are executed with 3 parameters (correlationId, config, server).
+The following routes are reserved: /healthcheck and /metrics  
 
 | Param | Type | Description |
 | --- | --- | --- |

package/index.js

@@ -9,16 +9,20 @@ const logger = require('@mimik/sumologic-winston-logger');
 const swagger = require('@mimik/swagger-helper');
 const oauthHelper = require('@mimik/oauth-helper');
 const { startupHealthInfo } = require('@mimik/healthcheck');
+const { healthInfo } = require('@mimik/systeminfo');
 const { getPublic } = require('@mimik/public-helper');
 const { getCorrelationId } = require('@mimik/request-helper');
 const { extractLogs } = require('./lib/logs');
 const { sigProcess } = require('./lib/exit');
 const { APIRequestMetrics, startHrTimeSet } = require('./lib/metrics');
+const { HEALTHCHECK_ROUTE, METRICS_ROUTE } = require('./lib/common');
 
 const SIGINT = 'SIGINT';
 const SIGTERM = 'SIGTERM';
 const LOCAL = 'local';
 const SET_ON = 'on';
+const CONTENT_TYPE = 'Content-Type';
+const JSON_CONTENT = 'application/json';
 
 /**
  * @module ini
@@ -56,7 +60,8 @@ const SET_ON = 'on';
  *    config: The configuration object,
  *  }
  * ```
- * For the preOps, postOps and exitOps the function are executed with 3 parameters (correlationId, config, server)
+ * For the preOps, postOps and exitOps the function are executed with 3 parameters (correlationId, config, server).
+ * The following routes are reserved: /healthcheck and /metrics
  */
 module.exports = (app, rootDir, config, validates, cluster, options) => {
   const fatalError = (error, correlationId) => {
@@ -94,6 +99,27 @@ module.exports = (app, rootDir, config, validates, cluster, options) => {
       'connect-src': ['\'self\'', '*.swagger.io'],
     },
   }));
+  app.use(cors({ origin: '*' }));
+  app.use(HEALTHCHECK_ROUTE, (req, res) => {
+    res.setHeader(CONTENT_TYPE, JSON_CONTENT);
+    res.end(JSON.stringify(healthInfo(), null, 2));
+  });
+  if (options.metrics && options.metrics.register) {
+    app.use(METRICS_ROUTE, (req, res) => options.metrics.register.metrics()
+      .then((result) => {
+        res.setHeader(CONTENT_TYPE, options.metrics.register.contentType);
+        res.end(result);
+      })
+      .catch((err) => {
+        res.setHeader(CONTENT_TYPE, JSON_CONTENT);
+        const errResponse = {
+          statusCode: 500,
+          title: http.STATUS_CODES[500],
+          message: err.message,
+        };
+        res.end(JSON.stringify(errResponse), null, 2);
+      }));
+  }
   if (options && options.extractName) {
     ({ extractName } = options);
     if (!dependencies || !dependencies.mLG) {
@@ -113,7 +139,6 @@ module.exports = (app, rootDir, config, validates, cluster, options) => {
       if (options && options.metrics) {
         app.use(APIRequestMetrics(options.metrics.APIRequestDuration, serverSettings.basePath));
       }
-      app.use(cors({ origin: '*' }));
       app.use(middleware.swaggerValidator());
       if ((config.nodeEnvironment && config.nodeEnvironment.toLowerCase() !== LOCAL) || (serverSettings.securitySet === SET_ON)) {
         const securityOptions = {

package/lib/common.js

@@ -0,0 +1,7 @@
+const METRICS_ROUTE = '/metrics';
+const HEALTHCHECK_ROUTE = '/healthcheck';
+
+module.exports = {
+  METRICS_ROUTE,
+  HEALTHCHECK_ROUTE,
+};

package/lib/logs.js

@@ -37,7 +37,10 @@ const extractLogs = (config, extractName, options) => (req, res, next) => {
       },
     };
 
-    if (options && options.metrics) opts.metrics = options.metrics;
+    if (options && options.metrics) {
+      opts.metrics = options.metrics;
+      opts.metrics.url = url;
+    }
     rpAuth('mLG', opts)
       .catch((err) => getRichError('System', 'could not send extracted data', { url, extractName }, err, 'warn', correlationId));
     delete req.body[extractName];

package/lib/metrics.js

@@ -1,3 +1,5 @@
+const { HEALTHCHECK_ROUTE, METRICS_ROUTE } = require('./common');
+
 const APIRequestMetrics = (APIRequestDuration, basePath) => (req, res, next) => {
   let apiPath = req.originalUrl;
 
@@ -5,7 +7,7 @@ const APIRequestMetrics = (APIRequestDuration, basePath) => (req, res, next) =>
   const startHrTime = req.metrics ? req.metrics.startHrTime : process.hrtime();
 
   res.on('finish', () => {
-    if (apiPath !== '/metrics' && apiPath !== '/healthcheck') {
+    if (apiPath !== METRICS_ROUTE && apiPath !== HEALTHCHECK_ROUTE) {
       const elapsedHrTime = process.hrtime(startHrTime);
       const elapsedTimeInMs = elapsedHrTime[0] * 1000 + elapsedHrTime[1] / 1e6;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mimik/init",
-  "version": "3.7.4",
+  "version": "3.8.0",
   "description": "Init process for micro-service",
   "main": "index.js",
   "scripts": {
@@ -36,7 +36,8 @@
     "@mimik/request-helper": "^1.7.8",
     "@mimik/response-helper": "^2.6.3",
     "@mimik/sumologic-winston-logger": "^1.6.14",
-    "@mimik/swagger-helper": "^2.5.6",
+    "@mimik/swagger-helper": "^2.5.7",
+    "@mimik/systeminfo": "^2.3.11",
     "bluebird": "3.7.2",
     "cors": "2.8.5",
     "helmet": "6.0.1",
@@ -45,11 +46,11 @@
   "devDependencies": {
     "@mimik/eslint-plugin-dependencies": "^2.4.5",
     "@mimik/eslint-plugin-document-env": "^1.0.5",
-    "eslint": "8.31.0",
+    "eslint": "8.33.0",
     "eslint-config-airbnb": "19.0.4",
-    "eslint-plugin-import": "2.26.0",
-    "eslint-plugin-jsx-a11y": "6.6.1",
-    "eslint-plugin-react": "7.31.11",
+    "eslint-plugin-import": "2.27.5",
+    "eslint-plugin-jsx-a11y": "6.7.1",
+    "eslint-plugin-react": "7.32.2",
     "eslint-plugin-react-hooks": "4.6.0",
     "husky": "8.0.3",
     "jsdoc-to-markdown": "8.0.0"