| 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 |
1×
1×
1×
1×
1×
1×
1×
1×
1×
33×
33×
33×
33×
33×
33×
33×
33×
33×
33×
33×
18×
33×
33×
33×
33×
109×
109×
33×
33×
33×
33×
28×
13×
13×
1×
12×
12×
1×
11×
10×
10×
10×
9×
1×
1×
1×
1×
1×
21×
21×
13×
8×
8×
8×
8×
8×
1×
7×
7×
1×
1×
6×
41×
41×
10×
10×
41×
8×
8×
19×
| // @flow
// 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 dgram from 'dgram';
import fs from 'fs';
import path from 'path';
import { Thrift } from 'thriftrw';
import NullLogger from '../logger.js';
const HOST = 'localhost';
const PORT = 6832;
const UDP_PACKET_MAX_LENGTH = 65000;
export default class UDPSender {
_host: string;
_port: number;
_maxPacketSize: number;
_process: Process;
_emitSpanBatchOverhead: number;
_logger: Logger;
_client: dgram$Socket;
_agentThrift: Thrift;
_jaegerThrift: Thrift;
_batch: Batch;
_thriftProcessMessage: any;
_maxSpanBytes: number; // maxPacketSize - (batch + tags overhead)
_totalSpanBytes: number; // size of currently batched spans as Thrift bytes
constructor(options: any = {}) {
this._host = options.host || HOST;
this._port = options.port || PORT;
this._maxPacketSize = options.maxPacketSize || UDP_PACKET_MAX_LENGTH;
this._logger = options.logger || new NullLogger();
this._client = dgram.createSocket('udp4');
this._client.on('error', err => {
this._logger.error(`error sending spans over UDP: ${err}`);
});
this._agentThrift = new Thrift({
entryPoint: path.join(__dirname, '../thriftrw-idl/agent.thrift'),
allowOptionalArguments: true,
allowFilesystemAccess: true,
});
this._jaegerThrift = new Thrift({
source: fs.readFileSync(path.join(__dirname, '../jaeger-idl/thrift/jaeger.thrift'), 'ascii'),
allowOptionalArguments: true,
});
this._totalSpanBytes = 0;
}
_calcBatchSize(batch: Batch) {
return this._agentThrift.Agent.emitBatch.argumentsMessageRW.byteLength(
this._convertBatchToThriftMessage()
).length;
}
_calcSpanSize(span: any): LengthResult {
return this._jaegerThrift.Span.rw.byteLength(new this._jaegerThrift.Span(span));
}
setProcess(process: Process): void {
// This function is only called once during reporter construction, and thus will
// give us the length of the batch before any spans have been added to the span
// list in batch.
this._process = process;
this._batch = {
process: this._process,
spans: [],
};
const tagMessages = [];
for (let j = 0; j < this._batch.process.tags.length; j++) {
const tag = this._batch.process.tags[j];
tagMessages.push(new this._jaegerThrift.Tag(tag));
}
this._thriftProcessMessage = new this._jaegerThrift.Process({
serviceName: this._batch.process.serviceName,
tags: tagMessages,
});
this._emitSpanBatchOverhead = this._calcBatchSize(this._batch);
this._maxSpanBytes = this._maxPacketSize - this._emitSpanBatchOverhead;
}
_invokeCallback(callback?: SenderCallback, numSpans: number, error?: string) {
if (callback) {
callback(numSpans, error);
}
}
append(span: any, callback?: SenderCallback): void {
const { err, length } = this._calcSpanSize(span);
if (err) {
this._invokeCallback(callback, 1, `error converting span to Thrift: ${err}`);
return;
}
const spanSize = length;
if (spanSize > this._maxSpanBytes) {
this._invokeCallback(
callback,
1,
`span size ${spanSize} is larger than maxSpanSize ${this._maxSpanBytes}`
);
return;
}
if (this._totalSpanBytes + spanSize <= this._maxSpanBytes) {
this._batch.spans.push(span);
this._totalSpanBytes += spanSize;
if (this._totalSpanBytes < this._maxSpanBytes) {
// still have space in the buffer, don't flush it yet
this._invokeCallback(callback, 0);
return;
}
// buffer size === this._maxSpanBytes
this.flush(callback);
return;
}
this.flush((numSpans: number, err?: string) => {
// TODO theoretically we can have buffer overflow here too, if many spans were appended during flush()
this._batch.spans.push(span);
this._totalSpanBytes += spanSize;
this._invokeCallback(callback, numSpans, err);
});
}
flush(callback?: SenderCallback): void {
const numSpans = this._batch.spans.length;
if (!numSpans) {
this._invokeCallback(callback, 0);
return;
}
const bufferLen = this._totalSpanBytes + this._emitSpanBatchOverhead;
const thriftBuffer = new Buffer(bufferLen);
const writeResult = this._agentThrift.Agent.emitBatch.argumentsMessageRW.writeInto(
this._convertBatchToThriftMessage(),
thriftBuffer,
0
);
this._reset();
if (writeResult.err) {
this._invokeCallback(callback, numSpans, `error writing Thrift object: ${writeResult.err}`);
return;
}
// Having the error callback here does not prevent uncaught exception from being thrown,
// that's why in the constructor we also add a general on('error') handler.
this._client.send(thriftBuffer, 0, thriftBuffer.length, this._port, this._host, (err, sent) => {
if (err) {
const error: string =
err &&
`error sending spans over UDP: ${err}, packet size: ${writeResult.offset}, bytes sent: ${sent}`;
this._invokeCallback(callback, numSpans, error);
} else {
this._invokeCallback(callback, numSpans);
}
});
}
_convertBatchToThriftMessage() {
const spanMessages = [];
for (let i = 0; i < this._batch.spans.length; i++) {
const span = this._batch.spans[i];
spanMessages.push(new this._jaegerThrift.Span(span));
}
return new this._agentThrift.Agent.emitBatch.ArgumentsMessage({
version: 1,
id: 0,
body: {
batch: new this._jaegerThrift.Batch({
process: this._thriftProcessMessage,
spans: spanMessages,
}),
},
});
}
_reset() {
this._batch.spans = [];
this._totalSpanBytes = 0;
}
close(): void {
this._client.close();
}
}
|