@mojaloop/central-services-shared 18.30.8 → 18.32.0

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [18.32.0](https://github.com/mojaloop/central-services-shared/compare/v18.31.0...v18.32.0) (2025-09-06)
+
+
+### Features
+
+* add sub service app-critical metrics on healthcheck ([#476](https://github.com/mojaloop/central-services-shared/issues/476)) ([6b57358](https://github.com/mojaloop/central-services-shared/commit/6b57358fa66388c605ba7dd3fb8111f86a6a52fc))
+
+## [18.31.0](https://github.com/mojaloop/central-services-shared/compare/v18.30.8...v18.31.0) (2025-09-05)
+
+
+### Features
+
+* **csi-1713:** add general app-critical metric on healthcheck ([#475](https://github.com/mojaloop/central-services-shared/issues/475)) ([f3c2980](https://github.com/mojaloop/central-services-shared/commit/f3c2980b1f4167bcf0821c8b524651233799e218))
+
 ### [18.30.8](https://github.com/mojaloop/central-services-shared/compare/v18.30.7...v18.30.8) (2025-09-01)
 
 

package/audit-ci.jsonc

@@ -5,6 +5,5 @@
   "moderate": true,
   "allowlist": [ // NOTE: Please add as much information as possible to any items added to the allowList
     // e.g. Currently no fixes available for the following
-    "GHSA-968p-4wvh-cqc8" // https://github.com/advisories/GHSA-968p-4wvh-cqc8
   ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mojaloop/central-services-shared",
-  "version": "18.30.8",
+  "version": "18.32.0",
   "description": "Shared code for mojaloop central services",
   "license": "Apache-2.0",
   "author": "ModusBox",
@@ -74,7 +74,7 @@
     "axios": "1.11.0",
     "clone": "2.1.2",
     "convict": "^6.2.4",
-    "dotenv": "17.2.1",
+    "dotenv": "17.2.2",
     "env-var": "7.5.0",
     "event-stream": "4.0.1",
     "fast-safe-stringify": "2.1.1",
@@ -84,7 +84,7 @@
     "lodash": "4.17.21",
     "mustache": "4.2.0",
     "openapi-backend": "5.15.0",
-    "raw-body": "3.0.0",
+    "raw-body": "3.0.1",
     "rc": "1.2.8",
     "redlock": "5.0.0-beta.2",
     "shins": "2.6.0",
@@ -96,10 +96,10 @@
   "devDependencies": {
     "@mojaloop/central-services-error-handling": "13.1.0",
     "@mojaloop/central-services-logger": "11.9.1",
-    "@mojaloop/central-services-metrics": "12.6.0",
-    "@mojaloop/event-sdk": "14.6.1",
+    "@mojaloop/central-services-metrics": "12.7.1",
+    "@mojaloop/event-sdk": "14.7.0",
     "@mojaloop/sdk-standard-components": "19.16.7",
-    "@opentelemetry/auto-instrumentations-node": "^0.62.1",
+    "@opentelemetry/auto-instrumentations-node": "^0.62.2",
     "@types/hapi__joi": "17.1.15",
     "ajv": "^8.17.1",
     "ajv-formats": "^3.0.1",

package/src/healthCheck/HealthCheck.js

@@ -32,6 +32,7 @@ const {
   statusEnum
 } = require('./HealthCheckEnums')
 const Logger = require('@mojaloop/central-services-logger')
+const Metrics = require('@mojaloop/central-services-metrics')
 
 /**
  * @class HealthCheck
@@ -109,6 +110,9 @@ class HealthCheck {
       subServices = {
         services
       }
+
+      // Set per-subservice metrics
+      this.setSubServiceMetrics(services)
     } catch (err) {
       Logger.isErrorEnabled && Logger.error(`HealthCheck.getSubServiceHealth failed with error: ${err.message}`)
       isHealthy = false
@@ -118,6 +122,13 @@ class HealthCheck {
       status = statusEnum.DOWN
     }
 
+    try {
+      // Set general app-critical metrics
+      this.setGeneralMetrics(isHealthy)
+    } catch (err) {
+      Logger.isErrorEnabled && Logger.error(`Failed to set general app-critical metrics: ${err.message}`)
+    }
+
     return {
       status,
       uptime,
@@ -127,6 +138,35 @@ class HealthCheck {
     }
   }
 
+  setSubServiceMetrics (services) {
+    try {
+      services.forEach(service => {
+        // Counter for subservice critical events
+        if (service.status === statusEnum.DOWN) {
+          const subCounter = Metrics.getCounter(
+            'app_critical_total',
+            'Total times app entered critical health',
+            ['service']
+          )
+          subCounter.inc({ service: service?.name })
+        }
+      })
+    } catch (err) {
+      Logger.isErrorEnabled && Logger.error(`Failed to set subservice metrics: ${err.message}`)
+    }
+  }
+
+  setGeneralMetrics (isHealthy) {
+    try {
+      if (!isHealthy) {
+        const criticalCounter = Metrics.getCounter('app_critical_total', 'Total times app entered critical health', ['service'])
+        criticalCounter.inc({ service: 'general' })
+      }
+    } catch (err) {
+      Logger.isErrorEnabled && Logger.error(`Failed to set app-critical metrics: ${err.message}`)
+    }
+  }
+
   /**
    * @function evaluateServiceHealth
    *

package/test/unit/healthCheck/HealthCheck.test.js

@@ -31,6 +31,7 @@
 const Test = require('tapes')(require('tape'))
 const Sinon = require('sinon')
 const Joi = require('joi')
+const Metrics = require('@mojaloop/central-services-metrics')
 
 const HealthCheck = require('../../../src/healthCheck').HealthCheck
 
@@ -172,5 +173,127 @@ Test('HealthCheck test', healthCheckTest => {
     evaluateServiceHealthTest.end()
   })
 
+  healthCheckTest.test('getHealth metrics', metricsTest => {
+    let metricsMock
+
+    metricsTest.beforeEach(t => {
+      metricsMock = {
+        getCounter: Sinon.stub().returns({ inc: Sinon.spy() })
+      }
+      // Mock Metrics
+      sandbox.stub(Metrics, 'getCounter').callsFake(metricsMock.getCounter)
+      t.end()
+    })
+
+    metricsTest.afterEach(t => {
+      sandbox.restore()
+      t.end()
+    })
+
+    metricsTest.test('increments counter when unhealthy', async test => {
+      // Arrange
+      const healthCheck = new HealthCheck({ version: '1.0.0' }, [
+        async () => ({ status: 'DOWN', name: 'datastore' })
+      ])
+      // Act
+      await healthCheck.getHealth()
+      // Assert
+      test.ok(metricsMock.getCounter.calledWith('app_critical_total'), 'getCounter called')
+      // Subservice counter should be incremented
+      test.deepEqual(metricsMock.getCounter().inc.firstCall.args, [{ service: 'datastore' }], 'counter incremented for datastore service')
+      // General counter should be incremented
+      test.deepEqual(metricsMock.getCounter().inc.secondCall.args, [{ service: 'general' }], 'counter incremented for general service')
+      test.end()
+    })
+
+    metricsTest.test('increments counter for multiple sub-services with mixed health', async test => {
+      // Arrange
+      const healthCheck = new HealthCheck({ version: '1.0.0' }, [
+        async () => ({ status: 'OK', name: 'datastore' }),
+        async () => ({ status: 'DOWN', name: 'broker' }),
+        async () => ({ status: 'OK', name: 'cache' })
+      ])
+      // Act
+      await healthCheck.getHealth()
+      // Assert
+      // Subservice counter incremented for DOWN service
+      test.deepEqual(metricsMock.getCounter().inc.firstCall.args, [{ service: 'broker' }], 'counter incremented for broker')
+      // General counter incremented
+      test.deepEqual(metricsMock.getCounter().inc.secondCall.args, [{ service: 'general' }], 'counter incremented for general service')
+      test.equal(metricsMock.getCounter().inc.callCount, 2, 'getCounter.inc called for each DOWN service and general')
+      test.end()
+    })
+
+    metricsTest.test('handles errors thrown in setGeneralMetrics gracefully', async test => {
+      // Arrange
+      const healthCheck = new HealthCheck({ version: '1.0.0' }, [
+        async () => ({ status: 'OK', name: 'datastore' })
+      ])
+      // Patch setGeneralMetrics to throw
+      const origSetGeneralMetrics = healthCheck.setGeneralMetrics
+      healthCheck.setGeneralMetrics = () => { throw new Error('General metrics error') }
+      // Act & Assert
+      try {
+        await healthCheck.getHealth()
+        test.pass('No error thrown when setGeneralMetrics throws')
+      } catch (err) {
+        test.fail('Should not throw when setGeneralMetrics throws')
+      }
+      // Restore
+      healthCheck.setGeneralMetrics = origSetGeneralMetrics
+      test.end()
+    })
+
+    metricsTest.test('does not call getCounter if no subservice is DOWN', async test => {
+      // Arrange
+      const healthCheck = new HealthCheck({ version: '1.0.0' }, [
+        async () => ({ status: 'OK', name: 'datastore' }),
+        async () => ({ status: 'OK', name: 'broker' })
+      ])
+      // Act
+      await healthCheck.getHealth()
+      // Assert
+      test.equal(metricsMock.getCounter().inc.callCount, 0, 'getCounter.inc not called when all services are healthy')
+      test.end()
+    })
+
+    metricsTest.test('calls getCounter only for DOWN subservices', async test => {
+      // Arrange
+      const healthCheck = new HealthCheck({ version: '1.0.0' }, [
+        async () => ({ status: 'DOWN', name: 'datastore' }),
+        async () => ({ status: 'OK', name: 'broker' }),
+        async () => ({ status: 'DOWN', name: 'cache' })
+      ])
+      // Act
+      await healthCheck.getHealth()
+      // Assert
+      test.deepEqual(metricsMock.getCounter().inc.getCall(0).args, [{ service: 'datastore' }], 'counter incremented for datastore')
+      test.deepEqual(metricsMock.getCounter().inc.getCall(1).args, [{ service: 'cache' }], 'counter incremented for cache')
+      test.deepEqual(metricsMock.getCounter().inc.getCall(2).args, [{ service: 'general' }], 'counter incremented for general')
+      test.equal(metricsMock.getCounter().inc.callCount, 3, 'getCounter.inc called for each DOWN service and general')
+      test.end()
+    })
+
+    metricsTest.test('handles errors thrown in setSubServiceMetrics gracefully', async test => {
+      // Arrange
+      const healthCheck = new HealthCheck({ version: '1.0.0' }, [
+        async () => ({ status: 'DOWN', name: 'datastore' })
+      ])
+      // Stub Metrics.getCounter to throw when called
+      sandbox.restore() // Remove previous stubs
+      const getCounterStub = sandbox.stub(Metrics, 'getCounter').throws(new Error('Subservice metrics error'))
+      // Stub Logger.error to spy on error logging
+      const loggerErrorStub = sandbox.stub(require('@mojaloop/central-services-logger'), 'error')
+      // Act
+      await healthCheck.getHealth()
+      // Assert
+      test.ok(getCounterStub.called, 'getCounter called and throws')
+      test.ok(loggerErrorStub.called, 'Logger.error called when setSubServiceMetrics throws')
+      test.ok(loggerErrorStub.firstCall.args[0].includes('Failed to set subservice metrics'), 'Correct error message logged')
+      loggerErrorStub.restore()
+      test.end()
+    })
+    metricsTest.end()
+  })
   healthCheckTest.end()
 })