Skip to content

Commit bdea4e9

Browse files
committed
POC OtlpIntegration
1 parent 3e86962 commit bdea4e9

File tree

7 files changed

+123
-2
lines changed

7 files changed

+123
-2
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ pip-wheel-metadata
2929
.mypy_cache
3030
.vscode/
3131
.claude/
32+
.tool-versions
3233

3334
# for running AWS Lambda tests using AWS SAM
3435
sam.template.yaml

sentry_sdk/client.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -409,6 +409,7 @@ def _capture_envelope(envelope):
409409
"auto_enabling_integrations"
410410
],
411411
disabled_integrations=self.options["disabled_integrations"],
412+
options=self.options,
412413
)
413414

414415
spotlight_config = self.options.get("spotlight")

sentry_sdk/consts.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ class EndpointType(Enum):
2121
"""
2222

2323
ENVELOPE = "envelope"
24+
OTLP_TRACES = "integration/otlp/v1/traces"
2425

2526

2627
class CompressionAlgo(Enum):

sentry_sdk/integrations/__init__.py

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
from typing import Set
1616
from typing import Type
1717
from typing import Union
18+
from typing import Any
1819

1920

2021
_DEFAULT_FAILED_REQUEST_STATUS_CODES = frozenset(range(500, 600))
@@ -175,8 +176,9 @@ def setup_integrations(
175176
with_defaults=True,
176177
with_auto_enabling_integrations=False,
177178
disabled_integrations=None,
179+
options=None,
178180
):
179-
# type: (Sequence[Integration], bool, bool, Optional[Sequence[Union[type[Integration], Integration]]]) -> Dict[str, Integration]
181+
# type: (Sequence[Integration], bool, bool, Optional[Sequence[Union[type[Integration], Integration]]], Optional[Dict[str, Any]]) -> Dict[str, Integration]
180182
"""
181183
Given a list of integration instances, this installs them all.
182184
@@ -221,6 +223,7 @@ def setup_integrations(
221223
)
222224
try:
223225
type(integration).setup_once()
226+
integration.setup_once_with_options(options)
224227
except DidNotEnable as e:
225228
if identifier not in used_as_default_integration:
226229
raise
@@ -300,3 +303,10 @@ def setup_once():
300303
instance again.
301304
"""
302305
pass
306+
307+
def setup_once_with_options(self, options=None):
308+
# type: (Optional[Dict[str, Any]]) -> None
309+
"""
310+
Called after setup_once in rare cases on the instance and options since we don't have those available above..
311+
"""
312+
pass

sentry_sdk/integrations/otlp.py

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
from sentry_sdk.integrations import Integration, DidNotEnable
2+
from sentry_sdk.scope import add_global_event_processor
3+
from sentry_sdk.utils import logger, Dsn
4+
from sentry_sdk.consts import VERSION, EndpointType
5+
6+
try:
7+
from opentelemetry import trace
8+
from opentelemetry.propagate import set_global_textmap
9+
from opentelemetry.sdk.trace import TracerProvider
10+
from opentelemetry.sdk.trace.export import BatchSpanProcessor
11+
from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter
12+
13+
from sentry_sdk.integrations.opentelemetry.propagator import SentryPropagator
14+
except ImportError:
15+
raise DidNotEnable("opentelemetry-distro[otlp] is not installed")
16+
17+
from typing import TYPE_CHECKING
18+
19+
if TYPE_CHECKING:
20+
from typing import Optional, Dict, Any
21+
from sentry_sdk._types import Event, Hint
22+
23+
24+
def link_event_to_trace(event, _hint):
25+
# type: (Event, Optional[Hint]) -> Optional[Event]
26+
"""
27+
Get the trace info from the running otel span and
28+
update the trace context on sentry events of other types
29+
(errors, logs, checkins, etc).
30+
"""
31+
if hasattr(event, "type") and event["type"] == "transaction":
32+
return event
33+
34+
otel_span = trace.get_current_span()
35+
if not otel_span:
36+
return event
37+
38+
ctx = otel_span.get_span_context()
39+
40+
if ctx.trace_id == trace.INVALID_TRACE_ID or ctx.span_id == trace.INVALID_SPAN_ID:
41+
return event
42+
43+
contexts = event.setdefault("contexts", {})
44+
contexts.setdefault("trace", {}).update(
45+
{
46+
"trace_id": trace.format_trace_id(ctx.trace_id),
47+
"span_id": trace.format_span_id(ctx.span_id),
48+
"status": "ok", # TODO
49+
}
50+
)
51+
52+
return event
53+
54+
55+
def setup_otlp_exporter(dsn=None):
56+
# type: (Optional[str]) -> None
57+
tracer_provider = trace.get_tracer_provider()
58+
59+
if not isinstance(tracer_provider, TracerProvider):
60+
logger.debug("[OTLP] No TracerProvider configured by user, creating a new one")
61+
tracer_provider = TracerProvider()
62+
trace.set_tracer_provider(tracer_provider)
63+
64+
endpoint = None
65+
headers = None
66+
if dsn:
67+
auth = Dsn(dsn).to_auth(f"sentry.python/{VERSION}")
68+
endpoint = auth.get_api_url(EndpointType.OTLP_TRACES)
69+
headers = {"X-Sentry-Auth": auth.to_header()}
70+
logger.debug(f"[OTLP] Sending traces to {endpoint}")
71+
72+
otlp_exporter = OTLPSpanExporter(endpoint=endpoint, headers=headers)
73+
span_processor = BatchSpanProcessor(otlp_exporter)
74+
tracer_provider.add_span_processor(span_processor)
75+
76+
77+
class OTLPIntegration(Integration):
78+
identifier = "otlp"
79+
80+
def __init__(self, setup_otlp_exporter=True, setup_propagator=True):
81+
# type: (bool, bool) -> None
82+
self.setup_otlp_exporter = setup_otlp_exporter
83+
self.setup_propagator = setup_propagator
84+
85+
@staticmethod
86+
def setup_once():
87+
# type: () -> None
88+
logger.debug("[OTLP] Setting up trace linking for all events")
89+
add_global_event_processor(link_event_to_trace)
90+
91+
def setup_once_with_options(self, options=None):
92+
# type: (Optional[Dict[str, Any]]) -> None
93+
if self.setup_otlp_exporter:
94+
logger.debug("[OTLP] Setting up OTLP exporter")
95+
dsn = options.get("dsn") if options else None # type: Optional[str]
96+
setup_otlp_exporter(dsn)
97+
98+
if self.setup_propagator:
99+
logger.debug("[OTLP] Setting up propagator for distributed tracing")
100+
# TODO-neel better propagator support
101+
set_global_textmap(SentryPropagator())

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ def get_file_text(file_name):
7272
"openai": ["openai>=1.0.0", "tiktoken>=0.3.0"],
7373
"openfeature": ["openfeature-sdk>=0.7.1"],
7474
"opentelemetry": ["opentelemetry-distro>=0.35b0"],
75-
"opentelemetry-experimental": ["opentelemetry-distro"],
75+
"opentelemetry-otlp": ["opentelemetry-distro[otlp]>=0.35b0"],
7676
"pure-eval": ["pure_eval", "executing", "asttokens"],
7777
"pydantic_ai": ["pydantic-ai>=1.0.0"],
7878
"pymongo": ["pymongo>=3.1"],

tox.ini

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,9 @@ envlist =
4040
# OpenTelemetry (OTel)
4141
{py3.7,py3.9,py3.12,py3.13,py3.14,py3.14t}-opentelemetry
4242

43+
# OpenTelemetry with OTLP
44+
{py3.7,py3.9,py3.12,py3.13,py3.14,py3.14t}-otlp
45+
4346
# OpenTelemetry Experimental (POTel)
4447
{py3.8,py3.9,py3.10,py3.11,py3.12,py3.13}-potel
4548

@@ -342,6 +345,9 @@ deps =
342345
# OpenTelemetry (OTel)
343346
opentelemetry: opentelemetry-distro
344347

348+
# OpenTelemetry with OTLP
349+
otlp: opentelemetry-distro[otlp]
350+
345351
# OpenTelemetry Experimental (POTel)
346352
potel: -e .[opentelemetry-experimental]
347353

@@ -765,6 +771,7 @@ setenv =
765771
cloud_resource_context: TESTPATH=tests/integrations/cloud_resource_context
766772
gcp: TESTPATH=tests/integrations/gcp
767773
opentelemetry: TESTPATH=tests/integrations/opentelemetry
774+
otlp: TESTPATH=tests/integrations/otlp
768775
potel: TESTPATH=tests/integrations/opentelemetry
769776
socket: TESTPATH=tests/integrations/socket
770777

0 commit comments

Comments
 (0)