Feature/bai 849 use open telemetry to send instrumentation info

backend/config/default.cjs

@@ -180,4 +180,12 @@ module.exports = {
       registry: 'registry',
     },
   },
+
+  instrumentation: {
+    enabled: false,
+    serviceName: 'backend',
+    endpoint: '',
+    authenticationToken: '',
+    debug: false,
+  },
 }

backend/package.json

@@ -22,6 +22,8 @@
     "@aws-sdk/client-cognito-identity-provider": "^3.525.0",
     "@aws-sdk/client-s3": "^3.421.0",
     "@aws-sdk/lib-storage": "^3.462.0",
+    "@opentelemetry/auto-instrumentations-node": "^0.41.1",
+    "@opentelemetry/exporter-logs-otlp-proto": "^0.48.0",
     "@smithy/node-http-handler": "^2.1.10",
     "@types/express-session": "^1.18.0",
     "app-root-path": "^3.1.0",

backend/src/index.ts

@@ -1,4 +1,5 @@
 import './utils/signals.js'
+import './instrumentation.js'
 
 import { extendZodWithOpenApi } from '@asteasolutions/zod-to-openapi'
 import shelljs from 'shelljs'

backend/src/instrumentation.ts

@@ -0,0 +1,39 @@
+import { diag, DiagConsoleLogger, DiagLogLevel } from '@opentelemetry/api'
+import { getNodeAutoInstrumentations } from '@opentelemetry/auto-instrumentations-node'
+import { OTLPLogExporter } from '@opentelemetry/exporter-logs-otlp-proto'
+import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-proto'
+import { Resource } from '@opentelemetry/resources'
+import { logs, NodeSDK } from '@opentelemetry/sdk-node'
+import { SemanticResourceAttributes } from '@opentelemetry/semantic-conventions'
+
+import config from './utils/config.js'
+
+if (config.instrumentation.enabled) {
+  if (config.instrumentation.debug) {
+    diag.setLogger(new DiagConsoleLogger(), DiagLogLevel.DEBUG)
+  }
+  const sdk = new NodeSDK({
+    traceExporter: new OTLPTraceExporter({
+      url: `${config.instrumentation.endpoint}/v1/traces`,
+      headers: { Authorization: `Bearer ${config.instrumentation.authenticationToken}` },
+    }),
+    logRecordProcessor: new logs.SimpleLogRecordProcessor(
+      new OTLPLogExporter({
+        url: `${config.instrumentation.endpoint}/v1/logs`,
+        headers: { Authorization: `Bearer ${config.instrumentation.authenticationToken}` },
+      }),
+    ),
+    instrumentations: [
+      getNodeAutoInstrumentations({
+        '@opentelemetry/instrumentation-fs': {
+          enabled: false,
+        },
+      }),
+    ],
+    resource: new Resource({
+      [SemanticResourceAttributes.SERVICE_NAME]: `${config.instrumentation.serviceName}`,
+    }),
+  })
+
+  sdk.start()
+}

backend/src/services/log.ts

@@ -1,5 +1,6 @@
 import { WritableStream } from 'node:stream/web'
 
+import { OpenTelemetryBunyanStream } from '@opentelemetry/instrumentation-bunyan'
 import bunyan from 'bunyan'
 import chalk from 'chalk'
 import { omit } from 'lodash-es'
@@ -149,6 +150,12 @@ if (process.env.NODE_ENV !== 'production') {
     stream: process.stdout,
   })
 }
+if (config.instrumentation.enabled) {
+  streams.push({
+    type: 'raw',
+    stream: new OpenTelemetryBunyanStream(),
+  })
+}
 
 const log = bunyan.createLogger({
   name: 'bailo',

backend/src/utils/__mocks__/config.ts

@@ -29,12 +29,9 @@ const config = {
       internal: 'https://localhost:5000',
     },
   },
-  oauth: {
+  instrumentation: {
     enabled: false,
   },
-  experimental: {
-    v2: true,
-  },
 }
 
 export default config

backend/src/utils/config.ts

@@ -129,9 +129,6 @@ export interface Config {
   }
 
   oauth: {
-    // Enabled only included for backward support with V1.
-    // After V1, authentication connector config should be used.
-    enabled: boolean
     provider: string
     grant: grant.GrantConfig | grant.GrantOptions
     cognito: {
@@ -145,6 +142,14 @@ export interface Config {
     modelCards: Array<DefaultSchema>
     accessRequests: Array<DefaultSchema>
   }
+
+  instrumentation: {
+    enabled: boolean
+    serviceName: string
+    endpoint: string
+    authenticationToken: string
+    debug: boolean
+  }
 }
 
 const config: Config = _config.util.toObject()

frontend/instrumentation.ts

@@ -0,0 +1,9 @@
+import { registerOTel } from '@vercel/otel'
+
+export async function register() {
+  if (process.env.OTEL_EXPORTER_OTLP_ENDPOINT && process.env.OTEL_EXPORTER_OTLP_HEADERS) {
+    registerOTel({
+      serviceName: 'frontend',
+    })
+  }
+}

frontend/next.config.mjs

@@ -25,6 +25,9 @@ const backend = process.env.BACKEND_SERVICE ?? defaultBackend
 
 /** @type {import('next').NextConfig} */
 const nextConfig = {
+  experimental: {
+    instrumentationHook: true,
+  },
   reactStrictMode: true,
   output: 'standalone',
   transpilePackages: ['nanoid', 'lodash-es'],