1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
|
# Licensed to Elasticsearch B.V. under one or more contributor
# license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright
# ownership. Elasticsearch B.V. licenses this file to you under
# the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
from __future__ import annotations
import contextlib
import os
from typing import Generator, Literal, Mapping
try:
from opentelemetry import trace
_tracer: trace.Tracer | None = trace.get_tracer("elasticsearch-api")
except ImportError:
_tracer = None
from elastic_transport import OpenTelemetrySpan
# Valid values for the enabled config are 'true' and 'false'. Default is 'true'.
ENABLED_ENV_VAR = "OTEL_PYTHON_INSTRUMENTATION_ELASTICSEARCH_ENABLED"
# Describes how to handle search queries in the request body when assigned to
# a span attribute.
# Valid values are 'omit' and 'raw'.
# Default is 'omit' as 'raw' has security implications.
BODY_STRATEGY_ENV_VAR = "OTEL_PYTHON_INSTRUMENTATION_ELASTICSEARCH_CAPTURE_SEARCH_QUERY"
DEFAULT_BODY_STRATEGY = "omit"
class OpenTelemetry:
def __init__(
self,
enabled: bool | None = None,
tracer: trace.Tracer | None = None,
body_strategy: Literal["omit", "raw"] | None = None,
):
if enabled is None:
enabled = os.environ.get(ENABLED_ENV_VAR, "true") == "true"
self.tracer = tracer or _tracer
self.enabled = enabled and self.tracer is not None
if body_strategy is not None:
self.body_strategy = body_strategy
else:
self.body_strategy = os.environ.get(
BODY_STRATEGY_ENV_VAR, DEFAULT_BODY_STRATEGY
) # type: ignore[assignment]
assert self.body_strategy in ("omit", "raw")
@contextlib.contextmanager
def span(
self,
method: str,
*,
endpoint_id: str | None,
path_parts: Mapping[str, str],
) -> Generator[OpenTelemetrySpan]:
if not self.enabled or self.tracer is None:
yield OpenTelemetrySpan(None)
return
span_name = endpoint_id or method
with self.tracer.start_as_current_span(span_name) as otel_span:
otel_span.set_attribute("http.request.method", method)
otel_span.set_attribute("db.system.name", "elasticsearch")
if endpoint_id is not None:
otel_span.set_attribute("db.operation.name", endpoint_id)
for key, value in path_parts.items():
otel_span.set_attribute(f"db.operation.parameter.{key}", value)
yield OpenTelemetrySpan(
otel_span,
endpoint_id=endpoint_id,
body_strategy=self.body_strategy,
)
@contextlib.contextmanager
def helpers_span(self, span_name: str) -> Generator[OpenTelemetrySpan]:
if not self.enabled or self.tracer is None:
yield OpenTelemetrySpan(None)
return
with self.tracer.start_as_current_span(span_name) as otel_span:
otel_span.set_attribute("db.system.name", "elasticsearch")
otel_span.set_attribute("db.operation.name", span_name)
# Without a request method, Elastic APM does not display the traces
otel_span.set_attribute("http.request.method", "null")
yield OpenTelemetrySpan(otel_span)
@contextlib.contextmanager
def use_span(self, span: OpenTelemetrySpan) -> Generator[None]:
if not self.enabled or self.tracer is None or span.otel_span is None:
yield
return
with trace.use_span(span.otel_span):
yield
|
