feat: OpenTelemetry 추가

Author: MU-Software

app/core/__init__.py

@@ -1,9 +1,16 @@
 from os import environ
 
 from celery import Celery
+from celery.signals import worker_process_init
+from core.observability import configure_opentelemetry
 
 environ.setdefault("DJANGO_SETTINGS_MODULE", "core.settings")
 
 celery_app = Celery("pyconkr")
 celery_app.config_from_object("django.conf:settings", namespace="CELERY")
 celery_app.autodiscover_tasks()
+
+
+@worker_process_init.connect
+def _init_opentelemetry(**_kwargs):
+    configure_opentelemetry(role="worker")

app/core/gunicorn_conf.py

@@ -0,0 +1,11 @@
+import os
+
+from core.observability import configure_opentelemetry
+
+bind = os.environ.get("GUNICORN_BIND", "0.0.0.0:8000")
+workers = int(os.environ.get("GUNICORN_WORKERS", "4"))
+timeout = int(os.environ.get("GUNICORN_TIMEOUT", "30"))
+
+
+def post_fork(server, worker):
+    configure_opentelemetry(role="api")

app/core/logger/filter/otel.py

@@ -0,0 +1,15 @@
+from logging import Filter, LogRecord
+
+from opentelemetry import trace
+
+
+class OtelTraceContextFilter(Filter):
+    def filter(self, record: LogRecord) -> bool:
+        ctx = trace.get_current_span().get_span_context()
+        if ctx.is_valid:
+            record.otelTraceID = format(ctx.trace_id, "032x")
+            record.otelSpanID = format(ctx.span_id, "016x")
+        else:
+            record.otelTraceID = "0"
+            record.otelSpanID = "0"
+        return True

app/core/observability.py

@@ -0,0 +1,71 @@
+import logging
+import os
+from typing import Literal
+
+from opentelemetry import metrics, trace
+from opentelemetry.exporter.otlp.proto.http.metric_exporter import OTLPMetricExporter
+from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter
+from opentelemetry.instrumentation.celery import CeleryInstrumentor
+from opentelemetry.instrumentation.django import DjangoInstrumentor
+from opentelemetry.instrumentation.httpx import HTTPXClientInstrumentor
+from opentelemetry.instrumentation.psycopg import PsycopgInstrumentor
+from opentelemetry.instrumentation.redis import RedisInstrumentor
+from opentelemetry.instrumentation.requests import RequestsInstrumentor
+from opentelemetry.sdk.metrics import MeterProvider
+from opentelemetry.sdk.metrics.export import PeriodicExportingMetricReader
+from opentelemetry.sdk.resources import Resource
+from opentelemetry.sdk.trace import TracerProvider
+from opentelemetry.sdk.trace.export import BatchSpanProcessor
+
+RoleType = Literal["api", "worker"]
+logger = logging.getLogger(__name__)
+
+_configured = False
+
+
+def _flag(name: str, default: bool) -> bool:
+    return os.environ.get(name, str(default)).strip().lower() in ("1", "true", "yes", "on")
+
+
+def _get_otlp_endpoint() -> str | None:
+    return os.environ.get("OTEL_EXPORTER_OTLP_ENDPOINT") or os.environ.get("OTEL_EXPORTER_OTLP_TRACES_ENDPOINT")
+
+
+def configure_opentelemetry(role: RoleType) -> None:
+    global _configured
+    if _configured or _flag("OTEL_SDK_DISABLED", False) or not _get_otlp_endpoint():
+        return
+    _configured = True
+
+    try:
+        resource = Resource.create(
+            {
+                "service.name": os.environ.get("OTEL_SERVICE_NAME", f"pyconkr-{role}"),
+                "service.namespace": "pyconkr",
+                "pyconkr.process_role": role,
+                "service.version": os.environ.get("DEPLOYMENT_RELEASE_VERSION", "unknown"),
+                "deployment.environment": os.environ.get("API_STAGE", "unknown"),
+            }
+        )
+
+        if _flag("OTEL_TRACES_ENABLED", True):
+            provider = TracerProvider(resource=resource)
+            provider.add_span_processor(BatchSpanProcessor(OTLPSpanExporter()))
+            trace.set_tracer_provider(provider)
+        if _flag("OTEL_METRICS_ENABLED", True):
+            metrics.set_meter_provider(
+                MeterProvider(
+                    resource=resource,
+                    metric_readers=[PeriodicExportingMetricReader(OTLPMetricExporter())],
+                )
+            )
+        DjangoInstrumentor().instrument()
+        PsycopgInstrumentor().instrument()
+        CeleryInstrumentor().instrument()
+        RedisInstrumentor().instrument()
+        HTTPXClientInstrumentor().instrument()
+        RequestsInstrumentor().instrument()
+
+        logger.info("OpenTelemetry configured (role=%s)", role)
+    except Exception:
+        logger.exception("OpenTelemetry 초기화 실패 — 계측 없이 계속 진행")

app/core/settings.py

@@ -41,14 +41,19 @@
     "version": 1,
     "disable_existing_loggers": False,
     "formatters": {
-        "basic": {"format": "%(asctime)s:%(module)s:%(levelname)s:%(message)s", "datefmt": "%Y-%m-%d %H:%M:%S"},
+        "basic": {
+            "format": "%(asctime)s:%(module)s:%(levelname)s:%(message)s trace_id=%(otelTraceID)s",
+            "datefmt": "%Y-%m-%d %H:%M:%S",
+        },
         "slack": {"()": "core.logger.formatter.slack.SlackJsonFormatter"},
     },
+    "filters": {"otel_trace": {"()": "core.logger.filter.otel.OtelTraceContextFilter"}},
     "handlers": {
         "console": {
             "level": LOG_LEVEL,
             "class": "logging.StreamHandler",
             "formatter": "basic",
+            "filters": ["otel_trace"],
         },
         "slack": {
             "level": LOG_LEVEL,

infra/server.Dockerfile

@@ -49,4 +49,4 @@ EXPOSE 8000
 
 # The reason for using nobody user is to avoid running the app as root, which can be a security risk.
 USER nobody
-CMD ["gunicorn", "core.wsgi:application", "--bind", "0.0.0.0:8000", "--workers", "4", "--timeout", "30"]
+CMD ["gunicorn", "core.wsgi:application", "-c", "core/gunicorn_conf.py"]

pyproject.toml

@@ -40,6 +40,14 @@ dependencies = [
     "shortuuid>=1.0.13",
     "qrcode[pil]>=8.0",
     "weasyprint>=63.0",
+    "opentelemetry-sdk>=1.42.1",
+    "opentelemetry-exporter-otlp-proto-http>=1.42.1",
+    "opentelemetry-instrumentation-django>=0.63b1",
+    "opentelemetry-instrumentation-psycopg>=0.63b1",
+    "opentelemetry-instrumentation-celery>=0.63b1",
+    "opentelemetry-instrumentation-redis>=0.63b1",
+    "opentelemetry-instrumentation-httpx>=0.63b1",
+    "opentelemetry-instrumentation-requests>=0.63b1",
 ]
 
 [dependency-groups]