Bootstrap dormant OpenTelemetry wiring in the Django backend by Nazehs · Pull Request #1583 · i-dot-ai/consult

Nazehs · 2026-08-28T09:57:44Z

Context

Wires the dormant OTel seam into the Django request path: instruments Django and re-applies the structlog trace-context processor after the logger is built, so the existing request log line picks up trace/span ids. There's no parallel request logger, so nothing gets logged twice.

Changes proposed in this pull request

New backend/otel_common.py: shared otel_requested() gating, so the Django and worker bootstraps can't drift. otel_django.py and otel_bootstrap.py both use it.
New backend/otel_django.py: when enabled, configures the tracer provider and re-applies the structlog processors in AppConfig.ready() (non-worker only, the worker has its own bootstrap). Warn-and-continue if the [otel] extra is missing or setup fails, so telemetry never blocks startup.
Aligned otel_bootstrap.py to the same broad warn-and-continue.
Integration test drives the enabled path against an in-memory exporter, asserting the active span is exported and the existing logs carry matching trace_id/span_id. Unit tests cover the gating and warn-and-continue.

linear-code · 2026-08-28T09:57:46Z

PRO-647

github-actions · 2026-08-28T11:51:18Z

Claude finished @Nazehs's task in 41s —— View job

PR Review: Bootstrap dormant OpenTelemetry wiring in the Django backend

Clean, well-tested bootstrap. The dormant-by-default gating is solid. A couple of minor points:

backend/otel_django.py:22 — install_middleware mutates the list in-place via .insert() and also returns it. Callers get silent aliasing; a copy would be safer.

⚪️ NIT: return middleware → work on a copy: mw = list(middleware); mw.insert(...); return mw

backend/otel_django.py:55 — except RuntimeError may not cover all exporter init failures (e.g. OSError, ConnectionRefusedError at startup).

🔵 CONSIDER: broadening to except Exception or checking what the library actually raises, to keep warn-and-continue robust.

backend/tests/unit/test_otel_django.py — no test for the case where AuthenticationMiddleware is absent (falls back to appending).

⚪️ NIT: Add a case to confirm the fallback path.

github-actions · 2026-08-28T12:08:00Z

Claude finished @Nazehs's task in 36s —— View job

PR Review: Bootstrap dormant OpenTelemetry wiring in the Django backend

Clean, dormant-by-default OTel bootstrap. Consistent with otel_bootstrap.py patterns. One structural note:

backend/otel_django.py & backend/otel_bootstrap.py — otel_requested(), OTEL_ENDPOINT_ENV, and OTEL_ENABLED_ENV are duplicated across both modules with identical logic.

⚪️ NIT: Extract to a shared otel_utils.py or otel_common.py to avoid drift. Fix this →

backend/otel_bootstrap.py:50 — now inconsistent: otel_django.py (this PR) correctly uses except Exception but otel_bootstrap.py still narrows to except RuntimeError, missing OSError/ConnectionRefusedError.

🔵 CONSIDER: Aligning otel_bootstrap.py to use except Exception for the same warn-and-continue robustness. Fix this →

Otherwise solid — gating, warn-and-continue, test coverage all look good. ✅

github-actions · 2026-08-28T12:23:54Z

Claude finished @Nazehs's task in 41s —— View job

PR Review: Bootstrap dormant OpenTelemetry wiring in the Django backend

Clean, well-structured OTel bootstrap. The dormant-by-default gating is solid. Previous review concerns (shared module, except Exception) have been addressed. One structural note:

backend/consultations/apps.py:4 vs :15 — import otel_django is at module level, but from otel_bootstrap import bootstrap_otel is inside the if block. The top-level import means any load-time error in otel_django.py itself (not the guarded inner imports) would crash Django startup before ready() can warn-and-continue.

⚪️ NIT: Move import otel_django inside the else branch to be consistent with the worker path and keep the same startup-safety guarantee.

backend/tests/unit/test_otel_django.py:25-55 — tests call otel_django.otel_requested() (a re-exported symbol), effectively retesting otel_common.otel_requested() which is already covered identically in test_otel_bootstrap.py.

⚪️ NIT: Test the gating logic once in test_otel_common.py and trim these duplicate cases, keeping only the Django-specific configure_django_otel tests here.

Otherwise solid. ✅

Add an OTel request-path seam that stays a no-op unless OTEL_ENABLED and a collector endpoint are set (dev only via Terraform), so prod keeps running on the existing StructuredLogger with no behaviour change. - otel_django.py gates on env, inserts StructuredLoggingMiddlewareOTel after auth, and configures the tracer provider + structlog processors in ready() - settings expose I_DOT_AI_LOGGER and install the middleware conditionally - warn-and-continue if the [otel] extra or exporter is unavailable

github-actions · 2026-08-28T14:46:25Z

Claude finished @Nazehs's task in 31s —— View job

PR Review: Bootstrap dormant OpenTelemetry wiring in the Django backend

Gather context
Read changed files
Post review

Clean implementation. Previous review concerns (shared module, except Exception, lazy imports) are all resolved. otel_common.py is appropriately minimal, warn-and-continue is consistent across both bootstraps, and the integration test asserting trace/span correlation on existing logs is the right level of coverage.

No issues to raise. ✅

252afh · 2026-08-28T14:19:18Z

@@ -14,6 +15,8 @@ def ready(self):
            from otel_bootstrap import bootstrap_otel


separate note: can we avoid inline imports, they should be top-level only, unless ABSOLUTELY necessary

252afh · 2026-08-28T14:22:39Z

+
+def otel_requested() -> bool:
+    """Telemetry is requested only when the flag is on and an endpoint is set."""
+    enabled = os.environ.get(OTEL_ENABLED_ENV, "").strip().lower() == "true"


Should be able to use the django settings here instead to access the var. Also, don't name env vars with env on the end, it's assumed already

252afh · 2026-08-28T14:22:53Z

+
+import os
+
+OTEL_ENDPOINT_ENV = "OTEL_EXPORTER_OTLP_ENDPOINT"


Can we remove string assignments at the top of files that are only used once within the file

252afh · 2026-08-28T14:27:47Z

-    """Bootstrap only when the flag is on and a collector endpoint is configured."""
-    enabled = os.environ.get(OTEL_ENABLED_ENV, "").strip().lower() == "true"
-    return enabled and bool(os.environ.get(OTEL_ENDPOINT_ENV))
+_TRACER_NAME = "consult.worker"


This string isn't used anywhere else, just set it on line 41 instead

252afh · 2026-08-28T14:28:59Z

+
+from otel_common import otel_requested
+
+_SERVICE_NAME = "consult-backend"


These service names could come from the django env and set in terraform, to save them being defined in code instead

252afh · 2026-08-28T14:29:55Z

+    if not otel_requested():
+        return
+
+    try:


I'm not sure why we need this check?

252afh · 2026-08-28T14:31:14Z

@@ -0,0 +1,41 @@
+"""OpenTelemetry bootstrap for the Django request path.


Is there anything in this file that stops it being done as part of the django settings setup instead, similar to how the sentry init is done?

252afh · 2026-08-28T14:51:19Z

 def _clear_otel_env(monkeypatch):
-    monkeypatch.delenv(otel_bootstrap.OTEL_ENDPOINT_ENV, raising=False)
-    monkeypatch.delenv(otel_bootstrap.OTEL_ENABLED_ENV, raising=False)
+    monkeypatch.delenv(otel_common.OTEL_ENDPOINT_ENV, raising=False)


These files are currently the only place in the backend where we have monkeypatch. Could we make use of env vars and patch instead to align with other locations, e.g.:

def _clear_otel_env(): with patch.dict(os.environ, {otel_bootstrap.OTEL_ENDPOINT_ENV: "", otel_bootstrap.OTEL_ENABLED_ENV: ""}, clear=False):

252afh · 2026-08-28T14:53:03Z

+
+import otel_common
+
+ENDPOINT = "http://collector:4317"


The URL for the collector should be an env var

252afh · 2026-08-28T14:54:10Z

+ENDPOINT = "http://collector:4317"
+
+
+@pytest.fixture(autouse=True)


Fixtures belong in the conftest.py file

Nazehs force-pushed the pro-647-bootstrap-opentelemetry-in-the-django-backend branch 3 times, most recently from 52a4fed to 00d6af5 Compare August 28, 2026 11:35

Nazehs marked this pull request as ready for review August 28, 2026 11:49

Nazehs requested a review from a team as a code owner August 28, 2026 11:49

Nazehs requested review from 252afh and removed request for a team August 28, 2026 11:49

Nazehs force-pushed the pro-647-bootstrap-opentelemetry-in-the-django-backend branch from 00d6af5 to 0c47603 Compare August 28, 2026 12:07

Nazehs force-pushed the pro-647-bootstrap-opentelemetry-in-the-django-backend branch from 0c47603 to 41bb41a Compare August 28, 2026 12:23

Nazehs force-pushed the pro-647-bootstrap-opentelemetry-in-the-django-backend branch from 41bb41a to 9bbcc67 Compare August 28, 2026 14:45

252afh requested changes Aug 28, 2026

View reviewed changes

252afh reviewed Aug 28, 2026

View reviewed changes

		@@ -14,6 +15,8 @@ def ready(self):
		from otel_bootstrap import bootstrap_otel


		from otel_common import otel_requested

		_SERVICE_NAME = "consult-backend"

		@@ -0,0 +1,41 @@
		"""OpenTelemetry bootstrap for the Django request path.

		ENDPOINT = "http://collector:4317"


		@pytest.fixture(autouse=True)

Uh oh!

Conversation

Nazehs commented Aug 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Context

Changes proposed in this pull request

Uh oh!

linear-code Bot commented Aug 28, 2026

Uh oh!

github-actions Bot commented Aug 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Review: Bootstrap dormant OpenTelemetry wiring in the Django backend

Uh oh!

github-actions Bot commented Aug 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Review: Bootstrap dormant OpenTelemetry wiring in the Django backend

Uh oh!

github-actions Bot commented Aug 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Review: Bootstrap dormant OpenTelemetry wiring in the Django backend

Uh oh!

github-actions Bot commented Aug 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Review: Bootstrap dormant OpenTelemetry wiring in the Django backend

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Nazehs commented Aug 28, 2026 •

edited

Loading

github-actions Bot commented Aug 28, 2026 •

edited

Loading

github-actions Bot commented Aug 28, 2026 •

edited

Loading

github-actions Bot commented Aug 28, 2026 •

edited

Loading

github-actions Bot commented Aug 28, 2026 •

edited

Loading