forked from jaegertracing/jaeger-client-python
-
Notifications
You must be signed in to change notification settings - Fork 0
/
config.py
372 lines (320 loc) · 12.1 KB
/
config.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
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
# Copyright (c) 2016 Uber Technologies, 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.
from __future__ import absolute_import
import logging
import os
import threading
import opentracing
from opentracing.propagation import Format
from . import Tracer
from .local_agent_net import LocalAgentSender
from .reporter import (
Reporter,
CompositeReporter,
LoggingReporter,
)
from .sampler import (
ConstSampler,
ProbabilisticSampler,
RateLimitingSampler,
RemoteControlledSampler,
)
from .constants import (
DEFAULT_SAMPLING_INTERVAL,
DEFAULT_FLUSH_INTERVAL,
SAMPLER_TYPE_CONST,
SAMPLER_TYPE_PROBABILISTIC,
SAMPLER_TYPE_RATE_LIMITING,
TRACE_ID_HEADER,
BAGGAGE_HEADER_PREFIX,
DEBUG_ID_HEADER_KEY,
MAX_TAG_VALUE_LENGTH,
)
from .metrics import LegacyMetricsFactory, MetricsFactory, Metrics
from .utils import get_boolean, ErrorReporter
from .codecs import B3Codec
DEFAULT_REPORTING_HOST = 'localhost'
DEFAULT_REPORTING_PORT = 6831
DEFAULT_SAMPLING_PORT = 5778
LOCAL_AGENT_DEFAULT_ENABLED = True
logger = logging.getLogger('jaeger_tracing')
class Config(object):
"""
Wraps a YAML configuration section for configuring Jaeger Tracer.
service_name is required, but can be passed either as constructor
parameter, or as config property.
Example:
.. code-block:: yaml
enabled: true
reporter_batch_size: 10
logging: true
metrics: true
sampler:
type: const
param: true
"""
_initialized = False
_initialized_lock = threading.Lock()
def __init__(self, config, metrics=None, service_name=None, metrics_factory=None,
validate=False):
"""
:param metrics: an instance of Metrics class, or None. This parameter
has been deprecated, please use metrics_factory instead.
:param service_name: default service name.
Can be overwritten by config['service_name'].
:param metrics_factory: an instance of MetricsFactory class, or None.
"""
if validate:
self._validate_config(config)
self.config = config
if get_boolean(self.config.get('metrics', True), True):
self._metrics_factory = metrics_factory or LegacyMetricsFactory(metrics or Metrics())
else:
# if metrics are explicitly disabled, use a dummy
self._metrics_factory = MetricsFactory()
self._service_name = config.get('service_name', service_name)
if self._service_name is None:
raise ValueError('service_name required in the config or param')
self._error_reporter = ErrorReporter(
metrics=Metrics(),
logger=logger if self.logging else None,
)
def _validate_config(self, config):
allowed_keys = ['logging',
'local_agent',
'sampler',
'tags',
'enabled',
'reporter_batch_size',
'propagation',
'max_tag_value_length',
'reporter_flush_interval',
'sampling_refresh_interval',
'trace_id_header',
'baggage_header_prefix',
'service_name']
config_keys = config.keys()
unexpected_config_keys = [k for k in config_keys if k not in allowed_keys]
if unexpected_config_keys:
raise ValueError('Unexpected keys found in config:{}'.
format(','.join(unexpected_config_keys)))
@property
def service_name(self):
return self._service_name
@property
def metrics(self):
return self._metrics
@property
def error_reporter(self):
return self._error_reporter
@property
def enabled(self):
return get_boolean(self.config.get('enabled', True), True)
@property
def reporter_batch_size(self):
return int(self.config.get('reporter_batch_size', 10))
@property
def reporter_queue_size(self):
return int(self.config.get('reporter_queue_size', 100))
@property
def logging(self):
return get_boolean(self.config.get('logging', False), False)
@property
def trace_id_header(self):
"""
:return: Returns the name of the HTTP header used to encode trace ID
"""
return self.config.get('trace_id_header', TRACE_ID_HEADER)
@property
def baggage_header_prefix(self):
"""
:return: Returns the prefix for HTTP headers used to record baggage
items
"""
return self.config.get('baggage_header_prefix', BAGGAGE_HEADER_PREFIX)
@property
def debug_id_header(self):
"""
:return: Returns the name of HTTP header or a TextMap carrier key
which, if found in the carrier, forces the trace to be sampled as
"debug" trace. The value of the header is recorded as the tag on the
root span, so that the trace can be found in the UI using this value
as a correlation ID.
"""
return self.config.get('debug_id_header', DEBUG_ID_HEADER_KEY)
@property
def max_tag_value_length(self):
"""
:return: Returns max allowed tag value length. Longer values will
be truncated.
"""
return self.config.get('max_tag_value_length', MAX_TAG_VALUE_LENGTH)
@property
def sampler(self):
sampler_config = self.config.get('sampler', {})
sampler_type = sampler_config.get('type', None)
sampler_param = sampler_config.get('param', None)
if not sampler_type:
return None
elif sampler_type == SAMPLER_TYPE_CONST:
return ConstSampler(decision=get_boolean(sampler_param, False))
elif sampler_type == SAMPLER_TYPE_PROBABILISTIC:
return ProbabilisticSampler(rate=float(sampler_param))
elif sampler_type in [SAMPLER_TYPE_RATE_LIMITING, 'rate_limiting']:
return RateLimitingSampler(
max_traces_per_second=float(sampler_param))
raise ValueError('Unknown sampler type %s' % sampler_type)
@property
def sampling_refresh_interval(self):
return self.config.get('sampling_refresh_interval',
DEFAULT_SAMPLING_INTERVAL)
@property
def reporter_flush_interval(self):
return self.config.get('reporter_flush_interval',
DEFAULT_FLUSH_INTERVAL)
def local_agent_group(self):
return self.config.get('local_agent', None)
@property
def local_agent_enabled(self):
# noinspection PyBroadException
try:
return get_boolean(self.local_agent_group().get('enabled',
LOCAL_AGENT_DEFAULT_ENABLED),
LOCAL_AGENT_DEFAULT_ENABLED)
except:
return LOCAL_AGENT_DEFAULT_ENABLED
@property
def local_agent_sampling_port(self):
# noinspection PyBroadException
try:
return int(self.local_agent_group()['sampling_port'])
except:
return DEFAULT_SAMPLING_PORT
@property
def local_agent_reporting_port(self):
# noinspection PyBroadException
try:
return int(self.local_agent_group()['reporting_port'])
except:
return DEFAULT_REPORTING_PORT
@property
def local_agent_reporting_host(self):
# noinspection PyBroadException
try:
return self.local_agent_group()['reporting_host']
except:
return DEFAULT_REPORTING_HOST
@property
def max_operations(self):
return self.config.get('max_operations', None)
@property
def tags(self):
"""
:return: Returns tags from config and `JAEGER_TAGS` environment variable
to use as process-wide tracer tags
"""
tags = self.config.get('tags', {})
env_tags = os.environ.get('JAEGER_TAGS', '')
if env_tags:
for kv in env_tags.split(','):
key, value = kv.split('=')
tags[key.strip()] = value.strip()
return tags
@property
def propagation(self):
propagation = self.config.get('propagation', None)
if propagation == 'b3':
# replace the codec with a B3 enabled instance
return {Format.HTTP_HEADERS: B3Codec()}
return {}
@staticmethod
def initialized():
with Config._initialized_lock:
return Config._initialized
def initialize_tracer(self, io_loop=None):
"""
Initialize Jaeger Tracer based on the passed `jaeger_client.Config`.
Save it to `opentracing.tracer` global variable.
Only the first call to this method has any effect.
"""
with Config._initialized_lock:
if Config._initialized:
logger.warn('Jaeger tracer already initialized, skipping')
return
Config._initialized = True
tracer = self.new_tracer(io_loop)
self._initialize_global_tracer(tracer=tracer)
return tracer
def new_tracer(self, io_loop=None):
"""
Create a new Jaeger Tracer based on the passed `jaeger_client.Config`.
Does not set `opentracing.tracer` global variable.
"""
channel = self._create_local_agent_channel(io_loop=io_loop)
sampler = self.sampler
if sampler is None:
sampler = RemoteControlledSampler(
channel=channel,
service_name=self.service_name,
logger=logger,
metrics_factory=self._metrics_factory,
error_reporter=self.error_reporter,
sampling_refresh_interval=self.sampling_refresh_interval,
max_operations=self.max_operations)
logger.info('Using sampler %s', sampler)
reporter = Reporter(
channel=channel,
queue_capacity=self.reporter_queue_size,
batch_size=self.reporter_batch_size,
flush_interval=self.reporter_flush_interval,
logger=logger,
metrics_factory=self._metrics_factory,
error_reporter=self.error_reporter)
if self.logging:
reporter = CompositeReporter(reporter, LoggingReporter(logger))
return self.create_tracer(
reporter=reporter,
sampler=sampler,
)
def create_tracer(self, reporter, sampler):
return Tracer(
service_name=self.service_name,
reporter=reporter,
sampler=sampler,
metrics_factory=self._metrics_factory,
trace_id_header=self.trace_id_header,
baggage_header_prefix=self.baggage_header_prefix,
debug_id_header=self.debug_id_header,
tags=self.tags,
max_tag_value_length=self.max_tag_value_length,
extra_codecs=self.propagation,
)
def _initialize_global_tracer(self, tracer):
opentracing.tracer = tracer
logger.info('opentracing.tracer initialized to %s[app_name=%s]',
tracer, self.service_name)
def _create_local_agent_channel(self, io_loop):
"""
Create an out-of-process channel communicating to local jaeger-agent.
Spans are submitted as SOCK_DGRAM Thrift, sampling strategy is polled
via JSON HTTP.
:param self: instance of Config
"""
logger.info('Initializing Jaeger Tracer with UDP reporter')
return LocalAgentSender(
host=self.local_agent_reporting_host,
sampling_port=self.local_agent_sampling_port,
reporting_port=self.local_agent_reporting_port,
io_loop=io_loop
)