Add IP metrics to REST

hedera-mirror-rest/config/application.yml

@@ -24,6 +24,7 @@ hedera:
           password: password
           username: metrics
           uriPath: '/swagger'
+        ipMetrics: false
       openapi:
         specFileName: 'openapi'
         swaggerUIPath: 'docs'

hedera-mirror-rest/middleware/metricsHandler.js

@@ -22,6 +22,7 @@
 
 // ext libraries
 const extend = require('extend');
+const client = require('prom-client');
 const swStats = require('swagger-stats');
 
 // files
@@ -52,6 +53,20 @@ const onMetricsAuthenticate = async (req, username, password) => {
   });
 };
 
+const ipEndpointHistogram = new client.Histogram({
+  name: 'mirror_ip_endpoints_histogram',
+  help: 'a histogram mapping ip addresses to the endpoints they hit',
+  buckets: [0.1, 5, 15, 50, 100, 500],
+  labelNames: ['endpoint', 'ip'],
+});
+
+const recordIpAndEndpoint = async (req, res, next) => {
+  if (req.route !== undefined) {
+    ipEndpointHistogram.labels(req.route.path, req.ip).observe(1);
+  }
+};
+
 module.exports = {
   metricsHandler,
+  recordIpAndEndpoint,
 };

hedera-mirror-rest/server.js

@@ -43,7 +43,7 @@ const tokens = require('./tokens');
 const topicmessage = require('./topicmessage');
 const transactions = require('./transactions');
 const {handleError} = require('./middleware/httpErrorHandler');
-const {metricsHandler} = require('./middleware/metricsHandler');
+const {metricsHandler, recordIpAndEndpoint} = require('./middleware/metricsHandler');
 const {serveSwaggerDocs} = require('./middleware/openapiHandler');
 const {responseHandler} = require('./middleware/responseHandler');
 const {requestLogger, requestQueryParser} = require('./middleware/requestHandler');
@@ -165,6 +165,11 @@ app.getAsync(`${apiPrefix}/schedules/:id`, schedules.getScheduleById);
 app.getAsync(`${apiPrefix}/transactions`, transactions.getTransactions);
 app.getAsync(`${apiPrefix}/transactions/:id`, transactions.getOneTransaction);
 
+// record ip metrics if enabled
+if (config.metrics.ipMetrics) {
+  app.useAsync(recordIpAndEndpoint);
+}
+
 // response data handling middleware
 app.useAsync(responseHandler);
 

hedera-mirror-rest/transactions.js

@@ -465,7 +465,6 @@ const getTransactions = async (req, res) => {
   logger.debug(`getTransactions returning ${ret.transactions.length} entries`);
   res.locals[constants.responseDataLabel] = ret;
 };
-
 /**
  * Gets the scheduled db query from the scheduled param in the HTTP request query. The last scheduled value is honored.
  * If not present, returns empty string.