healthcheck improvements (#38)

2026-01-25 02:07:59 +00:00 · 2022-04-12 15:45:33 -04:00
parent 0c8967acdb
commit e4ed2cea26
5 changed files with 68 additions and 18 deletions
--- a/app.js
+++ b/app.js
@@ -11,7 +11,7 @@ assert.ok(process.env.JAMBONES_NETWORK_CIDR || process.env.K8S, 'missing JAMBONE
 const Srf = require('drachtio-srf');
 const srf = new Srf('sbc-outbound');
 const CIDRMatcher = require('cidr-matcher');
-const {pingMsTeamsGateways, equalsIgnoreOrder} = require('./lib/utils');
+const {equalsIgnoreOrder, pingMsTeamsGateways, createHealthCheckApp, systemHealth} = require('./lib/utils');
 const opts = Object.assign({
  timestamp: () => {return `, "time": "${new Date().toISOString()}"`;}
 }, {level: process.env.JAMBONES_LOGLEVEL || 'info'});
@@ -32,6 +32,7 @@ const CallSession = require('./lib/call-session');
 const setNameRtp = `${(process.env.JAMBONES_CLUSTER_ID || 'default')}:active-rtp`;
 const rtpServers = [];
 const {
+  ping,
  performLcr,
  lookupAllTeamsFQDNs,
  lookupAccountBySipRealm,
@@ -47,6 +48,7 @@ const {
  connectionLimit: process.env.JAMBONES_MYSQL_CONNECTION_LIMIT || 10
 }, logger);
 const {
+  client: redisClient,
  createHash,
  retrieveHash,
  incrKey,
@@ -68,6 +70,7 @@ srf.locals = {...srf.locals,
  queryCdrs,
  activeCallIds,
  dbHelpers: {
+    ping,
    performLcr,
    lookupAllTeamsFQDNs,
    lookupAccountBySipRealm,
@@ -137,13 +140,32 @@ srf.invite((req, res) => {
  session.connect();
 });

-if (process.env.K8S) {
+if (process.env.K8S || process.env.HTTP_PORT) {
  const PORT = process.env.HTTP_PORT || 3000;
-  const getCount = () => activeCallIds.size;
  const healthCheck = require('@jambonz/http-health-check');
-  healthCheck({port: PORT, logger, path: '/', fn: getCount});
-}

+  const getCount = () => srf.locals.activeCallIds.size;
+
+  createHealthCheckApp(PORT, logger)
+    .then((app) => {
+      healthCheck({
+        app,
+        logger,
+        path: '/',
+        fn: getCount
+      });
+      healthCheck({
+        app,
+        logger,
+        path: '/system-health',
+        fn: systemHealth.bind(null, redisClient, ping, getCount)
+      });
+      return;
+    })
+    .catch((err) => {
+      logger.error({err}, 'Error creating health check server');
+    });
+}
 if ('test' !== process.env.NODE_ENV) {
  /* update call stats periodically */
  setInterval(() => {
--- a/lib/utils.js
+++ b/lib/utils.js
@@ -84,10 +84,32 @@ const equalsIgnoreOrder = (a, b) => {
  return true;
 };

+const  systemHealth = async(redisClient, ping, getCount) => {
+  await Promise.all([redisClient.ping(), ping()]);
+  return getCount();
+};
+
+const createHealthCheckApp = (port, logger) => {
+  const express = require('express');
+  const app = express();
+
+  app.use(express.urlencoded({ extended: true }));
+  app.use(express.json());
+
+  return new Promise((resolve) => {
+    app.listen(port, () => {
+      logger.info(`Health check server started at http://localhost:${port}`);
+      resolve(app);
+    });
+  });
+};
+
 module.exports = {
  makeRtpEngineOpts,
  selectHostPort,
  pingMsTeamsGateways,
  makeCallCountKey,
-  equalsIgnoreOrder
+  equalsIgnoreOrder,
+  systemHealth,
+  createHealthCheckApp
 };
--- a/package-lock.json
+++ b/package-lock.json
@@ -1,15 +1,15 @@
 {
  "name": "sbc-outbound",
-  "version": "v0.7.4",
+  "version": "v0.7.5",
  "lockfileVersion": 2,
  "requires": true,
  "packages": {
    "": {
      "name": "sbc-outbound",
-      "version": "v0.7.4",
+      "version": "v0.7.5",
      "license": "MIT",
      "dependencies": {
-        "@jambonz/db-helpers": "^0.6.17",
+        "@jambonz/db-helpers": "^0.6.18",
        "@jambonz/http-health-check": "^0.0.1",
        "@jambonz/mw-registrar": "0.2.2",
        "@jambonz/realtimedb-helpers": "^0.4.24",
@@ -1375,9 +1375,9 @@
      }
    },
    "node_modules/@jambonz/db-helpers": {
-      "version": "0.6.17",
-      "resolved": "https://registry.npmjs.org/@jambonz/db-helpers/-/db-helpers-0.6.17.tgz",
-      "integrity": "sha512-3L5F6SFVpjn59CO23MpqMydTy1ox2FRe/kry9Zfv8kjTNTSMmfn01c51hjoXcX1v2kdx61qkGvCN6pHlc2LoSQ==",
+      "version": "0.6.18",
+      "resolved": "https://registry.npmjs.org/@jambonz/db-helpers/-/db-helpers-0.6.18.tgz",
+      "integrity": "sha512-9wTkOxqIbNd95+0yznGFPPTRih/xPRnX7ajrJMxzKqzzHQ/CUQgOfjfGcxmOBx3UxaWBmxyHQeYA3oZMPPyX+Q==",
      "dependencies": {
        "cidr-matcher": "^2.1.1",
        "debug": "^4.3.3",
@@ -6808,9 +6808,9 @@
      "dev": true
    },
    "@jambonz/db-helpers": {
-      "version": "0.6.17",
-      "resolved": "https://registry.npmjs.org/@jambonz/db-helpers/-/db-helpers-0.6.17.tgz",
-      "integrity": "sha512-3L5F6SFVpjn59CO23MpqMydTy1ox2FRe/kry9Zfv8kjTNTSMmfn01c51hjoXcX1v2kdx61qkGvCN6pHlc2LoSQ==",
+      "version": "0.6.18",
+      "resolved": "https://registry.npmjs.org/@jambonz/db-helpers/-/db-helpers-0.6.18.tgz",
+      "integrity": "sha512-9wTkOxqIbNd95+0yznGFPPTRih/xPRnX7ajrJMxzKqzzHQ/CUQgOfjfGcxmOBx3UxaWBmxyHQeYA3oZMPPyX+Q==",
      "requires": {
        "cidr-matcher": "^2.1.1",
        "debug": "^4.3.3",
--- a/package.json
+++ b/package.json
@@ -22,12 +22,12 @@
  "description": "jambonz session border controller application for outbound calls",
  "scripts": {
    "start": "node app",
-    "test": "NODE_ENV=test JAMBONZ_HOSTING=1 JAMBONES_NETWORK_CIDR=127.0.0.1/32 JAMBONES_MYSQL_HOST=127.0.0.1 JAMBONES_MYSQL_USER=jambones_test JAMBONES_MYSQL_PASSWORD=jambones_test JAMBONES_MYSQL_DATABASE=jambones_test JAMBONES_REDIS_HOST=localhost JAMBONES_REDIS_PORT=16379 JAMBONES_TIME_SERIES_HOST=127.0.0.1 JAMBONES_LOGLEVEL=error DRACHTIO_SECRET=cymru DRACHTIO_HOST=127.0.0.1 DRACHTIO_PORT=9060 JAMBONES_RTPENGINES=127.0.0.1:12222 node test/ ",
+    "test": "NODE_ENV=test HTTP_PORT=3050 JAMBONZ_HOSTING=1 JAMBONES_NETWORK_CIDR=127.0.0.1/32 JAMBONES_MYSQL_HOST=127.0.0.1 JAMBONES_MYSQL_USER=jambones_test JAMBONES_MYSQL_PASSWORD=jambones_test JAMBONES_MYSQL_DATABASE=jambones_test JAMBONES_REDIS_HOST=localhost JAMBONES_REDIS_PORT=16379 JAMBONES_TIME_SERIES_HOST=127.0.0.1 JAMBONES_LOGLEVEL=error DRACHTIO_SECRET=cymru DRACHTIO_HOST=127.0.0.1 DRACHTIO_PORT=9060 JAMBONES_RTPENGINES=127.0.0.1:12222 node test/ ",
    "coverage": "./node_modules/.bin/nyc --reporter html --report-dir ./coverage npm run test",
    "jslint": "eslint app.js lib"
  },
  "dependencies": {
-    "@jambonz/db-helpers": "^0.6.17",
+    "@jambonz/db-helpers": "^0.6.18",
    "@jambonz/http-health-check": "^0.0.1",
    "@jambonz/mw-registrar": "0.2.2",
    "@jambonz/realtimedb-helpers": "^0.4.24",
--- a/test/sip-tests.js
+++ b/test/sip-tests.js
@@ -2,7 +2,8 @@ const test = require('tape');
 const { output, sippUac } = require('./sipp')('test_sbc-outbound');
 const {execSync} = require('child_process');
 const debug = require('debug')('jambonz:sbc-outbound');
-const consoleLogger = {error: console.error, info: console.log, debug: console.log};
+const bent = require('bent');
+const getJSON = bent('json');

 process.on('unhandledRejection', (reason, p) => {
  console.log('Unhandled Rejection at: Promise', p, 'reason:', reason);
@@ -29,6 +30,11 @@ test('sbc-outbound tests', async(t) => {
  try {
    await connect(srf);
  
+    let obj = await getJSON('http://127.0.0.1:3050/');
+    t.ok(obj.calls === 0, 'HTTP GET / works (current call count)')
+    obj = await getJSON('http://127.0.0.1:3050/system-health');
+    t.ok(obj.calls === 0, 'HTTP GET /system-health works (health check)')
+
    /* call to unregistered user */
    debug('successfully connected to drachtio server');
    await sippUac('uac-pcap-device-404.xml');