options for spans

lib/server.js

@@ -3,6 +3,9 @@ const https = require('https');
 const cluster = require('cluster');
 const { series } = require('async');
 const arsenal = require('arsenal');
+// trace and context
+const { trace, context } = require('@opentelemetry/api');
+
 const { RedisClient, StatsClient } = arsenal.metrics;
 const monitoringClient = require('./utilities/monitoringHandler');
 const metrics = require('./utilities/metrics');
@@ -140,7 +143,34 @@ class S3Server {
                 vault,
             },
         };
-        routes(req, res, params, logger, _config);
+        // Start a new span for the request
+        const tracer = trace.getTracer(process.env.OTEL_SERVICE_NAME || 'S3-cloudserver');
+        const span = tracer.startSpan('s3-service-request', {
+            kind: 1, // SERVER
+            attributes: { 'http.method': req.method, 'http.url': req.url },
+        });
+
+        context.with(trace.setSpan(context.active(), span), () => {
+            // ----- Add nested spans and events -----
+            const activeSpan = trace.getSpan(context.active());
+            activeSpan.addEvent('inside routeRequest');
+
+            const v4Span = tracer.startSpan('verifySignatureV4', {
+                kind: 1, // SERVER
+                attributes: { 'verify.step': 'start' },
+            });
+
+            context.with(trace.setSpan(context.active(), v4Span), () => {
+                // Simulate verifySignatureV4 process
+                setTimeout(() => {
+                    v4Span.end(); // End the nested span
+                    activeSpan.addEvent('verifySignatureV4 completed');
+                    routes(req, res, params, logger, _config);
+                    span.end(); // End the main span when the request handling is complete
+                }, 100); // Simulate some delay in the verification process
+            });
+            // -----
+        });
     }
 
     /**

package.json

@@ -20,6 +20,10 @@
   "homepage": "https://github.com/scality/S3#readme",
   "dependencies": {
     "@hapi/joi": "^17.1.0",
+    "@honeycombio/opentelemetry-node": "^0.7.2",
+    "@opentelemetry/api": "^1.8.0",
+    "@opentelemetry/auto-instrumentations-node": "^0.46.1",
+    "@opentelemetry/instrumentation-aws-sdk": "^0.41.0",
     "arsenal": "git+https://github.com/scality/arsenal#7.70.29",
     "async": "~2.5.0",
     "aws-sdk": "2.905.0",
@@ -84,7 +88,7 @@
     "start": "npm-run-all --parallel start_dmd start_s3server",
     "start_mdserver": "node mdserver.js",
     "start_dataserver": "node dataserver.js",
-    "start_s3server": "node index.js",
+    "start_s3server": "node  -r ./tracing.js index.js",
     "start_dmd": "npm-run-all --parallel start_mdserver start_dataserver",
     "start_utapi": "node lib/utapi/utapi.js",
     "utapi_replay": "node lib/utapi/utapiReplay.js",

tracing.js

@@ -0,0 +1,25 @@
+// Example filename: tracing.js
+
+'use strict';
+
+const { HoneycombSDK } = require('@honeycombio/opentelemetry-node');
+const {
+  getNodeAutoInstrumentations,
+} = require('@opentelemetry/auto-instrumentations-node');
+const { IORedisInstrumentation } = require('@opentelemetry/instrumentation-ioredis');
+
+// Uses environment variables named HONEYCOMB_API_KEY and OTEL_SERVICE_NAME
+const sdk = new HoneycombSDK({
+    instrumentations: [getNodeAutoInstrumentations({
+      // We recommend disabling fs automatic instrumentation because
+      // it can be noisy and expensive during startup
+        '@opentelemetry/instrumentation-fs': {
+            enabled: false,
+        },
+    }),
+    new IORedisInstrumentation(),
+  ],
+});
+
+sdk.start();
+