Enable metrics tracking for only for configured hosts

Author: RubenChM

config.yml

@@ -12,6 +12,7 @@ hosts:
         name: MDposit (local)
         description: The main server including all simulations
         accession: A0001
+        metrics: true
 
     mdposit.mddbr.eu:
         name: MDposit
@@ -25,6 +26,7 @@ hosts:
         description: The main server including all simulations
         accession: MD-A00001
         global: true
+        metrics: true
 
     # Deprecated
     mdposit-dev.bsc.es:
@@ -59,6 +61,7 @@ hosts:
         description: The Covid-19 server
         accession: MCV1900193
         collection: cv19
+        metrics: true
 
     model-cns-dev.bsc.es:
         name: MoDEL-CNS
@@ -83,6 +86,7 @@ hosts:
         description: The MMB federated node server
         accession: A0001
         optimade: true
+        metrics: true
 
     mmb.mddbr.eu:
         name: MMB node
@@ -95,6 +99,7 @@ hosts:
         description: The IRB federated node server
         accession: A0001
         optimade: true
+        metrics: true
 
     irb.mddbr.eu:
         name: IRB node

src/middlewares/metrics/index.js

@@ -3,7 +3,7 @@ const yaml = require('yamljs');
 const client = require('prom-client');
 const geoip = require('geoip-lite');
 const rawSpec = yaml.load(`${__dirname}/../../docs/description.yml`);
-const { getHost } = require('../../utils/auxiliar-functions');
+const { getHost, getConfig } = require('../../utils/auxiliar-functions');
 
 
 // ---------------------------------------------------------------------------
@@ -311,19 +311,28 @@ function anonymizeIp(ip) {
   return 'Unknown';
 }
 
+function isMetricsEnabled(request) {
+  const config = getConfig(request);
+  return Boolean(config && config.metrics === true);
+}
+
 // ---------------------------------------------------------------------------
 // Public API
 // ---------------------------------------------------------------------------
 
 // Returns an Express middleware that records metrics for every response.
 // Pass the parsed OpenAPI spec and the base paths used by the router.
-function metricsMiddleware(basePaths = ['/rest/current', '/rest/v1'], debug = true) {
+function metricsMiddleware(basePaths = ['/rest/current', '/rest/v1'], debug = false) {
   if (!Array.isArray(basePaths)) {
     basePaths = ['/rest/current', '/rest/v1'];
   }
   const matchers = buildMatchers(basePaths);
 
   return function trackMetrics(req, res, next) {
+    if (!isMetricsEnabled(req)) {
+      return next();
+    }
+
     const startMs = Date.now();
     // Capture the full path NOW — req.path is mutated by Express after sub-router
     // dispatch, but req.originalUrl is always the original unmodified path.
@@ -380,6 +389,10 @@ function metricsMiddleware(basePaths = ['/rest/current', '/rest/v1'], debug = tr
 // Express route handler that serves the Prometheus text exposition format.
 // Supports PM2 cluster mode by aggregating metrics from all instances.
 async function metricsEndpoint(req, res) {
+  if (!isMetricsEnabled(req)) {
+    return res.status(404).json({ error: 'Not Found' });
+  }
+
   try {
     let aggregatedRegistry = register;
 

src/server/index.js

@@ -28,7 +28,7 @@ const HOUR = 60 * MINUTE;
 
 const app = express();
 
-// Middleware to track endopoint usage and response times
+// Middleware to track endpoint usage and response times
 app.use(metricsMiddleware());
 
 // Disable this header