Add Tracing to the Apodini Service (#93)

Co-authored-by: Paul Schmiedmayer <[email protected]>
Co-authored-by: Philipp Zagar <[email protected]>

.env

@@ -22,4 +22,9 @@ KIBANA_SYSTEM_PASSWORD=FA2021
 LOGSTASH_SYSTEM_USER=logstash_system
 LOGSTASH_SYSTEM_PASSWORD=FA2021
 
+# OpenTelemetry
+
+OTLP_HOST=otel-collector
+OTLP_PORT=4137
+
 REACT_APP_SCIENCE_LAB_MAP_ACCESS_TOKEN=<ACCESS TOKEN>

Observability/otel-collector/collector-config.yml

@@ -0,0 +1,21 @@
+receivers:
+  otlp:
+    protocols:
+      grpc:
+        endpoint: otel-collector:4317
+
+exporters:
+  logging:
+    logLevel: debug
+
+  jaeger:
+    endpoint: "jaeger:14250"
+    tls:
+      insecure: true
+
+
+service:
+  pipelines:
+    traces:
+      receivers: otlp
+      exporters: [logging, jaeger]

WebService/Package.swift

@@ -28,6 +28,7 @@ let package = Package(
                 .product(name: "ApodiniREST", package: "Apodini"),
                 .product(name: "ApodiniObserve", package: "Apodini"),
                 .product(name: "ApodiniObservePrometheus", package: "ApodiniObservePrometheus"),
+                .product(name: "ApodiniObserveOpenTelemetry", package: "Apodini"),
                 .product(name: "ApodiniOpenAPI", package: "Apodini"),
                 .product(name: "ApodiniDatabase", package: "Apodini"),
                 .product(name: "ApodiniAuthorization", package: "Apodini"),

WebService/Sources/WebService/main.swift

@@ -1,6 +1,7 @@
 import Foundation
 import Apodini
 import ApodiniObserve
+import ApodiniObserveOpenTelemetry
 import ApodiniObservePrometheus
 import ApodiniOpenAPI
 import ApodiniREST
@@ -57,6 +58,11 @@ struct FA2021WebService: WebService {
             ),
             systemMetricsConfiguration: .default
         )
+
+        // Setup of Tracing with an OpenTelemetry backend
+        TracingConfiguration(
+            .defaultOpenTelemetry(serviceName: "FA2021")
+        )
 
         // Setup of ApodiniAuthorization
         JWTSigner(.hs256(key: "secret"))
@@ -83,12 +89,16 @@ struct FA2021WebService: WebService {
     var content: some Component {
         MeasurementComponent()
             .record(.all)
+            .trace()
         SensorTypeComponent()
             .record(.all)
+            .trace()
         AuthComponent()
             .record(.all)
+            .trace()
         DummyComponent()
             .record(.all)
+            .trace()
     }
 }
 

docker-compose-develop.yml

@@ -132,6 +132,24 @@ services:
     depends_on:
       - prometheus
 
+  otel-collector:
+    image: otel/opentelemetry-collector-contrib:latest
+    container_name: otel-collector-develop
+    command: ["--config=/etc/config.yml"]
+    volumes:
+      - ./Observability/otel-collector/collector-config.yml:/etc/config.yml
+    ports:
+      # Expose on host port 4317
+      - 4317:4317
+    depends_on: [jaeger]
+
+  jaeger:
+    image: jaegertracing/all-in-one:latest
+    container_name: jaeger-develop
+    ports:
+      # Expose on host port 16686
+      - 16686:16686
+
 volumes:
   database-data:    # Volume for PostgreSQL
   elasticsearch:    # Volume for ElasticSearch

docker-compose.yml

@@ -36,6 +36,8 @@ services:
       POSTGRES_DB: ${POSTGRES_DB}
       LOGSTASH_HOST: ${LOGSTASH_HOST}
       LOGSTASH_PORT: ${LOGSTASH_PORT}
+      OTLP_HOST: ${OTLP_HOST}
+      OTLP_PORT: ${OTLP_PORT}
     expose:
       # The webservice is exposed internally to the reverse proxy
       - "8080"
@@ -222,6 +224,24 @@ services:
     depends_on:
       - prometheus
 
+  otel-collector:
+    image: otel/opentelemetry-collector-contrib:latest
+    container_name: otel-collector
+    command: ["--config=/etc/config.yml"]
+    volumes:
+      - ./Observability/otel-collector/collector-config.yml:/etc/config.yml
+    ports:
+      # Expose on host port 4317
+      - 4317:4317
+    depends_on: [jaeger]
+
+  jaeger:
+    image: jaegertracing/all-in-one:latest
+    container_name: jaeger
+    ports:
+      # Expose on host port 16686
+      - 16686:16686
+
 volumes:
   database-data: # Volume for PostgreSQL
   elasticsearch: # Volume for ElasticSearch