@apolitical/server 3.0.1 → 4.0.1-pla-361.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apolitical/server",
-  "version": "3.0.1",
+  "version": "4.0.1-pla-361.0",
   "description": "Node.js module to encapsulate Apolitical's express server setup",
   "author": "Apolitical Group Limited <engineering@apolitical.co>",
   "license": "MIT",
@@ -15,8 +15,7 @@
     "lint": "eslint --ext .js ./src",
     "format": "prettier --write 'src/**/*.+(js|json)'",
     "lint-format": "lint-staged",
-    "audit": "audit-ci -h",
-    "prepare": "cd ../../../../ && husky install backend/modules/v1/apolitical-server/.husky"
+    "audit": "audit-ci -h"
   },
   "keywords": [
     "Backend",
@@ -26,13 +25,21 @@
   "dependencies": {
     "@apolitical/logger": "2.1.0",
     "@cloudnative/health-connect": "2.1.0",
+    "@opentelemetry/api": "1.9.0",
+    "@opentelemetry/auto-instrumentations-node": "0.57.1",
+    "@opentelemetry/exporter-trace-otlp-grpc": "0.200.0",
+    "@opentelemetry/resources": "2.0.0",
+    "@opentelemetry/sdk-metrics": "2.0.0",
+    "@opentelemetry/sdk-node": "0.200.0",
+    "@opentelemetry/sdk-trace-node": "2.0.0",
+    "@opentelemetry/semantic-conventions": "1.30.0",
     "awilix": "8.0.0",
     "body-parser": "1.20.1",
     "compression": "1.7.4",
     "cookie-parser": "1.4.6",
     "cors": "2.8.5",
     "dotenv": "16.0.3",
-    "express": "4.18.2",
+    "express": "4.22.0",
     "express-jwt": "8.3.0",
     "http-status-codes": "2.2.0",
     "http-terminator": "3.2.0",
@@ -52,7 +59,6 @@
     "@apolitical/eslint-config": "2.1.0",
     "@apolitical/testing": "2.1.0",
     "audit-ci": "6.6.0",
-    "husky": "8.0.3",
     "lint-staged": "13.1.0",
     "mock-jwks": "1.0.9",
     "nock": "13.2.9"

package/src/container.js

@@ -41,6 +41,7 @@ const documentationLoader = require('./loaders/documentation.loader');
 const expressLoader = require('./loaders/express.loader');
 const loggerLoader = require('./loaders/logger.loader');
 const middlewaresLoader = require('./loaders/middlewares.loader');
+const otelLoader = require('./loaders/otel.loader');
 const probesLoader = require('./loaders/probes.loader');
 const fallbackLoader = require('./loaders/fallback.loader');
 // Middleware
@@ -98,6 +99,7 @@ container.register({
   expressLoader: asFunction(expressLoader).singleton(),
   loggerLoader: asFunction(loggerLoader).singleton(),
   middlewaresLoader: asFunction(middlewaresLoader).singleton(),
+  otelLoader: asFunction(otelLoader).singleton(),
   probesLoader: asFunction(probesLoader).singleton(),
   fallbackLoader: asFunction(fallbackLoader).singleton(),
   // Middlewares

package/src/index.js

@@ -2,4 +2,7 @@
 
 const { resolve } = require('./container');
 
+// OTel must load before the Express server is started
+resolve('otelLoader')();
+
 module.exports = resolve('serverService');

package/src/loaders/otel.loader.js

@@ -0,0 +1,34 @@
+'use strict';
+
+const { NodeSDK } = require('@opentelemetry/sdk-node');
+const { OTLPTraceExporter } = require('@opentelemetry/exporter-trace-otlp-grpc');
+const { getNodeAutoInstrumentations } = require('@opentelemetry/auto-instrumentations-node');
+const { resourceFromAttributes } = require('@opentelemetry/resources');
+const { ATTR_SERVICE_NAME } = require('@opentelemetry/semantic-conventions');
+
+module.exports = ({ logger }) => {
+  return async function load() {
+    const otlpHost = process.env.OPENTELEMETRY_COLLECTOR_SERVICE_HOST;
+    const otlpPort = process.env.OPENTELEMETRY_COLLECTOR_SERVICE_PORT;
+    if (!otlpHost || !otlpPort) {
+      return;
+    }
+    const oltpEndpoint = `http://${otlpHost}:${otlpPort}`;
+    const serviceName = process.env.CONTAINER_NAME || 'unknown-v1-service';
+    const sdk = new NodeSDK({
+      resource: resourceFromAttributes({
+        [ATTR_SERVICE_NAME]: serviceName,
+      }),
+      traceExporter: new OTLPTraceExporter({ url: oltpEndpoint }),
+      instrumentations: [getNodeAutoInstrumentations()],
+    });
+    sdk.start();
+    const log = logger.where(__filename, 'load');
+    log.info(`OpenTelemetry SDK started with service name ${serviceName} and endpoint ${oltpEndpoint}`);
+
+    process.on('SIGTERM', async () => {
+      await sdk.shutdown();
+      process.exit(0);
+    });
+  };
+};