@mojaloop/central-services-shared 18.30.8 → 18.31.0

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 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.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.31.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.0",
+    "@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
@@ -118,6 +119,20 @@ class HealthCheck {
       status = statusEnum.DOWN
     }
 
+    try {
+      const metrics = Metrics.getInstance ? Metrics.getInstance() : Metrics
+      if (metrics && typeof metrics.getGauge === 'function') {
+        const criticalGauge = metrics.getGauge('app-critical', 'App critical health status: 1=critical, 0=not critical', ['general'])
+        criticalGauge.set(isHealthy ? 0 : 1)
+      }
+      if (!isHealthy && metrics && typeof metrics.getCounter === 'function') {
+        const criticalCounter = metrics.getCounter('app-critical-total', 'Total times app entered critical health', ['general'])
+        criticalCounter.inc()
+      }
+    } catch (err) {
+      Logger.isErrorEnabled && Logger.error(`Failed to set app-critical metrics: ${err.message}`)
+    }
+
     return {
       status,
       uptime,

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,54 @@ Test('HealthCheck test', healthCheckTest => {
     evaluateServiceHealthTest.end()
   })
 
+  healthCheckTest.test('getHealth metrics', metricsTest => {
+    let metricsMock
+
+    metricsTest.beforeEach(t => {
+      metricsMock = {
+        getGauge: Sinon.stub().returns({ set: Sinon.spy() }),
+        getCounter: Sinon.stub().returns({ inc: Sinon.spy() })
+      }
+      // Mock Metrics
+      sandbox.stub(Metrics, 'getGauge').callsFake(metricsMock.getGauge)
+      sandbox.stub(Metrics, 'getCounter').callsFake(metricsMock.getCounter)
+      t.end()
+    })
+
+    metricsTest.afterEach(t => {
+      sandbox.restore()
+      t.end()
+    })
+
+    metricsTest.test('sets app-critical gauge to 0 when healthy', async test => {
+      // Arrange
+      const healthCheck = new HealthCheck({ version: '1.0.0' }, [
+        async () => ({ status: 'OK', name: 'datastore' })
+      ])
+      // Act
+      await healthCheck.getHealth()
+      // Assert
+      test.ok(metricsMock.getGauge.calledWith('app-critical'), 'getGauge called')
+      test.equal(metricsMock.getGauge().set.firstCall.args[0], 0, 'gauge set to 0')
+      test.end()
+    })
+
+    metricsTest.test('sets app-critical gauge to 1 and 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.getGauge.calledWith('app-critical'), 'getGauge called')
+      test.equal(metricsMock.getGauge().set.firstCall.args[0], 1, 'gauge set to 1')
+      test.ok(metricsMock.getCounter.calledWith('app-critical-total'), 'getCounter called')
+      test.ok(metricsMock.getCounter().inc.calledOnce, 'counter incremented')
+      test.end()
+    })
+
+    metricsTest.end()
+  })
   healthCheckTest.end()
 })