A reactive notebook for Python — run reproducible experiments, query with SQL, execute as a script, deploy as an app, and version with git. Stored as pure Python. All in a modern, AI-native editor.
Python artificial-intelligencedagdata-sciencedata-visualizationdataflowdeveloper-toolsmachine-learningnotebookspipelinepythonreactivesqlweb-app
Honor OTEL_SERVICE_NAME for traces (#9906)
Shahmir Varqha1bf440e31a9b
diff --git a/development_docs/traces.md b/development_docs/traces.mdindex 15f9ddc4c3..d59d6e4803 100644--- a/development_docs/traces.md+++ b/development_docs/traces.md@@ -55,6 +55,7 @@ marimo run notebook.py| `OTEL_EXPORTER_OTLP_TRACES_ENDPOINT` | Trace-specific OTLP endpoint; takes precedence over `OTEL_EXPORTER_OTLP_ENDPOINT` | _(unset)_ || `OTEL_EXPORTER_OTLP_PROTOCOL` | OTLP protocol for all signals: `http/protobuf` or `grpc` | `http/protobuf` || `OTEL_EXPORTER_OTLP_TRACES_PROTOCOL` | Trace-specific OTLP protocol; takes precedence over `OTEL_EXPORTER_OTLP_PROTOCOL` | _(unset)_ |+| `OTEL_EXPORTER_OTLP_HEADERS` | Comma-separated `key=value` auth or routing headers for OTLP export | _(empty)_ || `OTEL_SERVICE_NAME` | `service.name` resource attribute | `marimo` || `OTEL_RESOURCE_ATTRIBUTES` | Comma-separated `key=value` pairs added to the resource | _(empty)_ |@@ -103,6 +104,5 @@ we recommend snakeviz or tuna (`uvx snakeviz path_to_profile`)## AI TracingWhen `MARIMO_TRACING=true` and `pydantic_ai` is installed, marimo automatically calls-`Agent.instrument_all()` at server startup so editor AI (chat panel,-completions, inline completion) emits OpenTelemetry spans through the-same exporter as other server traces.+`Agent.instrument_all()` at startup so pydantic-ai spans use the same+`TracerProvider`.diff --git a/marimo/_tracer.py b/marimo/_tracer.pyindex f1bcb35ce1..7f813be96a 100644--- a/marimo/_tracer.py+++ b/marimo/_tracer.py@@ -18,6 +18,7 @@ if TYPE_CHECKING:from pathlib import Pathfrom opentelemetry import trace+ from opentelemetry.sdk.resources import Resourceclass MockSpan:@@ -82,6 +83,17 @@ class MockTracer:TRACE_FILENAME = os.path.join("traces", "spans.jsonl")OTLPProtocol = Literal["grpc", "http/protobuf"]+# OTEL SDK default when service.name is unset (Resource.create in+# opentelemetry.sdk.resources). May be suffixed with :<executable>.+_OTEL_DEFAULT_SERVICE_NAME = "unknown_service"+++def _is_otel_sdk_default_service_name(service_name: str) -> bool:+ # SDK uses "unknown_service" or "unknown_service:<executable>" only.+ return (+ service_name == _OTEL_DEFAULT_SERVICE_NAME+ or service_name.startswith(f"{_OTEL_DEFAULT_SERVICE_NAME}:")+ )def _otlp_endpoint_configured() -> bool:@@ -114,6 +126,21 @@ def _otlp_protocol() -> OTLPProtocol | None:return None+def _tracer_resource() -> Resource:+ """Build the OpenTelemetry resource from standard OTEL env vars."""+ from opentelemetry.sdk.resources import Resource++ # Resource.create() reads OTEL_SERVICE_NAME and OTEL_RESOURCE_ATTRIBUTES+ # Default to marimo when unset.+ resource = Resource.create()+ service_name = resource.attributes.get("service.name")+ if not isinstance(service_name, str) or _is_otel_sdk_default_service_name(+ service_name+ ):+ resource = resource.merge(Resource({"service.name": "marimo"}))+ return resource++def _set_tracer_provider() -> None:if is_pyodide() or GLOBAL_SETTINGS.TRACING is False:return@@ -121,7 +148,6 @@ def _set_tracer_provider() -> None:DependencyManager.opentelemetry.require("for tracing.")from opentelemetry import trace- from opentelemetry.sdk.resources import Resourcefrom opentelemetry.sdk.trace import ReadableSpan, TracerProviderfrom opentelemetry.sdk.trace.export import (BatchSpanProcessor,@@ -162,12 +188,9 @@ def _set_tracer_provider() -> None:"install marimo[otel] for OTLP export. Falling back to file export.",)+ resource = _tracer_resource()+if OTLPSpanExporter is not None:- resource = Resource.create(- {- "service.name": "marimo",- },- )provider = TracerProvider(resource=resource)provider.add_span_processor(BatchSpanProcessor(@@ -206,7 +229,7 @@ def _set_tracer_provider() -> None:filepath = config_ready.filepathfilepath.parent.mkdir(parents=True, exist_ok=True)- provider = TracerProvider()+ provider = TracerProvider(resource=resource)provider.add_span_processor(BatchSpanProcessor(FileExporter(filepath)))LOGGER.debug("OTel tracer: file export to %s", filepath)diff --git a/tests/test_tracer.py b/tests/test_tracer.pyindex ef09847a33..de3ef2ef82 100644--- a/tests/test_tracer.py+++ b/tests/test_tracer.py@@ -262,6 +262,106 @@ class TestSetTracerProvider:mock_instrument.assert_called_once_with(trace.get_tracer_provider())[email protected]("opentelemetry")+class TestTracerResource:+ def setup_method(self) -> None:+ _reset_otel()++ def teardown_method(self) -> None:+ _reset_otel()++ def test_default_service_name(+ self, monkeypatch: pytest.MonkeyPatch+ ) -> None:+ monkeypatch.delenv("OTEL_SERVICE_NAME", raising=False)+ monkeypatch.delenv("OTEL_RESOURCE_ATTRIBUTES", raising=False)++ from marimo._tracer import _tracer_resource++ resource = _tracer_resource()+ assert resource.attributes["service.name"] == "marimo"++ def test_service_name_from_env(+ self, monkeypatch: pytest.MonkeyPatch+ ) -> None:+ monkeypatch.setenv("OTEL_SERVICE_NAME", "my-marimo")+ monkeypatch.delenv("OTEL_RESOURCE_ATTRIBUTES", raising=False)++ from marimo._tracer import _tracer_resource++ resource = _tracer_resource()+ assert resource.attributes["service.name"] == "my-marimo"++ def test_resource_attributes_from_env(+ self, monkeypatch: pytest.MonkeyPatch+ ) -> None:+ monkeypatch.delenv("OTEL_SERVICE_NAME", raising=False)+ monkeypatch.setenv(+ "OTEL_RESOURCE_ATTRIBUTES",+ "deployment.environment=dev,service.version=1.2.3",+ )++ from marimo._tracer import _tracer_resource++ resource = _tracer_resource()+ assert resource.attributes["service.name"] == "marimo"+ assert resource.attributes["deployment.environment"] == "dev"+ assert resource.attributes["service.version"] == "1.2.3"++ def test_service_name_overrides_resource_attributes(+ self, monkeypatch: pytest.MonkeyPatch+ ) -> None:+ monkeypatch.setenv("OTEL_SERVICE_NAME", "from-env")+ monkeypatch.setenv(+ "OTEL_RESOURCE_ATTRIBUTES",+ "service.name=from-attrs",+ )++ from marimo._tracer import _tracer_resource++ resource = _tracer_resource()+ assert resource.attributes["service.name"] == "from-env"++ def test_explicit_service_name_with_unknown_service_prefix(+ self, monkeypatch: pytest.MonkeyPatch+ ) -> None:+ monkeypatch.setenv("OTEL_SERVICE_NAME", "unknown_service_prod")+ monkeypatch.delenv("OTEL_RESOURCE_ATTRIBUTES", raising=False)++ from marimo._tracer import _tracer_resource++ resource = _tracer_resource()+ assert resource.attributes["service.name"] == "unknown_service_prod"++ def test_file_exporter_applies_resource(+ self, monkeypatch: pytest.MonkeyPatch+ ) -> None:+ monkeypatch.delenv("OTEL_EXPORTER_OTLP_ENDPOINT", raising=False)+ monkeypatch.delenv("OTEL_EXPORTER_OTLP_TRACES_ENDPOINT", raising=False)+ monkeypatch.setenv("OTEL_SERVICE_NAME", "file-export-marimo")+ monkeypatch.setenv(+ "OTEL_RESOURCE_ATTRIBUTES",+ "deployment.environment=test",+ )++ from opentelemetry import trace+ from opentelemetry.sdk.trace import TracerProvider++ from marimo._config.settings import GLOBAL_SETTINGS+ from marimo._tracer import _set_tracer_provider++ monkeypatch.setattr(GLOBAL_SETTINGS, "TRACING", True)+ _set_tracer_provider()++ provider = trace.get_tracer_provider()+ assert isinstance(provider, TracerProvider)+ assert (+ provider.resource.attributes["service.name"]+ == "file-export-marimo"+ )+ assert provider.resource.attributes["deployment.environment"] == "test"++@pytest.mark.requires("opentelemetry")class TestCreateTracer:def test_returns_mock_when_tracing_disabled(