Add OpenTelemetry (#218)

Dockerfile

@@ -32,6 +32,6 @@ COPY --from=build /app/wait-for.sh .
 COPY --from=build /app/node_modules ./node_modules
 
 EXPOSE 9004
-ENTRYPOINT [ "./entrypoint.sh" ]
+ENTRYPOINT ["./entrypoint.sh"]
 
 CMD ["node", "index.js"]

Dockerfile.dev

@@ -15,5 +15,5 @@ EXPOSE 9004
 
 ENV OPENSLIDES_DEVELOPMENT 1
 
-ENTRYPOINT [ "./entrypoint.sh" ]
-CMD ["npm", "run", "dev"]
+ENTRYPOINT ["./entrypoint.sh"]
+CMD ["node", "node_modules/.bin/nodemon", "src/index.ts"]

Dockerfile.test

@@ -30,5 +30,5 @@ EXPOSE 9004
 
 ENV OPENSLIDES_DEVELOPMENT 1
 
-ENTRYPOINT [ "./entrypoint.sh" ]
-CMD ["npm", "run", "dev"]
+ENTRYPOINT ["./entrypoint.sh"]
+CMD ["node", "node_modules/.bin/nodemon", "src/index.ts"]

auth/package.json

@@ -59,6 +59,12 @@
         "typescript": "^5.3.3"
     },
     "dependencies": {
+        "@opentelemetry/api": "^1.7.0",
+        "@opentelemetry/exporter-trace-otlp-grpc": "^0.46.0",
+        "@opentelemetry/instrumentation": "^0.46.0",
+        "@opentelemetry/instrumentation-express": "^0.34.0",
+        "@opentelemetry/instrumentation-http": "^0.46.0",
+        "@opentelemetry/sdk-node": "^0.46.0",
         "argon2": "^0.31.2",
         "axios": "^1.6.5",
         "final-di": "^1.0.10-alpha.1",

auth/src/config/index.ts

@@ -18,6 +18,14 @@ export class Config {
     private static readonly VERBOSE_TRUE_FIELDS = ['1', 'true', 'on'];
 
     public static isDevMode(): boolean {
-        return this.VERBOSE_TRUE_FIELDS.includes((process.env.OPENSLIDES_DEVELOPMENT || '').toLowerCase());
+        return this.isTruthy(process.env.OPENSLIDES_DEVELOPMENT);
+    }
+
+    public static isOtelEnabled(): boolean {
+        return this.isTruthy(process.env.OPENTELEMETRY_ENABLED);
+    }
+
+    private static isTruthy(value?: string): boolean {
+        return this.VERBOSE_TRUE_FIELDS.includes(value?.toLowerCase() || '');
     }
 }

auth/src/express/controllers/public-controller.ts

@@ -10,6 +10,7 @@ import { AnonymousException } from '../../core/exceptions/anonymous-exception';
 import { anonymous } from '../../core/models/anonymous';
 import { AuthServiceResponse } from '../../util/helper/definitions';
 import { createResponse } from '../../util/helper/functions';
+import { makeSpan } from '../../util/otel';
 
 @RestController({
     prefix: 'system/auth'
@@ -41,21 +42,23 @@ export class PublicController {
         @Cookie(AuthHandler.COOKIE_NAME) cookieAsString: string,
         @Res() res: Response
     ): Promise<AuthServiceResponse> {
-        try {
-            const ticket = await this._authHandler.whoAmI(cookieAsString);
-            res.setHeader(AuthHandler.AUTHENTICATION_HEADER, ticket.token.toString());
-            return createResponse();
-        } catch (e) {
-            Logger.debug('Error while who-am-i');
-            Logger.debug(e);
-            res.clearCookie(AuthHandler.COOKIE_NAME);
-            if (e instanceof AnonymousException) {
-                return createResponse(anonymous, 'anonymous');
+        return makeSpan('who-am-i', async () => {
+            try {
+                const ticket = await this._authHandler.whoAmI(cookieAsString);
+                res.setHeader(AuthHandler.AUTHENTICATION_HEADER, ticket.token.toString());
+                return createResponse();
+            } catch (e) {
+                Logger.debug('Error while who-am-i');
+                Logger.debug(e);
+                res.clearCookie(AuthHandler.COOKIE_NAME);
+                if (e instanceof AnonymousException) {
+                    return createResponse(anonymous, 'anonymous');
+                }
+                if (e instanceof TokenExpiredError) {
+                    return createResponse(anonymous, 'anonymous');
+                }
+                throw e;
             }
-            if (e instanceof TokenExpiredError) {
-                return createResponse(anonymous, 'anonymous');
-            }
-            throw e;
-        }
+        });
     }
 }

auth/src/express/controllers/secure-controller.ts

@@ -7,6 +7,7 @@ import { AuthService } from '../../api/services/auth-service';
 import { Token } from '../../core/ticket/token';
 import { AuthServiceResponse } from '../../util/helper/definitions';
 import { createResponse } from '../../util/helper/functions';
+import { makeSpan } from '../../util/otel';
 import { TicketMiddleware } from '../middleware/ticket-validator';
 
 @RestController({
@@ -44,9 +45,11 @@ export class SecureController {
 
     @OnPost('clear-all-sessions')
     public async clearAllSessions(@Res() res: Response): Promise<AuthServiceResponse> {
-        const token = res.locals['token'] as Token;
-        await this._authHandler.clearAllSessions(token.userId);
-        return createResponse();
+        return makeSpan('clear-all-sessions', async () => {
+            const token = res.locals['token'] as Token;
+            await this._authHandler.clearAllSessions(token.userId);
+            return createResponse();
+        });
     }
 
     @OnPost('clear-session-by-id')

auth/src/index.ts

@@ -1,8 +1,10 @@
+import './init';
 import { Request, Response } from 'express';
 import { RestApplication } from 'rest-app';
 
 import { Logger } from './api/services/logger';
 import { PrivateController, PublicController, SamlController, SecureController } from './express/controllers';
+import { addShutdownHook } from './util/helper/functions';
 
 const logRequestInformation = (req: Request): void => {
     Logger.log(`${req.protocol}://${req.headers.host || ''}: ${req.method} -- ${req.originalUrl}`);
@@ -52,8 +54,8 @@ class Server {
     }
 
     public start(): void {
-        process.on('SIGTERM', () => {
-            Logger.log('SIGTERM received, shutting down');
+        addShutdownHook(() => {
+            Logger.log('Kill signal received, shutting down');
             process.exit(0);
         });
         this._application.start();

auth/src/init.ts

@@ -0,0 +1,3 @@
+import { initOtel } from './util/otel';
+
+initOtel();

auth/src/util/helper/functions.ts

@@ -5,3 +5,9 @@ export const createResponse = <T = unknown>(
     message: string = 'Action handled successfully',
     success: boolean = true
 ): AuthServiceResponse => ({ message, success, ...data });
+
+export const addShutdownHook = (func: () => void): void => {
+    ['SIGINT', 'SIGTERM'].forEach(signal => {
+        process.on(signal, func);
+    });
+};

auth/src/util/otel.ts

@@ -0,0 +1,51 @@
+import { Span, trace } from '@opentelemetry/api';
+import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-grpc';
+import { registerInstrumentations } from '@opentelemetry/instrumentation';
+import { ExpressInstrumentation } from '@opentelemetry/instrumentation-express';
+import { HttpInstrumentation } from '@opentelemetry/instrumentation-http';
+import { Resource } from '@opentelemetry/resources';
+import { BatchSpanProcessor } from '@opentelemetry/sdk-trace-base';
+import { NodeTracerProvider } from '@opentelemetry/sdk-trace-node';
+import { SemanticResourceAttributes } from '@opentelemetry/semantic-conventions';
+
+import { addShutdownHook } from './helper';
+import { Logger } from '../api/services/logger';
+import { Config } from '../config';
+
+export const initOtel = (): void => {
+    if (!Config.isOtelEnabled()) {
+        return;
+    }
+    const provider = new NodeTracerProvider({
+        resource: new Resource({
+            [SemanticResourceAttributes.SERVICE_NAME]: 'auth'
+        })
+    });
+    const exporter = new OTLPTraceExporter({
+        url: 'http://collector:4317'
+    });
+    provider.addSpanProcessor(new BatchSpanProcessor(exporter));
+    provider.register();
+    trace.setGlobalTracerProvider(provider);
+    registerInstrumentations({
+        instrumentations: [new HttpInstrumentation(), new ExpressInstrumentation()]
+    });
+    addShutdownHook(() => {
+        provider.shutdown().catch(err => Logger.error(err));
+    });
+    Logger.log('OpenTelemetry initialized');
+};
+
+export const makeSpan = <F extends () => ReturnType<F>>(name: string, fn: F): ReturnType<F> => {
+    if (Config.isOtelEnabled()) {
+        return trace.getTracer('auth').startActiveSpan(name, (span: Span) => {
+            try {
+                return fn();
+            } finally {
+                span.end();
+            }
+        });
+    } else {
+        return fn();
+    }
+};