24840 observability payments

apps/payments-api/.env.sample

@@ -39,3 +39,6 @@ LOGTO_M2M_ANALYTICS_APP_SECRET=m2m_analytics_api_local_secret
 ANALYTICS_WEBSITE_ID=2c144c54-e581-2591-c5fc-2d9db0b2bbed
 ANALYTICS_URL=http://localhost:8075
 ANALYTICS_MATOMO_TOKEN=
+
+OTEL_SERVICE_NAME=payments-api
+OTEL_COLLECTOR_URL=http://localhost:44317

apps/payments-api/Dockerfile

@@ -33,4 +33,4 @@ WORKDIR /app/apps/payments-api
 ENV NODE_ENV=production
 ENV LOG_LEVEL=trace
 EXPOSE 8001
-CMD [ "npx", "ts-node", "dist/", "index.js" ]
+CMD [ "npx", "ts-node", "dist/", "bootstrap.js" ]

apps/payments-api/bootstrap.ts

@@ -0,0 +1,2 @@
+import "./instrumentation";
+import "./index";

apps/payments-api/instrumentation.ts

@@ -0,0 +1,8 @@
+import { instrumentNode } from "@ogcio/o11y-sdk-node";
+
+instrumentNode({
+  serviceName: process.env.OTEL_SERVICE_NAME,
+  collectorUrl: process.env.OTEL_COLLECTOR_URL!,
+  collectorMode: "batch",
+  diagLogLevel: "INFO",
+});

apps/payments-api/package.json

@@ -10,7 +10,7 @@
     "test:smoke:e2e": "cd ./e2e && mkdir -p test-results && bru run --env dev --output ./test-results/results.xml --format junit",
     "test:regression:e2e": "cd ./e2e && mkdir -p test-results && bru run --env dev --output ./test-results/results.xml --format junit",
     "test:nf": "mkdir -p test_reports && mkdir -p test_reports/perf && echo \"Error: no test specified\" && exit 0",
-    "start": "node dist/index.js",
+    "start": "node --env-file=.env dist/bootstrap.js",
     "dev": "nodemon | pino-pretty",
     "lint": "eslint . --ext .ts",
     "build": "rm -rf dist && tsc -p tsconfig.prod.json && cp logo.png dist/",
@@ -22,7 +22,7 @@
       "./**/*"
     ],
     "ext": "ts,json",
-    "exec": "node --import tsx index.ts"
+    "exec": "node --env-file=.env --import tsx bootstrap.ts"
   },
   "type": "module",
   "author": "",
@@ -40,7 +40,8 @@
     "@ogcio/api-auth": "^4.29.1",
     "@ogcio/building-blocks-sdk": "^0.1.14",
     "@ogcio/fastify-error-handler": "^4.0.1",
-    "@ogcio/fastify-logging-wrapper": "^4.0.1",
+    "@ogcio/fastify-logging-wrapper": "^5.1.0",
+    "@ogcio/o11y-sdk-node": "^0.1.0-beta.2",
     "@sinclair/typebox": "^0.32.31",
     "db-migrate": "^0.11.14",
     "db-migrate-pg": "^1.5.2",

apps/payments/.env.sample

@@ -38,3 +38,10 @@ NEXT_PUBLIC_ANALYTICS_WEBSITE_ID=2c144c54-e581-2591-c5fc-2d9db0b2bbed
 NEXT_PUBLIC_AUTH_ORGANIZATION_ID=ogcio
 
 PROFILE_BACKEND_URL=http://localhost:8003
+
+NEXT_PUBLIC_OTEL_CLIENT_SERVICE_NAME=payments
+NEXT_PUBLIC_OTEL_FARO_URL=http://localhost:12347/collect
+NEXT_PUBLIC_OTEL_PROPAGATE_TRACE_HEADER=http://localhost:3001/*
+
+OTEL_SERVER_SERVICE_NAME=payments-next-server
+OTEL_COLLECTOR_URL=http://localhost:44317

apps/payments/instrumentation.ts

@@ -0,0 +1,14 @@
+export async function register() {
+    if (process.env.NEXT_RUNTIME === "nodejs") {
+      import("@ogcio/o11y-sdk-node").then(async (sdk) => {
+        sdk.instrumentNode({
+          serviceName: process.env.OTEL_SERVER_SERVICE_NAME!,
+          collectorUrl: process.env.OTEL_COLLECTOR_URL!,
+          collectorMode: "batch",
+        });
+      });
+    } else {
+      console.error("Instrumentation not supported on current runtime");
+    }
+  }
+

apps/payments/next.config.mjs

@@ -13,6 +13,8 @@ const nextConfig = {
   poweredByHeader: false,
   experimental: {
     outputFileTracingRoot: path.join(__dirname, "../../"),
+    instrumentationHook: true,
+    serverComponentsExternalPackages: ["pino", "@opentelemetry/instrumentation-pino"]
   },
   // Added this because `unleash-client` is a peer dependency
   // of `building-blocks-sdk` and when next.js builds the project,

apps/payments/package.json

@@ -34,6 +34,8 @@
     "@ogcio/life-events-ds": "^0.1.1",
     "@ogcio/nextjs-analytics": "0.1.2",
     "@ogcio/nextjs-auth": "3.5.0",
+    "@ogcio/o11y-sdk-node": "^0.1.0-beta.2",
+    "@ogcio/o11y-sdk-react": "0.0.1-beta.1",
     "@stripe/react-stripe-js": "^2.7.1",
     "@stripe/stripe-js": "^3.4.1",
     "allure-commandline": "^2.30.0",
@@ -43,6 +45,7 @@
     "next": "14.2.5",
     "next-intl": "^3.17.2",
     "pg": "^8.11.5",
+    "pino": "^9.5.0",
     "react": "^18.3.1",
     "react-dom": "^18.3.1",
     "sass": "^1.83.1",