Skip to content

Commit b8a0db2

Browse files
authored
OTLPIntegration (#4877)
* setup external propagation context to fetch `trace_id/span_id` from otel * setup otlp exporter with endpoint and headers taken from DSN * setup propagator * exporter and propagator are setup by default, can be turned off in case people want to setup manually ### Issues * resolves #4935 * resolves PY-1894
1 parent 9b497d7 commit b8a0db2

File tree

14 files changed

+319
-56
lines changed

14 files changed

+319
-56
lines changed

.github/workflows/test-integrations-dbs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ jobs:
2929
strategy:
3030
fail-fast: false
3131
matrix:
32-
python-version: ["3.6","3.7","3.8","3.9","3.10","3.11","3.12","3.13"]
32+
python-version: ["3.6","3.7","3.8","3.9","3.10","3.11","3.12","3.13","3.14","3.14t"]
3333
# python3.6 reached EOL and is no longer being supported on
3434
# new versions of hosted runners on Github Actions
3535
# ubuntu-20.04 is the last version that supported python3.6

.github/workflows/test-integrations-misc.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,10 @@ jobs:
5858
run: |
5959
set -x # print commands that are executed
6060
./scripts/runtox.sh "py${{ matrix.python-version }}-opentelemetry"
61+
- name: Test otlp
62+
run: |
63+
set -x # print commands that are executed
64+
./scripts/runtox.sh "py${{ matrix.python-version }}-otlp"
6165
- name: Test potel
6266
run: |
6367
set -x # print commands that are executed

requirements-linting.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ types-greenlet
77
types-redis
88
types-setuptools
99
types-webob
10-
opentelemetry-distro
10+
opentelemetry-distro[otlp]
1111
pymongo # There is no separate types module.
1212
loguru # There is no separate types module.
1313
pre-commit # local linting

scripts/populate_tox/package_dependencies.jsonl

Lines changed: 4 additions & 4 deletions
Large diffs are not rendered by default.

scripts/populate_tox/populate_tox.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@
6868
"gcp",
6969
"gevent",
7070
"opentelemetry",
71+
"otlp",
7172
"potel",
7273
}
7374

scripts/populate_tox/releases.jsonl

Lines changed: 16 additions & 14 deletions
Large diffs are not rendered by default.

scripts/populate_tox/tox.jinja

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

46+
# OpenTelemetry with OTLP
47+
{py3.7,py3.9,py3.12,py3.13,py3.14}-otlp
48+
4649
# OpenTelemetry Experimental (POTel)
4750
{py3.8,py3.9,py3.10,py3.11,py3.12,py3.13}-potel
4851

@@ -113,6 +116,9 @@ deps =
113116
# OpenTelemetry (OTel)
114117
opentelemetry: opentelemetry-distro
115118
119+
# OpenTelemetry with OTLP
120+
otlp: opentelemetry-distro[otlp]
121+
116122
# OpenTelemetry Experimental (POTel)
117123
potel: -e .[opentelemetry-experimental]
118124
@@ -158,6 +164,7 @@ setenv =
158164
cloud_resource_context: TESTPATH=tests/integrations/cloud_resource_context
159165
gcp: TESTPATH=tests/integrations/gcp
160166
opentelemetry: TESTPATH=tests/integrations/opentelemetry
167+
otlp: TESTPATH=tests/integrations/otlp
161168
potel: TESTPATH=tests/integrations/opentelemetry
162169
socket: TESTPATH=tests/integrations/socket
163170

scripts/split_tox_gh_actions/split_tox_gh_actions.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,7 @@
150150
"Misc": [
151151
"loguru",
152152
"opentelemetry",
153+
"otlp",
153154
"potel",
154155
"pure_eval",
155156
"trytond",

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/otlp.py

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
from sentry_sdk.integrations import Integration, DidNotEnable
2+
from sentry_sdk.scope import register_external_propagation_context
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, Tuple
21+
22+
23+
def otel_propagation_context():
24+
# type: () -> Optional[Tuple[str, str]]
25+
"""
26+
Get the (trace_id, span_id) from opentelemetry if exists.
27+
"""
28+
ctx = trace.get_current_span().get_span_context()
29+
30+
if ctx.trace_id == trace.INVALID_TRACE_ID or ctx.span_id == trace.INVALID_SPAN_ID:
31+
return None
32+
33+
return (trace.format_trace_id(ctx.trace_id), trace.format_span_id(ctx.span_id))
34+
35+
36+
def setup_otlp_exporter(dsn=None):
37+
# type: (Optional[str]) -> None
38+
tracer_provider = trace.get_tracer_provider()
39+
40+
if not isinstance(tracer_provider, TracerProvider):
41+
logger.debug("[OTLP] No TracerProvider configured by user, creating a new one")
42+
tracer_provider = TracerProvider()
43+
trace.set_tracer_provider(tracer_provider)
44+
45+
endpoint = None
46+
headers = None
47+
if dsn:
48+
auth = Dsn(dsn).to_auth(f"sentry.python/{VERSION}")
49+
endpoint = auth.get_api_url(EndpointType.OTLP_TRACES)
50+
headers = {"X-Sentry-Auth": auth.to_header()}
51+
logger.debug(f"[OTLP] Sending traces to {endpoint}")
52+
53+
otlp_exporter = OTLPSpanExporter(endpoint=endpoint, headers=headers)
54+
span_processor = BatchSpanProcessor(otlp_exporter)
55+
tracer_provider.add_span_processor(span_processor)
56+
57+
58+
class OTLPIntegration(Integration):
59+
identifier = "otlp"
60+
61+
def __init__(self, setup_otlp_exporter=True, setup_propagator=True):
62+
# type: (bool, bool) -> None
63+
self.setup_otlp_exporter = setup_otlp_exporter
64+
self.setup_propagator = setup_propagator
65+
66+
@staticmethod
67+
def setup_once():
68+
# type: () -> None
69+
logger.debug("[OTLP] Setting up trace linking for all events")
70+
register_external_propagation_context(otel_propagation_context)
71+
72+
def setup_once_with_options(self, options=None):
73+
# type: (Optional[Dict[str, Any]]) -> None
74+
if self.setup_otlp_exporter:
75+
logger.debug("[OTLP] Setting up OTLP exporter")
76+
dsn = options.get("dsn") if options else None # type: Optional[str]
77+
setup_otlp_exporter(dsn)
78+
79+
if self.setup_propagator:
80+
logger.debug("[OTLP] Setting up propagator for distributed tracing")
81+
# TODO-neel better propagator support, chain with existing ones if possible instead of replacing
82+
set_global_textmap(SentryPropagator())

0 commit comments

Comments
 (0)