Merge pull request #3 from ONDC-Official/feat-tracing

Feat tracing

Author: mofahsan

.github/workflows/deployment.yml

@@ -58,7 +58,8 @@ jobs:
           echo "REDIS_PORT=${{ secrets.REDIS_PORT }}" >> \$REPO_DIR/backend/.env
           echo "REDIS_PASSWORD=${{ secrets.REDIS_PASSWORD }}" >> \$REPO_DIR/backend/.env
           echo "REDIS_USERNAME=${{ secrets.REDIS_USERNAME }}" >> \$REPO_DIR/backend/.env
-          
+          echo "SERVICE_NAME=${{ vars.SERVICE_NAME }}" >> \$REPO_DIR/backend/.env
+          echo "TRACE_URL=${{ vars.TRACE_URL }}" >> \$REPO_DIR/backend/.env
           EOF
 
       - name: Verify docker-compose.yml files

backend/package.json

@@ -1,5 +1,14 @@
 {
 	"dependencies": {
+		"@opentelemetry/api": "1.9.0",
+		"@opentelemetry/auto-instrumentations-node": "0.57.1",
+		"@opentelemetry/exporter-jaeger": "2.0.0",
+		"@opentelemetry/exporter-prometheus": "0.200.0",
+		"@opentelemetry/resources": "^1.8.0",
+		"@opentelemetry/sdk-logs": "0.200.0",
+		"@opentelemetry/sdk-metrics": "2.0.0",
+		"@opentelemetry/sdk-node": "0.200.0",
+		"@opentelemetry/semantic-conventions": "1.32.0",
 		"@types/axios": "^0.14.4",
 		"axios": "^1.7.9",
 		"connect-redis": "^7.1.1",
@@ -11,6 +20,7 @@
 		"ioredis": "^5.4.1",
 		"js-yaml": "^4.1.0",
 		"jsonwebtoken": "^9.0.2",
+		"lodash": "^4.17.21",
 		"ondc-automation-cache-lib": "^1.0.4",
 		"redis": "^4.7.0",
 		"uuid": "^11.0.3"
@@ -23,6 +33,7 @@
 		"@types/express-session": "^1.18.0",
 		"@types/js-yaml": "^4.0.9",
 		"@types/jsonwebtoken": "^9.0.7",
+		"@types/lodash": "^4.17.16",
 		"@types/node": "^22.10.1",
 		"copyfiles": "^2.4.1",
 		"nodemon": "^3.1.7",

backend/src/config/otelConfig.ts

@@ -0,0 +1,22 @@
+'use strict';
+require('dotenv').config();
+console.info("Starting opentelemetry tracing");
+const { NodeSDK } = require('@opentelemetry/sdk-node');
+const { getNodeAutoInstrumentations } = require('@opentelemetry/auto-instrumentations-node');
+const { JaegerExporter } = require('@opentelemetry/exporter-jaeger');
+const { Resource } = require('@opentelemetry/resources');
+const { SemanticResourceAttributes } = require('@opentelemetry/semantic-conventions');
+
+const resource = new Resource({
+  [SemanticResourceAttributes.SERVICE_NAME]: process.env.SERVICE_NAME
+});
+const sdk = new NodeSDK({
+  traceExporter: new JaegerExporter({
+    endpoint: process.env.TRACE_URL,
+
+  }),
+  instrumentations: [getNodeAutoInstrumentations()],
+  resource,
+});
+
+sdk.start();

backend/src/index.ts

@@ -1,3 +1,4 @@
+require("./config/otelConfig")
 import app from './app';
 import * as dotenv from 'dotenv'
 

backend/src/routes/sessionRoutes.ts

@@ -10,14 +10,15 @@ import {
   createSession,
 } from "../controllers/sessionController";
 import validateToken from "../middleware";
+import otelTracing from "../services/tracing-service";
 
 const router = Router();
 
 router.get("/all", validateToken, getAllSession);
-router.get("/", validateToken, getSession);
-router.put("/", validateToken, updateSession);
-router.delete("/", validateToken, deleteSession);
-router.post("/", createSession);
+router.get("/", otelTracing('','','query.subscriber_url'),validateToken, getSession);
+router.put("/",otelTracing('','','query.subscriber_url'), validateToken, updateSession);
+router.delete("/",otelTracing('','','query.subscriber_url'), validateToken, deleteSession);
+router.post("/",otelTracing('','body.sessionID'), createSession);
 router.post("/updatedb", updateCacheDb);
 
 export default router;

backend/src/services/tracing-service.ts

@@ -0,0 +1,44 @@
+import { trace } from '@opentelemetry/api';
+import { Request, Response, NextFunction, RequestHandler } from 'express';
+import { get } from 'lodash';
+
+/**
+ * Middleware factory that creates a tracing span with optional dot-notated paths.
+ * 
+ * @param transaction_id_path - Dot path to transaction_id in req.body (default: 'context.transaction_id')
+ * @param session_id - Dot path to transaction_id in req.body (default: 'context.transaction_id')
+ * @param bap_id_path - Dot path to bap_id in req.body (default: 'context.bap_id')
+ * @param bpp_id_path - Dot path to bpp_id in req.body (default: 'context.bpp_id')
+ * @returns Express middleware
+ */
+export function otelTracing(
+  transaction_id_path: string = 'transaction_id',
+  session_id_path: string = 'session_id',
+  bap_id_path: string = 'context.bap_id',
+  bpp_id_path: string = 'context.bpp_id'
+): RequestHandler {
+  return (req: Request, res: Response, next: NextFunction) => {
+    const transaction_id: string | undefined = get(req, transaction_id_path);
+    const session_id: string | undefined = get(req, session_id_path);
+    const bap_id: string | undefined = get(req, bap_id_path);
+    const bpp_id: string | undefined = get(req, bpp_id_path);
+
+    const tracer = trace.getTracer(process.env.SERVICE_NAME || 'default-service');
+
+    const span = tracer.startSpan("trace_span", {
+      attributes: {
+        'transaction_id': transaction_id || '',
+        'session_id': session_id || '',
+        'bap_id': bap_id || '',
+        'bpp_id': bpp_id || '',
+      }
+    });
+
+      span.end();
+      
+      next();
+
+  };
+}
+
+export default otelTracing;