add direct metrics pushed to datadog

Author: Mefl

Diff for: api/index.js

@@ -4,6 +4,8 @@ import { validateEnvironmentVariables } from './src/shared/infrastructure/valida
 
 validateEnvironmentVariables();
 
+import metrics from 'datadog-metrics';
+
 import { disconnect, prepareDatabaseConnection } from './db/knex-database-connection.js';
 import { createServer } from './server.js';
 import { config } from './src/shared/config.js';
@@ -42,6 +44,11 @@ async function _exitOnSignal(signal) {
   logger.info(`Received signal: ${signal}.`);
   logger.info('Stopping HAPI server...');
   await server.stop({ timeout: 30000 });
+  if (server.pixCustomIntervals) {
+    logger.info('Closing metrics interval and flush metrics');
+    server.pixCustomIntervals.forEach(clearInterval);
+    metrics.flush();
+  }
   if (server.oppsy) {
     logger.info('Stopping HAPI Oppsy server...');
     await server.oppsy.stop();

Diff for: api/package-lock.json

@@ -36,6 +36,7 @@
     "bcrypt": "^5.0.1",
     "cron-parser": "^4.9.0",
     "dayjs": "^1.11.5",
+    "datadog-metrics": "^0.12.0",
     "debug": "^4.3.4",
     "dotenv": "^16.0.1",
     "fast-levenshtein": "^3.0.0",

Diff for: api/package.json

@@ -40,6 +40,14 @@ REDIS_URL=redis://localhost:6379
 # default: none
 # sample (everyday at 06:30 UTC): CACHE_RELOAD_TIME=30 6 * * *
 
+# =====
+# DATADOG
+# =====
+
+# Datadog access context
+#
+DATADOG_API_KEY=nokey
+
 # =========
 # DATABASES
 # =========

Diff for: api/sample.env

@@ -1,5 +1,6 @@
 import Oppsy from '@1024pix/oppsy';
 import Hapi from '@hapi/hapi';
+import metrics from 'datadog-metrics';
 import { parse } from 'neoqs';
 
 import { setupErrorHandling } from './config/server-setup-error-handling.js';
@@ -35,6 +36,7 @@ import { config } from './src/shared/config.js';
 import { monitoringTools } from './src/shared/infrastructure/monitoring-tools.js';
 import { plugins } from './src/shared/infrastructure/plugins/index.js';
 import { deserializer } from './src/shared/infrastructure/serializers/jsonapi/deserializer.js';
+import { logger } from './src/shared/infrastructure/utils/logger.js';
 // bounded context migration
 import { sharedRoutes } from './src/shared/routes.js';
 import { swaggers } from './src/shared/swaggers.js';
@@ -69,7 +71,25 @@ const { logOpsMetrics, port, logging } = config;
 const createServer = async () => {
   const server = createBareServer();
 
-  if (logOpsMetrics) await enableOpsMetrics(server);
+  // initialisation of Datadog link for metrics publication
+  if (config.environment !== 'development' || config.featureToggles.isDirectMetricsEnabled) {
+    logger.info('Metric initialisation : linked to Datadog');
+    metrics.init({
+      host: config.infra.containerName,
+      prefix: 'tests.',
+      defaultTags: [`service:${config.infra.appName}`],
+    });
+  } else {
+    logger.info('Metric initialisation : no reporter => no metrics sent');
+    metrics.init({ reporter: metrics.NullReporter() });
+  }
+
+  if (logOpsMetrics) {
+    // OPS metrics via direct metrics
+    if (config.featureToggles.isDirectMetricsEnabled) await enableOpsMetrics(server);
+    // OPS metrics via Oppsy
+    if (!config.featureToggles.isOppsyDisabled) await enableLegacyOpsMetrics(server);
+  }
 
   setupErrorHandling(server);
 
@@ -125,6 +145,47 @@ const createBareServer = function () {
 };
 
 const enableOpsMetrics = async function (server) {
+  function collectMemoryStats() {
+    const memUsage = process.memoryUsage();
+    metrics.gauge(`captain.api.memory.rss`, memUsage.rss);
+    metrics.gauge('captain.api.memory.heapTotal', memUsage.heapTotal);
+    metrics.gauge('captain.api.memory.heapUsed', memUsage.heapUsed);
+  }
+
+  const metricsInterval = setInterval(collectMemoryStats, 5000);
+  server.pixCustomIntervals = [metricsInterval];
+
+  const gaugeConnections = (pool) => () => {
+    logger.info('publie les metrics de knex');
+    metrics.gauge('captain.api.knex.db_connections_used', pool.numUsed());
+    metrics.gauge('captain.api.knex.db_connections_free', pool.numFree());
+    metrics.gauge('captain.api.knex.db_connections_pending_creation', pool.numPendingCreates());
+    metrics.gauge('captain.api.knex.db_connections_pending_detroy', pool['pendingDestroys'].length);
+  };
+
+  const client = knex.client;
+  gaugeConnections(client.pool)();
+
+  client.pool.on('createSuccess', gaugeConnections(client.pool));
+  client.pool.on('acquireSuccess', gaugeConnections(client.pool));
+  client.pool.on('release', gaugeConnections(client.pool));
+  client.pool.on('destroySuccess', gaugeConnections(client.pool));
+
+  server.events.on('response', (request) => {
+    const info = request.info;
+
+    const statusCode = request.raw.res.statusCode;
+    const responseTime = (info.completed !== undefined ? info.completed : info.responded) - info.received;
+
+    metrics.histogram('captain.api.duration', responseTime, [
+      `method:${request.route.method}`,
+      `route:${request.route.path}`,
+      `statusCode:${statusCode}`,
+    ]);
+  });
+};
+
+const enableLegacyOpsMetrics = async function (server) {
   const oppsy = new Oppsy(server);
 
   oppsy.on('ops', (data) => {

Diff for: api/server.js

@@ -204,10 +204,12 @@ const configuration = (function () {
       ),
       isAsyncQuestRewardingCalculationEnabled: toBoolean(process.env.FT_ENABLE_ASYNC_QUESTS_REWARDS_CALCULATION),
       isCertificationTokenScopeEnabled: toBoolean(process.env.FT_ENABLE_CERTIF_TOKEN_SCOPE),
+      isDirectMetricsEnabled: toBoolean(process.env.FT_ENABLE_DIRECT_METRICS),
       isNeedToAdjustCertificationAccessibilityEnabled: toBoolean(
         process.env.FT_ENABLE_NEED_TO_ADJUST_CERTIFICATION_ACCESSIBILITY,
       ),
       isNewAuthenticationDesignEnabled: toBoolean(process.env.FT_NEW_AUTHENTICATION_DESIGN_ENABLED),
+      isOppsyDisabled: toBoolean(process.env.FT_OPPSY_DISABLED),
       isPix1dEnabled: toBoolean(process.env.FT_PIX_1D_ENABLED),
       isPixCompanionEnabled: toBoolean(process.env.FT_PIX_COMPANION_ENABLED),
       isSelfAccountDeletionEnabled: toBoolean(process.env.FT_SELF_ACCOUNT_DELETION),
@@ -223,6 +225,8 @@ const configuration = (function () {
       enableRequestMonitoring: toBoolean(process.env.ENABLE_REQUEST_MONITORING),
     },
     infra: {
+      appName: process.env.APP,
+      containerName: process.env.CONTAINER,
       concurrencyForHeavyOperations: _getNumber(process.env.INFRA_CONCURRENCY_HEAVY_OPERATIONS, 2),
       chunkSizeForCampaignResultProcessing: _getNumber(process.env.INFRA_CHUNK_SIZE_CAMPAIGN_RESULT_PROCESSING, 10),
       chunkSizeForOrganizationLearnerDataProcessing: _getNumber(
@@ -290,6 +294,9 @@ const configuration = (function () {
         },
       },
     },
+    metrics: {
+      flushIntervalSeconds: _getNumber(process.env.DIRECT_METRICS_FLUSH_INTERVAL, 5),
+    },
     partner: {
       fetchTimeOut: ms(process.env.FETCH_TIMEOUT_MILLISECONDS || '20s'),
     },
@@ -412,7 +419,9 @@ const configuration = (function () {
     config.featureToggles.deprecatePoleEmploiPushNotification = false;
     config.featureToggles.isAlwaysOkValidateNextChallengeEndpointEnabled = false;
     config.featureToggles.isCertificationTokenScopeEnabled = false;
+    config.featureToggles.isDirectMetricsEnabled = false;
     config.featureToggles.isNeedToAdjustCertificationAccessibilityEnabled = false;
+    config.featureToggles.isOppsyDisabled = false;
     config.featureToggles.isPix1dEnabled = true;
     config.featureToggles.isPixCompanionEnabled = false;
     config.featureToggles.isSelfAccountDeletionEnabled = false;

Diff for: api/src/shared/config.js

@@ -71,15 +71,20 @@ const plugin = {
 
     server.events.on('response', (request) => {
       const info = request.info;
-      logger.info(
-        {
-          queryParams: request.query,
-          req: request,
-          res: request.raw.res,
-          responseTime: (info.completed !== undefined ? info.completed : info.responded) - info.received,
-        },
-        'request completed',
-      );
+
+      const shouldLog = !config.featureToggles.isDirectMetricsEnabled;
+
+      if (shouldLog || request.raw.res.statusCode != 200) {
+        logger.info(
+          {
+            queryParams: request.query,
+            req: request,
+            res: request.raw.res,
+            responseTime: (info.completed !== undefined ? info.completed : info.responded) - info.received,
+          },
+          'request completed',
+        );
+      }
     });
   },
 };

Diff for: api/src/shared/infrastructure/plugins/pino.js

@@ -24,8 +24,10 @@ describe('Acceptance | Shared | Application | Controller | feature-toggle', func
             'is-always-ok-validate-next-challenge-endpoint-enabled': false,
             'is-async-quest-rewarding-calculation-enabled': false,
             'is-certification-token-scope-enabled': false,
+            'is-direct-metrics-enabled': false,
             'is-need-to-adjust-certification-accessibility-enabled': false,
             'is-new-authentication-design-enabled': false,
+            'is-oppsy-disabled': false,
             'is-pix1d-enabled': true,
             'is-pix-companion-enabled': false,
             'is-quest-enabled': false,