-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathlightstep-tracer.js
6653 lines (5827 loc) · 234 KB
/
lightstep-tracer.js
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
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
(function webpackUniversalModuleDefinition(root, factory) {
if(typeof exports === 'object' && typeof module === 'object')
module.exports = factory();
else if(typeof define === 'function' && define.amd)
define([], factory);
else if(typeof exports === 'object')
exports["lightstep"] = factory();
else
root["lightstep"] = factory();
})(this, function() {
return /******/ (function(modules) { // webpackBootstrap
/******/ // The module cache
/******/ var installedModules = {};
/******/
/******/ // The require function
/******/ function __webpack_require__(moduleId) {
/******/
/******/ // Check if module is in cache
/******/ if(installedModules[moduleId])
/******/ return installedModules[moduleId].exports;
/******/
/******/ // Create a new module (and put it into the cache)
/******/ var module = installedModules[moduleId] = {
/******/ exports: {},
/******/ id: moduleId,
/******/ loaded: false
/******/ };
/******/
/******/ // Execute the module function
/******/ modules[moduleId].call(module.exports, module, module.exports, __webpack_require__);
/******/
/******/ // Flag the module as loaded
/******/ module.loaded = true;
/******/
/******/ // Return the exports of the module
/******/ return module.exports;
/******/ }
/******/
/******/
/******/ // expose the modules object (__webpack_modules__)
/******/ __webpack_require__.m = modules;
/******/
/******/ // expose the module cache
/******/ __webpack_require__.c = installedModules;
/******/
/******/ // __webpack_public_path__
/******/ __webpack_require__.p = "";
/******/
/******/ // Load entry module and return exports
/******/ return __webpack_require__(0);
/******/ })
/************************************************************************/
/******/ ([
/* 0 */
/***/ function(module, exports, __webpack_require__) {
'use strict';
var _tracer_imp = __webpack_require__(1);
var _tracer_imp2 = _interopRequireDefault(_tracer_imp);
var _platform_abstraction_layer = __webpack_require__(19);
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
var library = {
Tracer: _tracer_imp2.default
};
_platform_abstraction_layer.Platform.initLibrary(library);
module.exports = library;
/***/ },
/* 1 */
/***/ function(module, exports, __webpack_require__) {
'use strict';
Object.defineProperty(exports, "__esModule", {
value: true
});
var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();
var _eventemitter = __webpack_require__(2);
var _eventemitter2 = _interopRequireDefault(_eventemitter);
var _opentracing = __webpack_require__(3);
var opentracing = _interopRequireWildcard(_opentracing);
var _span_context_imp = __webpack_require__(14);
var _span_context_imp2 = _interopRequireDefault(_span_context_imp);
var _span_imp = __webpack_require__(16);
var _span_imp2 = _interopRequireDefault(_span_imp);
var _each2 = __webpack_require__(15);
var _each3 = _interopRequireDefault(_each2);
var _platform_abstraction_layer = __webpack_require__(19);
function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } else { var newObj = {}; if (obj != null) { for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) newObj[key] = obj[key]; } } newObj.default = obj; return newObj; } }
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
function _possibleConstructorReturn(self, call) { if (!self) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return call && (typeof call === "object" || typeof call === "function") ? call : self; }
function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function, not " + typeof superClass); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, enumerable: false, writable: true, configurable: true } }); if (superClass) Object.setPrototypeOf ? Object.setPrototypeOf(subClass, superClass) : subClass.__proto__ = superClass; } //============================================================================//
// Imports
//============================================================================//
// eslint-disable-line camelcase
var ClockState = __webpack_require__(29);
var LogBuilder = __webpack_require__(30);
var coerce = __webpack_require__(17);
var constants = __webpack_require__(18);
var globals = __webpack_require__(31);
var packageObject = __webpack_require__(32);
var util = __webpack_require__(33);
var CARRIER_TRACER_STATE_PREFIX = 'ot-tracer-';
var CARRIER_BAGGAGE_PREFIX = 'ot-baggage-';
var DEFAULT_COLLECTOR_HOSTNAME = 'collector.lightstep.com';
var DEFAULT_COLLECTOR_PORT_TLS = 443;
var DEFAULT_COLLECTOR_PORT_PLAIN = 80;
// Internal errors should be rare. Set a low limit to ensure a cascading failure
// does not compound an existing problem by trying to send a great deal of
// internal error data.
var MAX_INTERNAL_LOGS = 20;
var _singleton = null;
var Tracer = function (_opentracing$Tracer) {
_inherits(Tracer, _opentracing$Tracer);
function Tracer(opts) {
_classCallCheck(this, Tracer);
var _this = _possibleConstructorReturn(this, (Tracer.__proto__ || Object.getPrototypeOf(Tracer)).call(this));
_this._delegateEventEmitterMethods();
opts = opts || {};
if (!_singleton) {
globals.setOptions(opts);
_singleton = _this;
}
// Platform abstraction layer
_this._platform = new _platform_abstraction_layer.Platform(_this);
_this._runtimeGUID = opts.guid || _this.override_runtime_guid || null; // Set once the group name is set
_this._plugins = {};
_this._options = {};
_this._optionDescs = [];
_this._makeOptionsTable();
_this._opentracing = opentracing;
if (opts.opentracing_module) {
_this._opentracing = opts.opentracing_module;
}
var now = _this._platform.nowMicros();
// The thrift authentication and runtime struct are created as soon as
// the necessary initialization options are available.
_this._startMicros = now;
_this._thriftAuth = null;
_this._thriftRuntime = null;
var logger = {
warn: function (msg, payload) {
_this._warn(msg, payload);
},
error: function (err, payload) {
_this._error(err, payload);
}
};
_this._transport = (opts ? opts.override_transport : null) || new _platform_abstraction_layer.Transport(logger);
_this._reportingLoopActive = false;
_this._reportYoungestMicros = now;
_this._reportTimer = null;
_this._reportErrorStreak = 0; // Number of consecutive errors
_this._lastVisibleErrorMillis = 0;
_this._skippedVisibleErrors = 0;
// Set addActiveRootSpan() for detail
_this._activeRootSpanSet = {};
_this._activeRootSpan = null;
// For clock skew adjustment.
_this._useClockState = true;
_this._clockState = new ClockState({
nowMicros: function () {
return _this._platform.nowMicros();
},
localStoreGet: function () {
var key = 'clock_state/' + _this._options.collector_host;
return _this._platform.localStoreGet(key);
},
localStoreSet: function (value) {
var key = 'clock_state/' + _this._options.collector_host;
return _this._platform.localStoreSet(key, value);
}
});
// Span reporting buffer and per-report data
// These data are reset on every successful report.
_this._spanRecords = [];
// The counter names need to match those accepted by the collector.
// These are internal counters only.
_this._counters = {
'internal.errors': 0,
'internal.warnings': 0,
'spans.dropped': 0,
'logs.dropped': 0,
'logs.keys.over_limit': 0,
'logs.values.over_limit': 0,
'reports.errors.send': 0
};
// For internal (not client) logs reported to the collector
_this._internalLogs = [];
// Current runtime state / status
_this._flushIsActive = false;
// Built-in plugins
_this.addPlugin(__webpack_require__(34));
// Initialize the platform options after the built-in plugins in
// case any of those options affect the built-ins.
_this.addPlatformPlugins(opts);
_this.setPlatformOptions(opts);
// Set constructor arguments
if (opts) {
_this.options(opts);
}
// This relies on the options being set: call this last.
_this._setupReportOnExit();
_this._info('Tracer created with guid ' + _this._runtimeGUID);
_this.startPlugins();
return _this;
}
// Morally speaking, Tracer also inherits from EventEmmiter, but we must
// fake it via composition.
//
// If not obvious on inspection: a hack.
_createClass(Tracer, [{
key: '_delegateEventEmitterMethods',
value: function _delegateEventEmitterMethods() {
var self = this;
this._ee = new _eventemitter2.default();
// The list of methods at https://nodejs.org/api/events.html
(0, _each3.default)(['addListener', 'emit', 'eventNames', 'getMaxListeners', 'listenerCount', 'listeners', 'on', 'once', 'prependListener', 'prependOnceListener', 'removeAllListeners', 'removeListener', 'setMaxListeners'], function (methodName) {
self[methodName] = function () {
if (self._ee[methodName]) {
self._ee[methodName].apply(self._ee, arguments);
}
};
});
}
}, {
key: '_makeOptionsTable',
value: function _makeOptionsTable() {
/* eslint-disable key-spacing, no-multi-spaces */
// NOTE: make 'verbosity' the first option so it is processed first on
// options changes and takes effect as soon as possible.
this.addOption('verbosity', { type: 'int', min: 0, max: 9, defaultValue: 1 });
// Core options
this.addOption('access_token', { type: 'string', defaultValue: '' });
this.addOption('component_name', { type: 'string', defaultValue: '' });
this.addOption('collector_host', { type: 'string', defaultValue: DEFAULT_COLLECTOR_HOSTNAME });
this.addOption('collector_port', { type: 'int', defaultValue: DEFAULT_COLLECTOR_PORT_TLS });
this.addOption('collector_encryption', { type: 'string', defaultValue: 'tls' });
this.addOption('tags', { type: 'any', defaultValue: {} });
this.addOption('max_reporting_interval_millis', { type: 'int', defaultValue: 2500 });
// Non-standard, may be deprecated
this.addOption('disabled', { type: 'bool', defaultValue: false });
this.addOption('max_span_records', { type: 'int', defaultValue: 4096 });
this.addOption('default_span_tags', { type: 'any', defaultValue: {} });
this.addOption('report_timeout_millis', { type: 'int', defaultValue: 30000 });
this.addOption('gzip_json_requests', { type: 'bool', defaultValue: true });
this.addOption('disable_reporting_loop', { type: 'bool', defaultValue: false });
this.addOption('disable_report_on_exit', { type: 'bool', defaultValue: false });
this.addOption('delay_initial_report_millis', { type: 'int', defaultValue: 1000 });
this.addOption('error_throttle_millis', { type: 'int', defaultValue: 60000 });
// Debugging options
//
// These are not part of the supported public API.
//
// If false, SSL certificate verification is skipped. Useful for testing.
this.addOption('certificate_verification', { type: 'bool', defaultValue: true });
// I.e. report only on explicit calls to flush()
// Unit testing options
this.addOption('override_transport', { type: 'any', defaultValue: null });
this.addOption('silent', { type: 'bool', defaultValue: false });
// Hard upper limits to protect against worst-case scenarios for log field sizes.
this.addOption('log_field_key_hard_limit', { type: 'int', defaultValue: 256 });
this.addOption('log_field_value_hard_limit', { type: 'int', defaultValue: 1024 });
/* eslint-disable key-spacing, no-multi-spaces */
}
// ---------------------------------------------------------------------- //
// opentracing.Tracer SPI
// ---------------------------------------------------------------------- //
}, {
key: '_startSpan',
value: function _startSpan(name, fields) {
var _this2 = this;
// First, assemble the SpanContextImp for our SpanImp.
var parentCtxImp = null;
fields = fields || {};
if (fields.references) {
for (var i = 0; i < fields.references.length; i++) {
var ref = fields.references[i];
var type = ref.type();
if (type === this._opentracing.REFERENCE_CHILD_OF || type === this._opentracing.REFERENCE_FOLLOWS_FROM) {
var context = ref.referencedContext();
if (!context) {
this._error('Span reference has an invalid context', context);
continue;
}
parentCtxImp = context;
break;
}
}
}
var traceGUID = parentCtxImp ? parentCtxImp._traceGUID : this.generateTraceGUIDForRootSpan();
var spanImp = new _span_imp2.default(this, name, new _span_context_imp2.default(this._platform.generateUUID(), traceGUID));
spanImp.addTags(this._options.default_span_tags);
(0, _each3.default)(fields, function (value, key) {
switch (key) {
case 'references':
// Ignore: handled before constructing the span
break;
case 'startTime':
// startTime is in milliseconds
spanImp.setBeginMicros(value * 1000);
break;
case 'tags':
spanImp.addTags(value);
break;
default:
_this2._warn('Ignoring unknown field \'' + key + '\'');
break;
}
});
if (parentCtxImp !== null) {
spanImp.setParentGUID(parentCtxImp._guid);
}
this.emit('start_span', spanImp);
return spanImp;
}
}, {
key: '_inject',
value: function _inject(spanContext, format, carrier) {
switch (format) {
case this._opentracing.FORMAT_HTTP_HEADERS:
case this._opentracing.FORMAT_TEXT_MAP:
this._injectToTextMap(spanContext, carrier);
break;
case this._opentracing.FORMAT_BINARY:
this._error('Unsupported format: ' + format);
break;
default:
this._error('Unknown format: ' + format);
break;
}
}
}, {
key: '_injectToTextMap',
value: function _injectToTextMap(spanContext, carrier) {
if (!carrier) {
this._error('Unexpected null FORMAT_TEXT_MAP carrier in call to inject');
return;
}
if (typeof carrier !== 'object') {
this._error('Unexpected \'' + typeof carrier + '\' FORMAT_TEXT_MAP carrier in call to inject');
return;
}
carrier[CARRIER_TRACER_STATE_PREFIX + 'spanid'] = spanContext._guid;
carrier[CARRIER_TRACER_STATE_PREFIX + 'traceid'] = spanContext._traceGUID;
spanContext.forEachBaggageItem(function (key, value) {
carrier['' + CARRIER_BAGGAGE_PREFIX + key] = value;
});
carrier[CARRIER_TRACER_STATE_PREFIX + 'sampled'] = 'true';
return carrier;
}
}, {
key: '_extract',
value: function _extract(format, carrier) {
switch (format) {
case this._opentracing.FORMAT_HTTP_HEADERS:
case this._opentracing.FORMAT_TEXT_MAP:
return this._extractTextMap(format, carrier);
case this._opentracing.FORMAT_BINARY:
this._error('Unsupported format: ' + format);
return null;
default:
this._error('Unsupported format: ' + format);
return null;
}
}
}, {
key: '_extractTextMap',
value: function _extractTextMap(format, carrier) {
var _this3 = this;
// Begin with the empty SpanContextImp
var spanContext = new _span_context_imp2.default(null, null);
// Iterate over the contents of the carrier and set the properties
// accordingly.
var foundFields = 0;
(0, _each3.default)(carrier, function (value, key) {
key = key.toLowerCase();
if (key.substr(0, CARRIER_TRACER_STATE_PREFIX.length) !== CARRIER_TRACER_STATE_PREFIX) {
return;
}
var suffix = key.substr(CARRIER_TRACER_STATE_PREFIX.length);
switch (suffix) {
case 'traceid':
foundFields++;
spanContext._traceGUID = value;
break;
case 'spanid':
foundFields++;
spanContext._guid = value;
break;
case 'sampled':
// Ignored. The carrier may be coming from a different client
// library that sends this (even though it's not used).
break;
default:
_this3._error('Unrecognized carrier key \'' + key + '\' with recognized prefix. Ignoring.');
break;
}
});
if (foundFields === 0) {
// This is not an error per se, there was simply no SpanContext
// in the carrier.
return null;
}
if (foundFields < 2) {
// A partial SpanContext suggests some sort of data corruption.
this._error('Only found a partial SpanContext: ' + format + ', ' + carrier);
return null;
}
(0, _each3.default)(carrier, function (value, key) {
key = key.toLowerCase();
if (key.substr(0, CARRIER_BAGGAGE_PREFIX.length) !== CARRIER_BAGGAGE_PREFIX) {
return;
}
var suffix = key.substr(CARRIER_BAGGAGE_PREFIX.length);
spanContext.setBaggageItem(suffix, value);
});
return spanContext;
}
// ---------------------------------------------------------------------- //
// LightStep extensions
// ---------------------------------------------------------------------- //
/**
* Manually sends a report of all buffered data.
*
* @param {Function} done - callback function invoked when the report
* either succeeds or fails.
*/
}, {
key: 'flush',
value: function flush(done) {
if (!done) {
done = function () {};
}
if (this._options.disabled) {
this._warn('Manual flush() called in disabled state.');
return done(null);
}
this._flushReport(true, false, done);
}
//-----------------------------------------------------------------------//
// Options
//-----------------------------------------------------------------------//
}, {
key: 'guid',
value: function guid() {
return this._runtimeGUID;
}
}, {
key: 'verbosity',
value: function verbosity() {
// The 'undefined' handling below is for logs that may occur before the
// options are initialized.
var v = this._options.verbosity;
return v === undefined ? 1 : v;
}
// Call to generate a new Trace GUID
}, {
key: 'generateTraceGUIDForRootSpan',
value: function generateTraceGUIDForRootSpan() {
var guid = this._platform.generateUUID();
if (this._activeRootSpan) {
guid = this._activeRootSpan.traceGUID();
}
return guid;
}
}, {
key: 'setPlatformOptions',
value: function setPlatformOptions(userOptions) {
var opts = this._platform.options(this) || {};
(0, _each3.default)(userOptions, function (val, key) {
opts[key] = val;
});
this.options(opts);
}
// Register a new option. Used by plug-ins.
}, {
key: 'addOption',
value: function addOption(name, desc) {
desc.name = name;
this._optionDescs.push(desc);
this._options[desc.name] = desc.defaultValue;
}
}, {
key: 'options',
value: function options(opts) {
var _this4 = this;
if (arguments.length === 0) {
console.assert(typeof this._options === 'object', // eslint-disable-line
'Internal error: _options field incorrect');
return this._options;
}
if (typeof opts !== 'object') {
throw new Error('options() must be called with an object: type was ' + typeof opts);
}
// "collector_port" 0 acts as an alias for "use the default".
if (opts.collector_port === 0) {
delete opts.collector_port;
}
// "collector_encryption" acts an alias for the common cases of 'collector_port'
if (opts.collector_encryption !== undefined && opts.collector_port === undefined) {
opts.collector_port = opts.collector_encryption !== 'none' ? DEFAULT_COLLECTOR_PORT_TLS : DEFAULT_COLLECTOR_PORT_PLAIN;
}
// Track what options have been modified
var modified = {};
var unchanged = {};
(0, _each3.default)(this._optionDescs, function (desc) {
_this4._setOptionInternal(modified, unchanged, opts, desc);
});
// Check for any invalid options: is there a key in the specified operation
// that didn't result either in a change or a reset to the existing value?
for (var key in opts) {
if (modified[key] === undefined && unchanged[key] === undefined) {
throw new Error('Invalid option ' + key);
}
}
//
// Update the state information based on the changes
//
this._initReportingDataIfNeeded(modified);
if (!this._reportingLoopActive) {
this._startReportingLoop();
}
if (this.verbosity() >= 3) {
(function () {
var optionsString = '';
var count = 0;
(0, _each3.default)(modified, function (val, key) {
optionsString += '\t' + JSON.stringify(key) + ': ' + JSON.stringify(val.newValue) + '\n';
count++;
});
if (count > 0) {
_this4._debug('Options modified:\n' + optionsString);
}
})();
}
this.emit('options', modified, this._options, this);
}
}, {
key: '_setOptionInternal',
value: function _setOptionInternal(modified, unchanged, opts, desc) {
var name = desc.name;
var value = opts[name];
var valueType = typeof value;
if (value === undefined) {
return;
}
// Parse the option (and check constraints)
switch (desc.type) {
case 'any':
break;
case 'bool':
if (value !== true && value !== false) {
this._error('Invalid boolean option \'' + name + '\' \'' + value + '\'');
return;
}
break;
case 'int':
if (valueType !== 'number' || Math.floor(value) !== value) {
this._error('Invalid int option \'' + name + '\' \'' + value + '\'');
return;
}
if (desc.min !== undefined && desc.max !== undefined) {
if (!(value >= desc.min && value <= desc.max)) {
this._error('Option \'' + name + '\' out of range \'' + value + '\' is not between ' + desc.min + ' and ' + desc.max); // eslint-disable-line max-len
return;
}
}
break;
case 'string':
switch (valueType) {
case 'string':
break;
case 'number':
value = coerce.toString(value);
break;
default:
this._error('Invalid string option ' + name + ' ' + value);
return;
}
break;
case 'array':
// Per http://stackoverflow.com/questions/4775722/check-if-object-is-array
if (Object.prototype.toString.call(value) !== '[object Array]') {
this._error('Invalid type for array option ' + name + ': found \'' + valueType + '\'');
return;
}
break;
default:
this._error('Unknown option type \'' + desc.type + '\'');
return;
}
// Set the new value, recording any modifications
var oldValue = this._options[name];
if (oldValue === undefined) {
throw new Error('Attempt to set unknown option ' + name);
}
// Ignore no-op changes for types that can be checked quickly
if (valueType !== 'object' && oldValue === value) {
unchanged[name] = true;
return;
}
modified[name] = {
oldValue: oldValue,
newValue: value
};
this._options[name] = value;
}
// The Thrift authorization and runtime information is initializaed as soon
// as it is available. This allows logs and spans to be buffered before
// the library is initialized, which can be helpul in a complex setup with
// many subsystems.
//
}, {
key: '_initReportingDataIfNeeded',
value: function _initReportingDataIfNeeded(modified) {
var _this5 = this;
// Ignore redundant initialization; complaint on inconsistencies
if (this._thriftAuth !== null) {
if (!this._thriftRuntime) {
return this._error('Inconsistent state: thrift auth initialized without runtime.');
}
if (modified.access_token) {
throw new Error('Cannot change access_token after it has been set.');
}
if (modified.component_name) {
throw new Error('Cannot change component_name after it has been set.');
}
if (modified.collector_host) {
throw new Error('Cannot change collector_host after the connection is established');
}
if (modified.collector_port) {
throw new Error('Cannot change collector_port after the connection is established');
}
if (modified.collector_encryption) {
throw new Error('Cannot change collector_encryption after the connection is established');
}
return;
}
// See if the Thrift data can be initialized
if (this._options.access_token.length > 0 && this._options.component_name.length > 0) {
(function () {
_this5._runtimeGUID = _this5._platform.runtimeGUID(_this5._options.component_name);
_this5._thriftAuth = new _platform_abstraction_layer.crouton_thrift.Auth({
access_token: _this5._options.access_token
});
//
// Assemble the tracer tags from the user-specified and automatic,
// internal tags.
//
var tags = {};
(0, _each3.default)(_this5._options.tags, function (value, key) {
if (typeof value !== 'string') {
_this5._error('Tracer tag value is not a string: key=' + key);
return;
}
tags[key] = value;
});
tags['lightstep.tracer_version'] = packageObject.version;
var platformTags = _this5._platform.tracerTags();
(0, _each3.default)(platformTags, function (val, key) {
tags[key] = val;
});
var thriftAttrs = [];
(0, _each3.default)(tags, function (val, key) {
thriftAttrs.push(new _platform_abstraction_layer.crouton_thrift.KeyValue({
Key: coerce.toString(key),
Value: coerce.toString(val)
}));
});
// NOTE: for legacy reasons, the Thrift field is called "group_name"
// but is semantically equivalen to the "component_name"
_this5._thriftRuntime = new _platform_abstraction_layer.crouton_thrift.Runtime({
guid: _this5._runtimeGUID,
start_micros: _this5._startMicros,
group_name: _this5._options.component_name,
attrs: thriftAttrs
});
_this5._info('Initializing thrift reporting data', {
component_name: _this5._options.component_name,
access_token: _this5._thriftAuth.access_token
});
_this5.emit('reporting_initialized');
})();
}
}
//-----------------------------------------------------------------------//
// Plugins
//-----------------------------------------------------------------------//
}, {
key: 'addPlatformPlugins',
value: function addPlatformPlugins(opts) {
var _this6 = this;
var pluginSet = this._platform.plugins(opts);
(0, _each3.default)(pluginSet, function (val) {
_this6.addPlugin(val);
});
}
}, {
key: 'addPlugin',
value: function addPlugin(plugin) {
// Don't add plug-ins twice
var name = plugin.name();
if (this._plugins[name]) {
return;
}
this._plugins[name] = plugin;
plugin.addOptions(this);
}
}, {
key: 'startPlugins',
value: function startPlugins() {
var _this7 = this;
(0, _each3.default)(this._plugins, function (val, key) {
_this7._plugins[key].start(_this7);
});
}
//-----------------------------------------------------------------------//
// Spans
//-----------------------------------------------------------------------//
// This is a LightStep-specific feature that should be used sparingly. It
// sets a "global" root span such that spans that would *otherwise* be root
// span instead inherit the trace GUID of the active root span. This is
// best clarified by example:
//
// On document load in the browser, an "active root span" is created for
// the page load process. Any spans started without an explicit parent
// will the document load trace GUID instead of starting a trace GUID.
// This implicit root remains active only until the page is done loading.
//
// Any span adding itself as a root span *must* remove itself along with
// calling finish(). This will *not* be done automatically.
//
// NOTE: currently, only the trace GUID is transferred; it may or may not
// make sure to make this a proper parent.
//
// NOTE: the root span tracking is handled as a set rather than a single
// global to avoid conflicts between libraries.
}, {
key: 'addActiveRootSpan',
value: function addActiveRootSpan(span) {
this._activeRootSpanSet[span._guid] = span;
this._setActiveRootSpanToYoungest();
}
}, {
key: 'removeActiveRootSpan',
value: function removeActiveRootSpan(span) {
delete this._activeRootSpanSet[span._guid];
this._setActiveRootSpanToYoungest();
}
}, {
key: '_setActiveRootSpanToYoungest',
value: function _setActiveRootSpanToYoungest() {
var _this8 = this;
// Set the _activeRootSpan to the youngest of the roots in case of
// multiple.
this._activeRootSpan = null;
(0, _each3.default)(this._activeRootSpanSet, function (span) {
if (!_this8._activeRootSpan || span._beginMicros > _this8._activeRootSpan._beginMicros) {
_this8._activeRootSpan = span;
}
});
}
//-----------------------------------------------------------------------//
// Encoding / decoding
//-----------------------------------------------------------------------//
}, {
key: '_objectToUint8Array',
value: function _objectToUint8Array(obj) {
var jsonString = void 0;
try {
// encodeURIComponent() is a *very* inefficient, but simple and
// well-supported way to avoid having to think about Unicode in
// in the conversion to a UInt8Array.
//
// Writing multiple bytes for String.charCodeAt and
// String.codePointAt would be an alternate approach; again,
// simplicitly is being preferred over efficiency for the moment.
jsonString = encodeURIComponent(JSON.stringify(obj));
} catch (e) {
this._error('Could not binary encode carrier data.');
return null;
}
var buffer = new ArrayBuffer(jsonString.length);
var view = new Uint8Array(buffer);
for (var i = 0; i < jsonString.length; i++) {
var code = jsonString.charCodeAt(i);
if (!(code >= 0 && code <= 255)) {
this._error('Unexpected character code');
return null;
}
view[i] = code;
}
return view;
}
}, {
key: '_uint8ArrayToObject',
value: function _uint8ArrayToObject(arr) {
if (!arr) {
this._error('Array is null');
return null;
}
var jsonString = '';
for (var i = 0; i < arr.length; i++) {
jsonString += String.fromCharCode(arr[i]);
}
try {
return JSON.parse(decodeURIComponent(jsonString));
} catch (e) {
this._error('Could not decode binary data.');
return null;
}
}
//-----------------------------------------------------------------------//
// Logging
//-----------------------------------------------------------------------//
}, {
key: 'log',
value: function log() {
var b = new LogBuilder(this);
return b;
}
//-----------------------------------------------------------------------//
// Buffers
//-----------------------------------------------------------------------//
}, {
key: '_clearBuffers',
value: function _clearBuffers() {
this._spanRecords = [];
this._internalLogs = [];
// Create a new object to avoid overwriting the values in any references
// to the old object
var counters = {};
(0, _each3.default)(this._counters, function (unused, key) {
counters[key] = 0;
});
this._counters = counters;
}
}, {
key: '_buffersAreEmpty',
value: function _buffersAreEmpty() {
if (this._spanRecords.length > 0) {
return false;
}
if (this._internalLogs.length > 0) {
return false;
}
var countersAllZero = true;
(0, _each3.default)(this._counters, function (val) {
if (val > 0) {
countersAllZero = false;
}
});
return countersAllZero;
}
}, {
key: '_addSpanRecord',
value: function _addSpanRecord(record) {
this._internalAddSpanRecord(record);
this.emit('span_added', record);
}
}, {
key: '_internalAddSpanRecord',
value: function _internalAddSpanRecord(record) {