chore: add opentelemetry for bio-api

Signed-off-by: Manuel Ruck <[email protected]>

bundestag.io/api/manifests/deployment.yaml

@@ -25,6 +25,8 @@ spec:
               value: mongodb://democracy-mongo:27017/bundestagio
             - name: BIO_EDIT_TOKEN
               value: ${var.BIO_EDIT_TOKEN}
+            - name: OTEL_EXPORTER_OTLP_TRACES_URL
+              value: http://signoz-otel-collector:4318/v1/traces
 
           ports:
             - containerPort: 4000

bundestag.io/api/package.json

@@ -11,8 +11,8 @@
   "scripts": {
     "build": "tsc",
     "prebuild": "pnpm run generate",
-    "start": "node build/index.js",
-    "dev": "tsx watch src/index.ts",
+    "start": "node -r ./src/tracing.ts build/index.js",
+    "dev": "tsx watch --env-file=.env -r ./src/tracing.ts src/index.ts",
     "predev": "pnpm run generate",
     "lint": "pnpm lint:ts && pnpm lint:exports",
     "lint:es": "eslint src --ext .js,.jsx,.ts,.tsx",
@@ -27,6 +27,12 @@
     "@graphql-tools/merge": "^9.0.4",
     "@graphql-tools/schema": "^10.0.4",
     "@graphql-tools/utils": "^10.2.1",
+    "@opentelemetry/api": "^1.9.0",
+    "@opentelemetry/auto-instrumentations-node": "^0.48.0",
+    "@opentelemetry/exporter-trace-otlp-http": "^0.52.1",
+    "@opentelemetry/resources": "^1.25.1",
+    "@opentelemetry/sdk-node": "^0.52.1",
+    "@opentelemetry/semantic-conventions": "^1.25.1",
     "axios": "1.6.0",
     "body-parser": "^1.20.2",
     "cors": "^2.8.5",

bundestag.io/api/src/tracing.ts

@@ -0,0 +1,41 @@
+const { NodeSDK } = require('@opentelemetry/sdk-node');
+const { getNodeAutoInstrumentations } = require('@opentelemetry/auto-instrumentations-node');
+const { OTLPTraceExporter } = require('@opentelemetry/exporter-trace-otlp-http');
+const { Resource } = require('@opentelemetry/resources');
+const { SemanticResourceAttributes } = require('@opentelemetry/semantic-conventions');
+
+if (!process.env.OTEL_EXPORTER_OTLP_TRACES_URL) {
+  console.warn('OTEL_EXPORTER_OTLP_TRACES_URL is not set, tracing will not be enabled');
+} else {
+  // do not set headers in exporterOptions, the OTel spec recommends setting headers through ENV variables
+  // https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md#specifying-headers-via-environment-variables
+
+  // highlight-start
+  const exporterOptions = {
+    url: process.env.OTEL_EXPORTER_OTLP_TRACES_URL,
+  };
+  // highlight-end
+
+  const traceExporter = new OTLPTraceExporter(exporterOptions);
+  const sdk = new NodeSDK({
+    traceExporter,
+    instrumentations: [getNodeAutoInstrumentations()],
+    resource: new Resource({
+      // highlight-next-line
+      [SemanticResourceAttributes.SERVICE_NAME]: 'bundestag-io-api',
+    }),
+  });
+
+  // initialize the SDK and register with the OpenTelemetry API
+  // this enables the API to record telemetry
+  sdk.start();
+
+  // gracefully shut down the SDK on process exit
+  process.on('SIGTERM', () => {
+    sdk
+      .shutdown()
+      .then(() => console.log('Tracing terminated'))
+      .catch((error) => console.log('Error terminating tracing', error))
+      .finally(() => process.exit(0));
+  });
+}

infra/opentelemetry/garden.yaml

@@ -0,0 +1,62 @@
+kind: Deploy
+type: helm
+name: cert-manager
+
+spec:
+  chart:
+    name: cert-manager
+    repo: https://charts.jetstack.io
+    version: v1.15.1
+  values:
+    installCRDs: true
+---
+kind: Deploy
+type: helm
+name: opentelemetry
+
+dependencies:
+  - deploy.cert-manager
+
+spec:
+  chart:
+    name: opentelemetry-operator
+    repo: https://open-telemetry.github.io/opentelemetry-helm-charts
+    version: '0.64.2'
+  values:
+    manager:
+      collectorImage:
+        repository: otel/opentelemetry-collector
+---
+kind: Deploy
+type: helm
+name: signoz
+
+dependencies:
+  - deploy.opentelemetry
+
+spec:
+  chart:
+    name: signoz
+    repo: https://charts.signoz.io
+    version: 0.46.0
+  values:
+    frontend:
+      ingress:
+        enabled: true
+        hosts:
+          - host: 'signoz.${var.hostname}'
+            paths:
+              - path: /
+                pathType: Prefix
+                port: 3301
+    otelCollector:
+      ingress:
+        enabled: true
+        hosts:
+          - host: 'otelcollector.${var.hostname}'
+            paths:
+              - path: /
+                pathType: Prefix
+                port: 4318
+    schemaMigrator:
+      enabled: false