summaryrefslogtreecommitdiff
path: root/vendor/jonahgeorge/jaeger-client-php/src/Jaeger/Sender/JaegerSender.php
blob: dfce510b8b0b4a87c77547a221c8cb8a64190abd (plain)
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
<?php


namespace Jaeger\Sender;

use Jaeger\Mapper\SpanToJaegerMapper;
use Jaeger\Span as JaegerSpan;
use Jaeger\Thrift\Agent\AgentClient;
use Jaeger\Thrift\Agent\AgentIf;
use Jaeger\Thrift\Batch;
use Jaeger\Thrift\Process;
use Jaeger\Thrift\Span as JaegerThriftSpan;
use Jaeger\Thrift\Tag;
use Jaeger\Thrift\TagType;
use Jaeger\Tracer;
use Psr\Log\LoggerInterface;
use Psr\Log\NullLogger;
use Thrift\Protocol\TBinaryProtocol;
use Thrift\Protocol\TCompactProtocol;
use Thrift\Transport\TMemoryBuffer;
use const Jaeger\JAEGER_HOSTNAME_TAG_KEY;

class JaegerSender implements SenderInterface
{
    /**
     * @var JaegerSpan[]
     */
    private $spans = [];

    /**
     * @var AgentIf
     */
    private $agentClient;

    /**
     * @var LoggerInterface
     */
    private $logger;

    /**
     * @var Tracer
     */
    private $tracer;

    /**
     * @var SpanToJaegerMapper
     */
    private $mapper;

    /**
     * @var int
     */
    private $jaegerBatchOverheadLength = 512;

    /**
     * The maximum length of the thrift-objects for a jaeger-batch.
     *
     * @var int
     */
    private $maxBufferLength = 64000;

    /**
     * @param AgentIf $agentClient
     * @param LoggerInterface|null $logger
     * @param SpanToJaegerMapper|null $mapper
     */
    public function __construct(
        AgentIf $agentClient,
        LoggerInterface $logger = null,
        SpanToJaegerMapper $mapper = null
    ) {
        $this->agentClient = $agentClient;
        $this->logger = $logger ?? new NullLogger();
        $this->mapper = $mapper ?? new SpanToJaegerMapper();
    }


    public function flush(): int
    {
        $count = count($this->spans);
        if ($count === 0) {
            return 0;
        }

        $jaegerThriftSpans = $this->makeJaegerBatch($this->spans);

        try {
            $this->send($jaegerThriftSpans);
        } catch (\Exception $e) {
            $this->logger->warning($e->getMessage());
        }

        $this->spans = [];

        return $count;
    }

    public function setMaxBufferLength($maxBufferLength)
    {
        $this->maxBufferLength = $maxBufferLength;
    }

    /**
     * @param JaegerSpan[] $spans
     * @return array
     */
    private function makeJaegerBatch(array $spans) : array
    {
        /** @var JaegerThriftSpan[] $jaegerSpans */
        $jaegerSpans = [];

        foreach ($spans as $span) {
            if (empty($this->tracer)) {
                $this->tracer = $span->getTracer();
            }

            $jaegerSpans[] = $this->mapper->mapSpanToJaeger($span);
        }

        return $jaegerSpans;
    }

    /**
     * @param JaegerThriftSpan[] $spans
     */
    private function send(array $spans)
    {
        if (empty($this->tracer)) {
            return ;
        }

        $chunks = $this->chunkSplit($spans);
        foreach ($chunks as $chunk) {
            /** @var JaegerThriftSpan[] $chunk */
            $this->emitJaegerBatch($chunk);
        }
    }

    /**
     * @param JaegerThriftSpan $span
     */
    private function getBufferLength($span)
    {
        $memoryBuffer = new TMemoryBuffer();
        $span->write(new TBinaryProtocol($memoryBuffer));
        return $memoryBuffer->available();
    }

    private function chunkSplit(array $spans): array
    {
        $actualBufferSize = $this->jaegerBatchOverheadLength;
        $chunkId = 0;
        $chunks = [];

        foreach ($spans as $span) {
            $spanBufferLength = $this->getBufferLength($span);
            if (!empty($chunks[$chunkId]) && ($actualBufferSize + $spanBufferLength) > $this->maxBufferLength) {
                // point to next chunk
                ++$chunkId;

                // reset buffer size
                $actualBufferSize = $this->jaegerBatchOverheadLength;
            }

            if (!isset($chunks[$chunkId])) {
                $chunks[$chunkId] = [];
            }

            $chunks[$chunkId][] = $span;
            $actualBufferSize += $spanBufferLength;
        }

        return $chunks;
    }

    protected function emitJaegerBatch(array $spans)
    {
        /** @var Tag[] $tags */
        $tags = [];

        foreach ($this->tracer->getTags() as $k => $v) {
            if (!in_array($k, $this->mapper->getSpecialSpanTags())) {
                if (strpos($k, $this->mapper->getProcessTagsPrefix()) !== 0) {
                    continue ;
                }

                $quoted = preg_quote($this->mapper->getProcessTagsPrefix());
                $k = preg_replace(sprintf('/^%s/', $quoted), '', $k);
            }

            if ($k === JAEGER_HOSTNAME_TAG_KEY) {
                $k = "hostname";
            }

            $tags[] = new Tag([
                "key" => $k,
                "vType" => TagType::STRING,
                "vStr" => $v
            ]);
        }

        $tags[] = new Tag([
            "key" => "format",
            "vType" => TagType::STRING,
            "vStr" => "jaeger.thrift"
        ]);

        $tags[] = new Tag([
            "key" => "ip",
            "vType" => TagType::STRING,
            "vStr" => $this->tracer->getIpAddress()
        ]);

        $batch = new Batch([
            "spans" => $spans,
            "process" => new Process([
                "serviceName" => $this->tracer->getServiceName(),
                "tags" => $tags
            ])
        ]);

        $this->agentClient->emitBatch($batch);
    }

    /**
     * @param JaegerSpan $span
     */
    public function append(JaegerSpan $span)
    {
        $this->spans[] = $span;
    }

    public function close()
    {
    }
}