@apolitical/server 3.0.1-dh.0 → 4.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apolitical/server",
-  "version": "3.0.1-dh.0",
+  "version": "4.0.0",
   "description": "Node.js module to encapsulate Apolitical's express server setup",
   "author": "Apolitical Group Limited <engineering@apolitical.co>",
   "license": "MIT",
@@ -25,14 +25,14 @@
   "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-http": "^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",
+    "@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",

package/src/container.js

@@ -28,7 +28,6 @@ const apoliticalLogger = require('@apolitical/logger');
 const config = require('./config');
 // Logger
 const logger = apoliticalLogger.createLogger(config.LOGGER_OPTIONS);
-const otel = require('./helpers/otel.helper');
 // Errors
 const serverError = require('./errors/server.error');
 // Helpers
@@ -42,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
@@ -86,7 +86,6 @@ container.register({
   config: asValue(config),
   // Logger
   logger: asValue(logger),
-  otel: asFunction(otel).singleton(),
   // Errors
   serverError: asFunction(serverError).singleton(),
   // Helpers
@@ -100,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/logger.loader.js

@@ -1,8 +1,7 @@
 'use strict';
 
-module.exports = ({ apoliticalLogger, config, logger, loggerHelper, otel }) => {
+module.exports = ({ apoliticalLogger, config, logger, loggerHelper }) => {
   return async function load(app, { labels }) {
-    console.log(otel);
     if (config.NODE_ENV === 'production') {
       // Setup Google Cloud with Apolitical Logger
       const winstonMiddleware = await apoliticalLogger.loggerMiddleware(

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);
+    });
+  };
+};

package/src/helpers/otel.helper.js

@@ -1,21 +0,0 @@
-'use strict';
-
-const { NodeSDK } = require('@opentelemetry/sdk-node');
-const { OTLPTraceExporter } = require('@opentelemetry/exporter-trace-otlp-http');
-const { getNodeAutoInstrumentations } = require('@opentelemetry/auto-instrumentations-node');
-const { resourceFromAttributes } = require('@opentelemetry/resources');
-const { ATTRS_SERVICE_NAME } = require('@opentelemetry/semantic-conventions');
-
-module.exports = () => {
-  console.log('Starting OpenTelemetry SDK...');
-  const sdk = new NodeSDK({
-    resource: resourceFromAttributes({
-      [ATTRS_SERVICE_NAME]: process.env.PROJECT_NAME,
-    }),
-    traceExporter: new OTLPTraceExporter({ url: 'http://localhost:4318/v1/traces' }),
-    instrumentations: [getNodeAutoInstrumentations()],
-  });
-  sdk.start();
-  console.log('OpenTelemetry SDK started');
-  return {};
-};