@mimik/init 3.6.2 → 3.7.1

package/README.md

@@ -23,6 +23,7 @@ The  secOptions has the following structure:
    exitOps: [function], // functions to process before exiting the micro-service
    secOptions: { securityDefinition: function }, // extra security options to validate the API request
    extractName: string, // ability to extract data from the req and send it to a logging environment
+   metrics: object, // to genetrate information for `/metrics`
  }
 ```
 The `return` object has the following strucuture:

package/index.js

@@ -13,9 +13,12 @@ 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 SIGINT = 'SIGINT';
 const SIGTERM = 'SIGTERM';
+const LOCAL = 'local';
+const SET_ON = 'on';
 
 /**
  * @module ini
@@ -44,6 +47,7 @@ const SIGTERM = 'SIGTERM';
  *    exitOps: [function], // functions to process before exiting the micro-service
  *    secOptions: { securityDefinition: function }, // extra security options to validate the API request
  *    extractName: string, // ability to extract data from the req and send it to a logging environment
+ *    metrics: object, // to genetrate information for `/metrics`
  *  }
  *```
  * The `return` object has the following strucuture:
@@ -104,10 +108,14 @@ module.exports = (app, rootDir, config, validates, cluster, options) => {
   return swagger.getAPIFile(swaggerFilename, correlationIdStart)
     .then((swaggerJson) => swaggerTools.initializeMiddleware(swaggerJson, (middleware) => {
       serverSettings.basePath = swaggerJson.basePath;
-      app.use(cors({ origin: '*' }));
+      app.use(startHrTimeSet());
       app.use(middleware.swaggerMetadata());
+      if (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 === 'on')) {
+      if ((config.nodeEnvironment && config.nodeEnvironment.toLowerCase() !== LOCAL) || (serverSettings.securitySet === SET_ON)) {
         const securityOptions = {
           AdminSecurity: oauth.apiTokenAdminSecurityHelper,
           SystemSecurity: oauth.apiTokenSecurityHelper,
@@ -123,7 +131,7 @@ module.exports = (app, rootDir, config, validates, cluster, options) => {
         app.use(middleware.swaggerSecurity(securityOptions));
       }
       else logger.warn('security disabled: tokens will not be used and /me and /onbehalf will not work', correlationIdStart);
-      if ((config.nodeEnvironment && config.nodeEnvironment.toLowerCase() !== 'local') || (config.registration.set === 'on')) {
+      if ((config.nodeEnvironment && config.nodeEnvironment.toLowerCase() !== LOCAL) || (config.registration.set === SET_ON)) {
         registration = true;
       }
       else logger.warn('registration disabled: cluster will not work', correlationIdStart);
@@ -131,12 +139,12 @@ module.exports = (app, rootDir, config, validates, cluster, options) => {
         app.use(extractLogs(config, extractName));
       }
       app.use(middleware.swaggerRouter({
-        useStubs: config.nodeEnvironment === 'local',
+        useStubs: config.nodeEnvironment === LOCAL,
         controllers: `${rootDir}/controllers`,
       }));
       app.use(middleware.swaggerUi());
       app.use(swagger.sendError);
-      if (serverSettings.interceptError === 'on') {
+      if (serverSettings.interceptError === SET_ON) {
         app.use(swagger.interceptError);
       }
       return Promise.each(validates, (validate) => validate())

package/lib/metrics.js

@@ -0,0 +1,28 @@
+const APIRequestMetrics = (APIRequestDuration, basePath) => (req, res, next) => {
+  let apiPath = req.originalUrl;
+
+  if (req.swagger) apiPath = req.swagger.apiPath;
+  const startHrTime = req.metrics ? req.metrics.startHrTime : process.hrtime();
+
+  res.on('finish', () => {
+    if (apiPath !== '/metrics' && apiPath !== '/healthcheck') {
+      const elapsedHrTime = process.hrtime(startHrTime);
+      const elapsedTimeInMs = elapsedHrTime[0] * 1000 + elapsedHrTime[1] / 1e6;
+
+      APIRequestDuration
+        .labels(req.method, `${basePath}${apiPath}`, req.originalUrl.includes('?'), res.statusCode)
+        .observe(elapsedTimeInMs);
+    }
+  });
+  next();
+};
+
+const startHrTimeSet = () => (req, res, next) => {
+  req.metrics = { startHrTime: process.hrtime() };
+  next();
+};
+
+module.exports = {
+  startHrTimeSet,
+  APIRequestMetrics,
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mimik/init",
-  "version": "3.6.2",
+  "version": "3.7.1",
   "description": "Init process for micro-service",
   "main": "index.js",
   "scripts": {
@@ -29,23 +29,23 @@
     "url": "https://bitbucket.org/mimiktech/init"
   },
   "dependencies": {
-    "@mimik/address-helper": "^1.6.5",
-    "@mimik/healthcheck": "^1.5.9",
-    "@mimik/oauth-helper": "^1.10.2",
-    "@mimik/public-helper": "^1.5.6",
-    "@mimik/request-helper": "^1.7.7",
-    "@mimik/response-helper": "^2.6.2",
-    "@mimik/sumologic-winston-logger": "^1.6.11",
-    "@mimik/swagger-helper": "^2.5.5",
+    "@mimik/address-helper": "^1.6.6",
+    "@mimik/healthcheck": "^1.5.10",
+    "@mimik/oauth-helper": "^2.0.2",
+    "@mimik/public-helper": "^1.6.1",
+    "@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",
     "bluebird": "3.7.2",
     "cors": "2.8.5",
     "helmet": "6.0.1",
     "swagger-tools": "0.10.4"
   },
   "devDependencies": {
-    "@mimik/eslint-plugin-dependencies": "^2.4.4",
-    "@mimik/eslint-plugin-document-env": "^1.0.4",
-    "eslint": "8.28.0",
+    "@mimik/eslint-plugin-dependencies": "^2.4.5",
+    "@mimik/eslint-plugin-document-env": "^1.0.5",
+    "eslint": "8.30.0",
     "eslint-config-airbnb": "19.0.4",
     "eslint-plugin-import": "2.26.0",
     "eslint-plugin-jsx-a11y": "6.6.1",