| 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 | 4×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
10×
10×
10×
10×
10×
10×
4×
6×
6×
1×
6×
1×
6×
2×
6×
2×
6×
11×
11×
11×
11×
1×
1×
1×
1×
1×
1×
1×
1×
11×
11×
11×
11×
11×
10×
1×
1×
1×
1×
1×
1×
1×
1×
19×
19×
19×
19×
19×
3×
19×
1×
18×
3×
15×
10×
5×
11×
11×
11×
10×
1×
1×
11×
3×
11×
| EIE// 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.
import ConstSampler from './samplers/const_sampler';
import ProbabilisticSampler from './samplers/probabilistic_sampler';
import RateLimitingSampler from './samplers/ratelimiting_sampler';
import RemoteReporter from './reporters/remote_reporter';
import CompositeReporter from './reporters/composite_reporter';
import LoggingReporter from './reporters/logging_reporter';
import RemoteSampler from './samplers/remote_sampler';
import Metrics from './metrics/metrics';
import Tracer from './tracer';
import UDPSender from './reporters/udp_sender';
import opentracing from 'opentracing';
import * as constants from './constants.js';
import RemoteThrottler from './throttler/remote_throttler';
import Utils from './util.js';
let jaegerSchema = {
id: '/jaeger',
type: 'object',
properties: {
serviceName: { type: 'string' },
disable: { type: 'boolean' },
sampler: {
properties: {
type: { type: 'string' },
param: { type: 'number' },
host: { type: 'string' },
port: { type: 'number' },
refreshIntervalMs: { type: 'number' },
},
required: ['type', 'param'],
additionalProperties: false,
},
reporter: {
properties: {
logSpans: { type: 'boolean' },
agentHost: { type: 'string' },
agentPort: { type: 'number' },
flushIntervalMs: { type: 'number' },
},
additionalProperties: false,
},
throttler: {
properties: {
host: { type: 'string' },
port: { type: 'number' },
refreshIntervalMs: { type: 'number' },
},
additionalProperties: false,
},
},
};
export default class Configuration {
static _getSampler(config, options) {
let type = config.sampler.type;
let param = config.sampler.param;
let host = config.sampler.host;
let port = config.sampler.port;
let refreshIntervalMs = config.sampler.refreshIntervalMs;
if (typeof param !== 'number') {
throw new Error(`Expecting sampler.param to be a number. Received ${param}`);
}
let sampler;
if (type === constants.SAMPLER_TYPE_PROBABILISTIC) {
sampler = new ProbabilisticSampler(param);
}
if (type === constants.SAMPLER_TYPE_RATE_LIMITING) {
sampler = new RateLimitingSampler(param);
}
if (type === constants.SAMPLER_TYPE_CONST) {
sampler = new ConstSampler(param === 1);
}
if (type === constants.SAMPLER_TYPE_REMOTE) {
sampler = new RemoteSampler(config.serviceName, {
sampler: new ProbabilisticSampler(param),
host: host,
port: port,
refreshInterval: refreshIntervalMs,
metrics: options.metrics,
logger: options.logger,
});
}
return sampler;
}
static _getReporter(config, options) {
let reporterConfig = {};
let reporters = [];
let senderConfig = {
logger: options.logger,
};
if (config.reporter) {
if (Econfig.reporter.logSpans) {
reporters.push(new LoggingReporter(options.logger));
}
if (Econfig.reporter.flushIntervalMs) {
reporterConfig['bufferFlushInterval'] = config.reporter.flushIntervalMs;
}
if (Econfig.reporter.agentHost) {
senderConfig['host'] = config.reporter.agentHost;
}
if (Econfig.reporter.agentPort) {
senderConfig['port'] = config.reporter.agentPort;
}
}
reporterConfig['metrics'] = options.metrics;
reporterConfig['logger'] = options.logger;
let sender = new UDPSender(senderConfig);
let remoteReporter = new RemoteReporter(sender, reporterConfig);
if (reporters.length == 0) {
return remoteReporter;
}
reporters.push(remoteReporter);
return new CompositeReporter(reporters);
}
static _getThrottler(config, options) {
const throttlerOptions = Utils.clone(config.throttler);
if (Eoptions.logger) {
throttlerOptions.logger = options.logger;
}
if (Eoptions.metrics) {
throttlerOptions.metrics = options.metrics;
}
return new RemoteThrottler(config.serviceName, throttlerOptions);
}
/**
* Initialize and return a new instance of Jaeger Tracer.
*
* The config dictionary is not validated for adherence to the schema above.
* Such validation can be performed like this:
*
* import {Validator} from 'jsonschema';
*
* let v = new Validator();
* v.validate(config, jaegerSchema, {
* throwError: true
* });
*
* @param {Object} config - configuration matching the jaegerSchema definition.
* @param {Object} options - options
* @param {Object} [options.reporter] - if provided, this reporter will be used.
* Otherwise a new reporter will be created according to the description
* in the config.
* @param {Object} [options.throttler] - if provided, this throttler will be used.
* Otherwise a new throttler will be created according to the description
* in the config.
* @param {Object} [options.metrics] - a metrics factory (see ./_flow/metrics.js)
* @param {Object} [options.logger] - a logger (see ./_flow/logger.js)
* @param {Object} [options.tags] - set of key-value pairs which will be set
* as process-level tags on the Tracer itself.
*/
static initTracer(config, options = {}) {
let reporter;
let sampler;
let throttler;
if (options.metrics) {
options.metrics = new Metrics(options.metrics);
}
if (config.disable) {
return new opentracing.Tracer();
}
if (!config.serviceName) {
throw new Error(`config.serviceName must be provided`);
}
if (config.sampler) {
sampler = Configuration._getSampler(config, options);
} else {
sampler = new RemoteSampler(config.serviceName, options);
}
if (E!options.reporter) {
reporter = Configuration._getReporter(config, options);
} else {
reporter = options.reporter;
}
if (!options.throttler) {
if (config.throttler) {
throttler = Configuration._getThrottler(config, options);
}
} else {
throttler = options.throttler;
}
if (options.logger) {
options.logger.info(`Initializing Jaeger Tracer with ${reporter.name()} and ${sampler.name()}`);
}
return new Tracer(config.serviceName, reporter, sampler, {
metrics: options.metrics,
logger: options.logger,
tags: options.tags,
debugThrottler: throttler,
});
}
}
|