feat(mojaloop/#3432): add metrics for quote handlers and models

config/default.json

@@ -53,5 +53,20 @@
       "JWS_SIGNING_KEY_PATH": "secrets/jwsSigningKey.key"
     }
   },
-  "API_DOCUMENTATION_ENDPOINTS": true
+  "API_DOCUMENTATION_ENDPOINTS": true,
+  "INSTRUMENTATION": {
+    "METRICS": {
+      "DISABLED": false,
+      "labels": {
+        "fspId": "*"
+      },
+      "config": {
+        "timeout": 5000,
+        "prefix": "moja_qs_",
+        "defaultLabels": {
+          "serviceName": "quoting-service"
+        }
+      }
+    }
+  }
 }

docker-compose.base.yml

@@ -26,7 +26,7 @@ services:
     volumes:
       # override the default values with our own - this is because the KAFKA_HOST env variable is ignored for some reason
       - ./docker/ml-api-adapter/default.json:/opt/app/config/default.json
-    
+
     # TODO: we should be able to remove this - I think the image command is broken
     command:
       - "node"
@@ -64,12 +64,10 @@ services:
       - /opt/wait-for-mockserver.sh
     environment:
       - MOCK_HOST=mockserver
-  
+
   kafka:
     image: docker.io/bitnami/kafka:3.5
     container_name: cl_kafka
-    networks:
-      - cl-mojaloop-net
     ports:
       - "9092:9092"
     environment:
@@ -97,8 +95,6 @@ services:
 
   init-kafka:
     container_name: cl_init_kafka
-    networks:
-      - cl-mojaloop-net
     image: docker.io/bitnami/kafka:3.5
     depends_on:
       - kafka

package.json

@@ -85,19 +85,19 @@
     "@mojaloop/central-services-error-handling": "12.0.7",
     "@mojaloop/central-services-health": "14.0.2",
     "@mojaloop/central-services-logger": "11.2.2",
-    "@mojaloop/central-services-metrics": "12.0.8",
-    "@mojaloop/central-services-shared": "18.1.0",
-    "@mojaloop/event-sdk": "12.0.2",
+    "@mojaloop/central-services-metrics": "^12.0.8",
+    "@mojaloop/central-services-shared": "18.1.2",
+    "@mojaloop/event-sdk": "13.0.0",
     "@mojaloop/ml-number": "11.2.3",
     "@mojaloop/sdk-standard-components": "17.1.3",
     "ajv": "8.12.0",
     "ajv-keywords": "5.1.0",
-    "axios": "1.5.0",
+    "axios": "1.5.1",
     "blipp": "4.0.2",
     "event-stream": "4.0.1",
     "good-console": "8.0.0",
     "good-squeeze": "5.1.0",
-    "joi": "17.10.1",
+    "joi": "17.10.2",
     "json-rules-engine": "5.0.2",
     "knex": "2.5.1",
     "memory-cache": "0.2.0",
@@ -111,14 +111,14 @@
     "audit-ci": "^6.6.1",
     "eslint": "8.16.0",
     "eslint-config-standard": "17.1.0",
-    "jest": "29.6.4",
+    "jest": "29.7.0",
     "jest-junit": "16.0.0",
-    "npm-check-updates": "16.13.2",
+    "npm-check-updates": "16.14.4",
     "nyc": "15.1.0",
     "pre-commit": "1.2.2",
     "proxyquire": "2.1.3",
     "replace": "^1.2.2",
-    "sinon": "15.2.0",
+    "sinon": "16.0.0",
     "standard": "17.1.0",
     "standard-version": "9.5.0",
     "swagmock": "1.0.0"

src/handlers/bulkQuotes.js

@@ -39,6 +39,7 @@ const ErrorHandler = require('@mojaloop/central-services-error-handling')
 const EventSdk = require('@mojaloop/event-sdk')
 const LibUtil = require('../lib/util')
 const BulkQuotesModel = require('../model/bulkQuotes')
+const Metrics = require('@mojaloop/central-services-metrics')
 
 /**
  * Operations on /bulkQuotes
@@ -52,6 +53,11 @@ module.exports = {
      * responses: 202, 400, 401, 403, 404, 405, 406, 501, 503
      */
   post: async function BulkQuotes (context, request, h) {
+    const histTimerEnd = Metrics.getHistogram(
+      'bulkQuotes_post',
+      'Process HTTP POST bulkQuotes request',
+      ['success']
+    ).startTimer()
     // log request
     request.server.log(['info'], `got a POST /bulkQuotes request: ${util.inspect(request.payload)}`)
 
@@ -79,11 +85,13 @@ module.exports = {
       model.handleBulkQuoteRequest(request.headers, request.payload, span).catch(err => {
         request.server.log(['error'], `ERROR - handleBulkQuoteRequest: ${LibUtil.getStackOrInspect(err)}`)
       })
+      histTimerEnd({ success: true })
     } catch (err) {
       // something went wrong, use the model to handle the error in a sensible way
       request.server.log(['error'], `ERROR - POST /bulkQuotes: ${LibUtil.getStackOrInspect(err)}`)
       const fspiopError = ErrorHandler.ReformatFSPIOPError(err)
       model.handleException(fspiopSource, bulkQuoteId, fspiopError, request.headers, span)
+      histTimerEnd({ success: false })
     } finally {
       // eslint-disable-next-line no-unsafe-finally
       return h.response().code(Enum.Http.ReturnCodes.ACCEPTED.CODE)

src/handlers/bulkQuotes/{id}.js

@@ -37,6 +37,8 @@ const Enum = require('@mojaloop/central-services-shared').Enum
 const EventSdk = require('@mojaloop/event-sdk')
 const LibUtil = require('../../lib/util')
 const BulkQuotesModel = require('../../model/bulkQuotes.js')
+const Metrics = require('@mojaloop/central-services-metrics')
+
 /**
  * Operations on /bulkQuotes/{id}
  */
@@ -49,6 +51,11 @@ module.exports = {
      * responses: 202, 400, 401, 403, 404, 405, 406, 501, 503
      */
   get: async function getBulkQuotesById (context, request, h) {
+    const histTimerEnd = Metrics.getHistogram(
+      'quotes_id_get',
+      'Process HTTP GET /bulkQuotes/{id} request',
+      ['success']
+    ).startTimer()
     // log request
     request.server.log(['info'], `got a GET /bulkQuotes/{id} request for bulkQuoteId ${request.params.id}`)
 
@@ -77,10 +84,12 @@ module.exports = {
       model.handleBulkQuoteGet(request.headers, bulkQuoteId, span).catch(err => {
         request.server.log(['error'], `ERROR - handleBulkQuoteGet: ${LibUtil.getStackOrInspect(err)}`)
       })
+      histTimerEnd({ success: true })
     } catch (err) {
       // something went wrong, use the model to handle the error in a sensible way
       request.server.log(['error'], `ERROR - GET /bulkQuotes/{id}: ${LibUtil.getStackOrInspect(err)}`)
       model.handleException(fspiopSource, bulkQuoteId, err, request.headers, span)
+      histTimerEnd({ success: false })
     } finally {
       // eslint-disable-next-line no-unsafe-finally
       return h.response().code(Enum.Http.ReturnCodes.ACCEPTED.CODE)
@@ -94,6 +103,11 @@ module.exports = {
      * responses: 200, 400, 401, 403, 404, 405, 406, 501, 503
      */
   put: async function putBulkQuotesById (context, request, h) {
+    const histTimerEnd = Metrics.getHistogram(
+      'quotes_id_get',
+      'Process HTTP PUT /bulkQuotes/{id} request',
+      ['success']
+    ).startTimer()
     // log request
     request.server.log(['info'], `got a PUT /bulkQuotes/{id} request: ${util.inspect(request.payload)}`)
 
@@ -120,10 +134,12 @@ module.exports = {
       model.handleBulkQuoteUpdate(request.headers, bulkQuoteId, request.payload, span).catch(err => {
         request.server.log(['error'], `ERROR - handleBulkQuoteUpdate: ${LibUtil.getStackOrInspect(err)}`)
       })
+      histTimerEnd({ success: true })
     } catch (err) {
       // something went wrong, use the model to handle the error in a sensible way
       request.server.log(['error'], `ERROR - PUT /bulkQuotes/{id}: ${LibUtil.getStackOrInspect(err)}`)
       model.handleException(fspiopSource, bulkQuoteId, err, request.headers, span)
+      histTimerEnd({ success: false })
     } finally {
       // eslint-disable-next-line no-unsafe-finally
       return h.response().code(Enum.Http.ReturnCodes.OK.CODE)

src/handlers/bulkQuotes/{id}/error.js

@@ -37,6 +37,8 @@ const Enum = require('@mojaloop/central-services-shared').Enum
 const EventSdk = require('@mojaloop/event-sdk')
 const LibUtil = require('../../../lib/util')
 const BulkQuotesModel = require('../../../model/bulkQuotes')
+const Metrics = require('@mojaloop/central-services-metrics')
+
 /**
  * Operations on /bulkQuotes/{id}/error
  */
@@ -49,6 +51,11 @@ module.exports = {
      * responses: 200, 400, 401, 403, 404, 405, 406, 501, 503
      */
   put: async function BulkQuotesErrorById (context, request, h) {
+    const histTimerEnd = Metrics.getHistogram(
+      'quotes_id_get',
+      'Process HTTP PUT /bulkQuotes/{id}/error request',
+      ['success']
+    ).startTimer()
     // log request
     request.server.log(['info'], `got a PUT /bulkQuotes/{id}/error request: ${util.inspect(request.payload)}`)
 
@@ -75,10 +82,12 @@ module.exports = {
       model.handleBulkQuoteError(request.headers, bulkQuoteId, request.payload.errorInformation, span).catch(err => {
         request.server.log(['error'], `ERROR - handleBulkQuoteError: ${LibUtil.getStackOrInspect(err)}`)
       })
+      histTimerEnd({ success: true })
     } catch (err) {
       // something went wrong, use the model to handle the error in a sensible way
       request.server.log(['error'], `ERROR - PUT /bulkQuotes/{id}/error: ${LibUtil.getStackOrInspect(err)}`)
       model.handleException(fspiopSource, bulkQuoteId, err, request.headers)
+      histTimerEnd({ success: false })
     } finally {
       // eslint-disable-next-line no-unsafe-finally
       return h.response().code(Enum.Http.ReturnCodes.OK.CODE)

src/handlers/index.js

@@ -33,9 +33,11 @@ const health = require('./health')
 const bulkQuotes = require('./bulkQuotes')
 const bulkQuotesById = require('./bulkQuotes/{id}')
 const bulkQuotesErrorById = require('./bulkQuotes/{id}/error')
+const metrics = require('./metrics')
 
 module.exports = {
   HealthGet: health.get,
+  MetricsGet: metrics.get,
   QuotesErrorByIDPut: quotesErrorByID.put,
   QuotesByIdGet: quotesById.get,
   QuotesByIdPut: quotesById.put,

src/handlers/metrics.js

@@ -0,0 +1,9 @@
+'use strict'
+
+const Metrics = require('@mojaloop/central-services-metrics')
+
+module.exports = {
+  get: async (context, request, h) => {
+    return h.response(await Metrics.getMetricsForPrometheus()).code(200)
+  }
+}

src/handlers/quotes.js

@@ -39,6 +39,7 @@ const ErrorHandler = require('@mojaloop/central-services-error-handling')
 const EventSdk = require('@mojaloop/event-sdk')
 const LibUtil = require('../lib/util')
 const QuotesModel = require('../model/quotes')
+const Metrics = require('@mojaloop/central-services-metrics')
 
 /**
  * Operations on /quotes
@@ -52,6 +53,11 @@ module.exports = {
      * responses: 202, 400, 401, 403, 404, 405, 406, 501, 503
      */
   post: async function Quotes (context, request, h) {
+    const histTimerEnd = Metrics.getHistogram(
+      'quotes_post',
+      'Process HTTP POST quotes request',
+      ['success']
+    ).startTimer()
     // log request
     request.server.log(['info'], `got a POST /quotes request: ${util.inspect(request.payload)}`)
 
@@ -79,11 +85,13 @@ module.exports = {
       model.handleQuoteRequest(request.headers, request.payload, span).catch(err => {
         request.server.log(['error'], `ERROR - handleQuoteRequest: ${LibUtil.getStackOrInspect(err)}`)
       })
+      histTimerEnd({ success: true })
     } catch (err) {
       // something went wrong, use the model to handle the error in a sensible way
       request.server.log(['error'], `ERROR - POST /quotes: ${LibUtil.getStackOrInspect(err)}`)
       const fspiopError = ErrorHandler.ReformatFSPIOPError(err)
       model.handleException(fspiopSource, quoteId, fspiopError, request.headers, span)
+      histTimerEnd({ success: false })
     } finally {
       // eslint-disable-next-line no-unsafe-finally
       return h.response().code(Enum.Http.ReturnCodes.ACCEPTED.CODE)

src/handlers/quotes/{id}.js

@@ -38,6 +38,7 @@ const Enum = require('@mojaloop/central-services-shared').Enum
 const EventSdk = require('@mojaloop/event-sdk')
 const LibUtil = require('../../lib/util')
 const QuotesModel = require('../../model/quotes.js')
+const Metrics = require('@mojaloop/central-services-metrics')
 
 /**
  * Operations on /quotes/{id}
@@ -51,6 +52,11 @@ module.exports = {
      * responses: 202, 400, 401, 403, 404, 405, 406, 501, 503
      */
   get: async function getQuotesById (context, request, h) {
+    const histTimerEnd = Metrics.getHistogram(
+      'quotes_id_get',
+      'Process HTTP GET /quotes/{id} request',
+      ['success']
+    ).startTimer()
     // log request
     request.server.log(['info'], `got a GET /quotes/{id} request for quoteId ${request.params.id}`)
 
@@ -79,10 +85,12 @@ module.exports = {
       model.handleQuoteGet(request.headers, quoteId, span).catch(err => {
         request.server.log(['error'], `ERROR - handleQuoteGet: ${LibUtil.getStackOrInspect(err)}`)
       })
+      histTimerEnd({ success: true })
     } catch (err) {
       // something went wrong, use the model to handle the error in a sensible way
       request.server.log(['error'], `ERROR - GET /quotes/{id}: ${LibUtil.getStackOrInspect(err)}`)
       model.handleException(fspiopSource, quoteId, err, request.headers, span)
+      histTimerEnd({ success: false })
     } finally {
       // eslint-disable-next-line no-unsafe-finally
       return h.response().code(Enum.Http.ReturnCodes.ACCEPTED.CODE)
@@ -97,6 +105,11 @@ module.exports = {
      * responses: 200, 400, 401, 403, 404, 405, 406, 501, 503
      */
   put: async function putQuotesById (context, request, h) {
+    const histTimerEnd = Metrics.getHistogram(
+      'quotes_id_put',
+      'Process HTTP PUT /quotes/{id} request',
+      ['success']
+    ).startTimer()
     // log request
     request.server.log(['info'], `got a PUT /quotes/{id} request: ${util.inspect(request.payload)}`)
 
@@ -123,10 +136,12 @@ module.exports = {
       model.handleQuoteUpdate(request.headers, quoteId, request.payload, span).catch(err => {
         request.server.log(['error'], `ERROR - handleQuoteUpdate: ${LibUtil.getStackOrInspect(err)}`)
       })
+      histTimerEnd({ success: true })
     } catch (err) {
       // something went wrong, use the model to handle the error in a sensible way
       request.server.log(['error'], `ERROR - PUT /quotes/{id}: ${LibUtil.getStackOrInspect(err)}`)
       model.handleException(fspiopSource, quoteId, err, request.headers, span)
+      histTimerEnd({ success: false })
     } finally {
       // eslint-disable-next-line no-unsafe-finally
       return h.response().code(Enum.Http.ReturnCodes.OK.CODE)

src/handlers/quotes/{id}/error.js

@@ -38,6 +38,7 @@ const EventSdk = require('@mojaloop/event-sdk')
 const Enum = require('@mojaloop/central-services-shared').Enum
 const LibUtil = require('../../../lib/util')
 const QuotesModel = require('../../../model/quotes')
+const Metrics = require('@mojaloop/central-services-metrics')
 
 /**
  * Operations on /quotes/{id}/error
@@ -51,6 +52,11 @@ module.exports = {
      * responses: 200, 400, 401, 403, 404, 405, 406, 501, 503
      */
   put: async function QuotesByIdAndError (context, request, h) {
+    const histTimerEnd = Metrics.getHistogram(
+      'quotes_id_put_error',
+      'Process HTTP PUT /quotes/{id}/error request',
+      ['success']
+    ).startTimer()
     // log request
     request.server.log(['info'], `got a PUT /quotes/{id}/error request: ${util.inspect(request.payload)}`)
 
@@ -77,10 +83,12 @@ module.exports = {
       model.handleQuoteError(request.headers, quoteId, request.payload.errorInformation, span).catch(err => {
         request.server.log(['error'], `ERROR - handleQuoteError: ${LibUtil.getStackOrInspect(err)}`)
       })
+      histTimerEnd({ success: true })
     } catch (err) {
       // something went wrong, use the model to handle the error in a sensible way
       request.server.log(['error'], `ERROR - PUT /quotes/{id}/error: ${LibUtil.getStackOrInspect(err)}`)
       model.handleException(fspiopSource, quoteId, err, request.headers)
+      histTimerEnd({ success: false })
     } finally {
       // eslint-disable-next-line no-unsafe-finally
       return h.response().code(Enum.Http.ReturnCodes.OK.CODE)

src/handlers/routes.js

@@ -127,6 +127,16 @@ const APIRoutes = (api) => [
       tags: ['api', 'health'],
       description: 'GET health'
     }
+  },
+  {
+    method: 'GET',
+    path: '/metrics',
+    handler: (req, h) => handleRequest(api, req, h),
+    config: {
+      tags: ['api', 'metrics'],
+      description: 'Prometheus metrics endpoint',
+      id: 'metrics'
+    }
   }
 ]