Adding OpenTelemetry collector/exporter for dev-env

- update of docker-compose.yml and podman-compose.yml
- added Jaeger to collect traces

[CLOUDDST-20308]

README.md

@@ -283,10 +283,13 @@ environment variables.
   This defaults to `False`. If this is set to `True`, `OTEL_EXPORTER_OTLP_ENDPOINT` and `OTEL_SERVICE_NAME`
   must be set.
 * `OTEL_EXPORTER_OTLP_ENDPOINT` - The endpoint for the OpenTelemetry exporter.
-* `OTEL_SERVICE_NAME` - "iib-api"
+* `OTEL_SERVICE_NAME` - "iib-api" / "iib-worker"
 
 For more info on these environment variables, please refer to [Opentelemetry Guide](https://opentelemetry.io/docs/concepts/sdk-configuration/otlp-exporter-configuration/)
 
+Dev-env supports Opentelemetry tracing by default. It uses Jaeger for collecting and exporting traces.
+WEB UI is accessible on port 16686 - `http://localhost:16686/`
+
 ## Configuring the Worker(s)
 
 To configure an IIB Celery worker, create a Python file at `/etc/iib/celery.py`. The location

compose-files/docker-compose.yml

@@ -63,6 +63,15 @@ services:
       # The RabbitMQ management console
       - 8081:15672
 
+  jaeger:
+    image: jaegertracing/all-in-one
+    container_name: jaeger
+    ports:
+      - 4318:4318
+      - 16686:16686 # web
+    environment:
+      - COLLECTOR_OTLP_ENABLED=true
+
   iib-api:
     build:
       context: ..
@@ -84,6 +93,11 @@ services:
       FLASK_ENV: development
       FLASK_APP: iib/web/wsgi.py
       IIB_DEV: 'true'
+      # enable OpenTelemetry for dev-env
+      IIB_OTEL_TRACING: 'true'
+      OTEL_EXPORTER_OTLP_ENDPOINT: http://jaeger:4318
+      OTEL_EXPORTER_OTLP_TRACES_INSECURE: 'true'
+      OTEL_SERVICE_NAME: "iib-api"
     volumes:
       - ../:/src:z
       - ../docker/message_broker/certs:/broker-certs:ro,z
@@ -95,6 +109,7 @@ services:
     depends_on:
       - db
       - message-broker
+      - jaeger
 
   iib-worker:
     build:
@@ -118,7 +133,12 @@ services:
       IIB_DEV: 'true'
       REGISTRY_AUTH_FILE: '/root/.docker/config.json'
       REQUESTS_CA_BUNDLE: /etc/pki/tls/certs/ca-bundle.crt
-    # Make this privileged to be able to build container images
+      # Make this privileged to be able to build container images
+      # enable OpenTelemetry for dev-env
+      IIB_OTEL_TRACING: 'true'
+      OTEL_EXPORTER_OTLP_ENDPOINT: http://jaeger:4318
+      OTEL_EXPORTER_OTLP_TRACES_INSECURE: 'true'
+      OTEL_SERVICE_NAME: "iib-worker"
     privileged: true
     volumes:
       - ../:/src:z
@@ -133,6 +153,7 @@ services:
       - registry
       - minica
       - memcached
+      - jaeger
 
   # This is an external message broker used to publish messages about state changes
   message-broker:

compose-files/podman-compose.yml

@@ -62,6 +62,15 @@ services:
       # The RabbitMQ management console
       - 8081:15672
 
+  jaeger:
+    image: jaegertracing/all-in-one
+    container_name: jaeger
+    ports:
+      - 4318:4318
+      - 16686:16686 # web
+    environment:
+      - COLLECTOR_OTLP_ENABLED=true
+
   iib-api:
     build:
       context: ..
@@ -83,6 +92,10 @@ services:
       FLASK_ENV: development
       FLASK_APP: iib/web/wsgi.py
       IIB_DEV: 'true'
+      IIB_OTEL_TRACING: 'true'
+      OTEL_EXPORTER_OTLP_ENDPOINT: http://jaeger:4318
+      OTEL_EXPORTER_OTLP_TRACES_INSECURE: 'true'
+      OTEL_SERVICE_NAME: "iib-api"
     volumes:
       - ../:/src
       - ../docker/message_broker/certs:/broker-certs
@@ -94,6 +107,7 @@ services:
     depends_on:
       - db
       - message-broker
+      - jaeger
 
   iib-worker:
     build:
@@ -117,7 +131,12 @@ services:
       IIB_DEV: 'true'
       REGISTRY_AUTH_FILE: '/root/.docker/config.json'
       REQUESTS_CA_BUNDLE: /etc/pki/tls/certs/ca-bundle.crt
-    # Make this privileged to be able to build container images
+      # Make this privileged to be able to build container images
+      # enable OpenTelemetry for dev-env
+      IIB_OTEL_TRACING: 'true'
+      OTEL_EXPORTER_OTLP_ENDPOINT: http://jaeger:4318
+      OTEL_EXPORTER_OTLP_TRACES_INSECURE: 'true'
+      OTEL_SERVICE_NAME: "iib-worker"
     privileged: true
     volumes:
       - ../:/src
@@ -133,6 +152,7 @@ services:
       - registry
       - minica
       - memcached
+      - jaeger
 
   # This is an external message broker used to publish messages about state changes
   message-broker: