-
Notifications
You must be signed in to change notification settings - Fork 11
/
options.py
274 lines (246 loc) · 9.6 KB
/
options.py
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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
# Copyright Splunk Inc.
#
# Licensed 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.
import logging
from functools import partial
from os import environ
from typing import Callable, Collection, Dict, List, Optional, Tuple, Union
from opentelemetry.environment_variables import OTEL_TRACES_EXPORTER
from opentelemetry.instrumentation.propagators import ResponsePropagator
from opentelemetry.instrumentation.version import (
__version__ as auto_instrumentation_version,
)
from opentelemetry.sdk.environment_variables import (
OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT,
OTEL_EVENT_ATTRIBUTE_COUNT_LIMIT,
OTEL_EXPORTER_JAEGER_ENDPOINT,
OTEL_LINK_ATTRIBUTE_COUNT_LIMIT,
OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT,
OTEL_SPAN_EVENT_COUNT_LIMIT,
OTEL_SPAN_LINK_COUNT_LIMIT,
)
from opentelemetry.sdk.resources import Resource
from opentelemetry.sdk.trace.export import SpanExporter
from pkg_resources import iter_entry_points
from splunk_otel.environment_variables import (
_SPLUNK_ACCESS_TOKEN,
_SPLUNK_TRACE_RESPONSE_HEADER_ENABLED,
)
from splunk_otel.propagators import ServerTimingResponsePropagator
from splunk_otel.symbols import (
_DEFAULT_EXPORTERS,
_DEFAULT_JAEGER_ENDPOINT,
_DEFAULT_MAX_ATTR_LENGTH,
_DEFAULT_OTEL_SERVICE_NAME,
_DEFAULT_SERVICE_NAME,
_DEFAULT_SPAN_LINK_COUNT_LIMIT,
_EXPORTER_JAEGER_SPLUNK,
_EXPORTER_JAEGER_THRIFT,
_EXPORTER_OTLP,
_EXPORTER_OTLP_GRPC,
_KNOWN_EXPORTER_PACKAGES,
_LIMIT_UNSET_VALUE,
_NO_SERVICE_NAME_WARNING,
_SERVICE_NAME_ATTR,
_SPLUNK_DISTRO_VERSION_ATTR,
_TELEMETRY_VERSION_ATTR,
)
from splunk_otel.version import __version__
_SpanExporterFactory = Callable[["_Options"], SpanExporter]
_SpanExporterClass = Callable[..., SpanExporter]
logger = logging.getLogger("options")
class _Options:
span_exporter_factories: Collection[_SpanExporterFactory]
access_token: Optional[str]
resource: Resource
response_propagation: bool
response_propagator: Optional[ResponsePropagator]
def __init__(
self,
service_name: Optional[str] = None,
span_exporter_factories: Optional[Collection[_SpanExporterFactory]] = None,
access_token: Optional[str] = None,
resource_attributes: Optional[Dict[str, Union[str, bool, int, float]]] = None,
trace_response_header_enabled: Optional[bool] = None,
):
self._set_default_env()
self.access_token = self._get_access_token(access_token)
self.response_propagator = self._get_trace_response_header_enabled(
trace_response_header_enabled
)
self.resource = self._get_resource(service_name, resource_attributes)
self.span_exporter_factories = self._get_span_exporter_factories(
span_exporter_factories
)
@staticmethod
def _get_access_token(access_token: Optional[str]) -> Optional[str]:
if not access_token:
access_token = environ.get(_SPLUNK_ACCESS_TOKEN)
return access_token or None
@staticmethod
def _get_trace_response_header_enabled(
enabled: Optional[bool],
) -> Optional[ResponsePropagator]:
if enabled is None:
enabled = _Options._is_truthy(
environ.get(_SPLUNK_TRACE_RESPONSE_HEADER_ENABLED, "true")
)
if enabled:
return ServerTimingResponsePropagator()
return None
@staticmethod
def _get_resource(
service_name: Optional[str],
attributes: Optional[Dict[str, Union[str, bool, int, float]]],
) -> Resource:
attributes = attributes or {}
if service_name:
attributes[_SERVICE_NAME_ATTR] = service_name
attributes.update(
{
_TELEMETRY_VERSION_ATTR: auto_instrumentation_version,
_SPLUNK_DISTRO_VERSION_ATTR: __version__,
}
)
resource = Resource.create(attributes)
if (
resource.attributes.get(_SERVICE_NAME_ATTR, _DEFAULT_OTEL_SERVICE_NAME)
== _DEFAULT_OTEL_SERVICE_NAME
):
logger.warning(_NO_SERVICE_NAME_WARNING)
resource = resource.merge(
Resource({_SERVICE_NAME_ATTR: _DEFAULT_SERVICE_NAME})
)
return resource
@staticmethod
def _get_span_exporter_factories(
factories: Optional[Collection[_SpanExporterFactory]],
) -> Collection[_SpanExporterFactory]:
if factories:
return factories
exporter_names = _Options._get_span_exporter_names_from_env()
return _Options._import_span_exporter_factories(exporter_names)
@classmethod
def _is_truthy(cls, value: Optional[str]) -> bool:
if not value:
return False
return value.strip().lower() not in (
"false",
"no",
"f",
"0",
)
@staticmethod
def _set_default_env() -> None:
defaults = {
OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT: _LIMIT_UNSET_VALUE,
OTEL_SPAN_EVENT_COUNT_LIMIT: _LIMIT_UNSET_VALUE,
OTEL_SPAN_EVENT_COUNT_LIMIT: _LIMIT_UNSET_VALUE,
OTEL_EVENT_ATTRIBUTE_COUNT_LIMIT: _LIMIT_UNSET_VALUE,
OTEL_LINK_ATTRIBUTE_COUNT_LIMIT: _LIMIT_UNSET_VALUE,
OTEL_SPAN_LINK_COUNT_LIMIT: str(_DEFAULT_SPAN_LINK_COUNT_LIMIT),
OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT: str(_DEFAULT_MAX_ATTR_LENGTH),
}
for key, value in defaults.items():
if key not in environ:
environ[key] = value
@classmethod
def _get_span_exporter_names_from_env(cls) -> Collection[Tuple[str, str]]:
exporters_env = (
environ.get(OTEL_TRACES_EXPORTER, "").strip() or _DEFAULT_EXPORTERS
)
exporters: List[Tuple[str, str]] = []
if not cls._is_truthy(exporters_env):
return exporters
# exporters are known by different names internally by Python Otel SDK.
# Here we create a mapping of user provided names to internal names so
# that we can provide helpful error messages later.
for name in exporters_env.split(","):
if name == _EXPORTER_OTLP:
exporters.append((_EXPORTER_OTLP, _EXPORTER_OTLP_GRPC))
elif name == _EXPORTER_JAEGER_SPLUNK:
exporters.append((_EXPORTER_JAEGER_SPLUNK, _EXPORTER_JAEGER_THRIFT))
else:
exporters.append(
(
name,
name,
)
)
return exporters
@staticmethod
def _import_span_exporter_factories(
exporter_names: Collection[Tuple[str, str]],
) -> Collection[_SpanExporterFactory]:
factories = []
entry_points = {ep.name: ep for ep in iter_entry_points("opentelemetry_exporter")}
for name, internal_name in exporter_names:
if internal_name not in entry_points:
package = _KNOWN_EXPORTER_PACKAGES.get(internal_name)
if package:
help_msg = "please make sure {0} is installed".format(package)
else:
help_msg = (
"please make sure the relevant exporter package is installed."
)
raise ValueError(
'exporter "{0} ({1})" not found. {2}'.format(
name, internal_name, help_msg
)
)
exporter_class: _SpanExporterClass = entry_points[internal_name].load()
if name == _EXPORTER_JAEGER_SPLUNK:
factory = _Options._splunk_jaeger_factory
elif internal_name == _EXPORTER_JAEGER_THRIFT:
factory = _Options._jaeger_factory
elif internal_name == _EXPORTER_OTLP_GRPC:
factory = _Options._otlp_factory
else:
factory = _Options._generic_exporter
factories.append(partial(factory, exporter_class))
return factories
@staticmethod
def _generic_exporter(
exporter: _SpanExporterClass,
options: "_Options", # pylint: disable=unused-argument
) -> SpanExporter:
return exporter()
@staticmethod
def _splunk_jaeger_factory(
exporter: _SpanExporterClass, options: "_Options"
) -> SpanExporter:
kwargs = _Options._get_jaeger_kwargs(options)
kwargs.update(
{
"collector_endpoint": environ.get(
OTEL_EXPORTER_JAEGER_ENDPOINT, _DEFAULT_JAEGER_ENDPOINT
),
}
)
return exporter(**kwargs)
@staticmethod
def _jaeger_factory(
exporter: _SpanExporterClass, options: "_Options"
) -> SpanExporter:
return exporter(**_Options._get_jaeger_kwargs(options))
@staticmethod
def _get_jaeger_kwargs(options: "_Options") -> Dict[str, str]:
if options.access_token:
return {
"username": "auth",
"password": options.access_token,
}
return {}
@staticmethod
def _otlp_factory(exporter: _SpanExporterClass, options: "_Options") -> SpanExporter:
return exporter(headers=(("x-sf-token", options.access_token),))