feature: add open telemetry integration

Author: fcarreno-collab

backend/.env.example

@@ -28,4 +28,13 @@ OAUTH2_CLIENT_SECRET=
 OAUTH2_ADD_SCOPE=config-values/add config-values/write
 OAUTH2_UPDATE_SCOPE=config-values/update config-values/write
 OAUTH2_DELETE_SCOPE=config-values/delete config-values/write
-OAUTH2_CLONE_SCOPE=config-values/clone config-values/write
+OAUTH2_CLONE_SCOPE=config-values/clone config-values/write
+
+# open telemetry integration
+OTEL_INSTRUMENTATION_ENABLED=true
+OTEL_SERVICE_NAME=marketing-api
+OTEL_EXPORTER_OTLP_ENDPOINT=http://collector.fnvirtual.app:4318/v1/traces
+OTEL_PROPAGATORS=tracecontext,baggage
+OTEL_PYTHON_LOG_CORRELATION=true
+# set it to otel_endpoint, console or null (just tu run tests locally)
+OTEL_EXPORTER_MODE=otel_endpoint

backend/env_var_eval.py

@@ -0,0 +1,7 @@
+import os
+
+def env_bool(name: str, default: bool = False) -> bool:
+    value = os.getenv(name)
+    if value is None:
+        return default
+    return value.strip().lower() in ("1", "true")

backend/otel_instrumentation.py

@@ -0,0 +1,97 @@
+import os
+from opentelemetry import baggage as baggage_api
+from opentelemetry import trace
+from opentelemetry.instrumentation.django import DjangoInstrumentor
+from opentelemetry.instrumentation.mysqlclient import MySQLClientInstrumentor
+from opentelemetry.instrumentation.redis import RedisInstrumentor
+from opentelemetry.sdk.resources import Resource
+from opentelemetry.sdk.trace import TracerProvider
+from opentelemetry.sdk.trace.export import BatchSpanProcessor, ConsoleSpanExporter
+from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter
+
+
+OTEL_EXPORTER_OTLP_ENDPOINT = os.getenv('OTEL_EXPORTER_OTLP_ENDPOINT')
+OTEL_EXPORTER_MODE = os.getenv('OTEL_EXPORTER_MODE')
+
+class DjangoTelemetry:
+
+    @staticmethod
+    def request_hook(span, request):
+        if not span.is_recording():
+            return
+
+        # Attach CF-Ray header
+        span.set_attribute("cf.ray_id", request.headers.get("Cf-Ray", ""))
+
+        # Attach baggage if present
+        baggage_val = baggage_api.get_baggage("cf.ray_id")
+        if baggage_val:
+            span.set_attribute("baggage.cf.ray_id", baggage_val)
+
+    @staticmethod
+    def response_hook(span, request, response):
+        if span.is_recording() and hasattr(response, "content"):
+            span.set_attribute("http.response.length", len(response.content))
+
+    @staticmethod
+    def mysql_hook(span, instance, cursor, statement, parameters):
+        """Enrich MySQL spans with DB info"""
+        if not span.is_recording():
+            return
+        try:
+            span.set_attribute("db.system", "mysql")
+            span.set_attribute("db.name", os.getenv('DB_NAME', 'db'))
+            span.set_attribute("db.statement", statement)
+        except Exception:
+            pass
+
+    @staticmethod
+    def redis_hook(span, instance, args, kwargs):
+        """Enrich Redis spans with command + keys"""
+        if not span.is_recording():
+            return
+        try:
+            cmd = args[0] if args else ""
+            span.set_attribute("db.system", "redis")
+            span.set_attribute("redis.command", cmd)
+            if len(args) > 1:
+                # Add first key only (avoid leaking big payloads)
+                span.set_attribute("redis.key", str(args[1]))
+        except Exception:
+            pass
+
+    @classmethod
+    def setup(cls, environment):
+        if environment != "test":
+            # set the OTEL_EXPORTER_MODE to null
+            # No Exporter setup if the env is dev and you want to run the tests locally
+            if OTEL_EXPORTER_MODE:
+                resource = Resource.create({
+                    "service.name": os.getenv("OTEL_SERVICE_NAME", "marketing-api")
+                })
+                # Provider with resource
+                provider = TracerProvider(resource=resource)
+                trace.set_tracer_provider(provider)
+                if OTEL_EXPORTER_MODE == "otel_endpoint":
+                    exporter = OTLPSpanExporter(endpoint=OTEL_EXPORTER_OTLP_ENDPOINT)
+                    provider.add_span_processor(BatchSpanProcessor(exporter))
+                elif OTEL_EXPORTER_MODE == "console":
+                    exporter = ConsoleSpanExporter()
+                    provider.add_span_processor(BatchSpanProcessor(exporter))
+
+        # Django
+        DjangoInstrumentor().instrument(
+            request_hook=cls.request_hook,
+            response_hook=cls.response_hook,
+        )
+        # MySQL
+        MySQLClientInstrumentor().instrument(
+            enable_commenter=True,
+            cursor_instrumentation_enabled=True,
+            span_callback=cls.mysql_hook,
+        )
+        # Redis
+        RedisInstrumentor().instrument(
+            tracer_provider=trace.get_tracer_provider(),
+            request_hook=cls.redis_hook,
+        )

backend/settings.py

@@ -339,6 +339,15 @@
     os.path.join(BASE_DIR, "backend/media"),
 ]
 
+DEV_EMAIL = os.getenv('DEV_EMAIL')
+
+from backend.env_var_eval import env_bool
+OTEL_INSTRUMENTATION_ENABLED = env_bool('OTEL_INSTRUMENTATION_ENABLED', True)
+
+if OTEL_INSTRUMENTATION_ENABLED:
+    from .otel_instrumentation import DjangoTelemetry
+    DjangoTelemetry.setup(ENV)
+
 # Import local settings
 try:
     from .settings_local import *

requirements.txt

@@ -46,3 +46,12 @@ stevedore==1.32.0
 uritemplate==3.0.1
 urllib3==1.25.9
 wrapt==1.12.1
+
+#open-telemetry integration
+opentelemetry-distro==0.48b0
+opentelemetry-sdk==1.27.0
+opentelemetry-exporter-otlp==1.27.0
+opentelemetry-instrumentation-django==0.48b0
+opentelemetry-instrumentation-requests==0.48b0
+opentelemetry-instrumentation-mysqlclient==0.48b0
+opentelemetry-instrumentation-redis==0.48b0