/
EventHandler.php
426 lines (359 loc) · 13.1 KB
/
EventHandler.php
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
<?php
namespace Sentry\Laravel\Tracing;
use Exception;
use Illuminate\Contracts\Container\BindingResolutionException;
use Illuminate\Contracts\Container\Container;
use Illuminate\Contracts\Events\Dispatcher;
use Illuminate\Database\Events as DatabaseEvents;
use Illuminate\Queue\Events as QueueEvents;
use Illuminate\Queue\Queue;
use Illuminate\Queue\QueueManager;
use Illuminate\Routing\Events as RoutingEvents;
use Illuminate\Routing\Route;
use RuntimeException;
use Sentry\Laravel\Integration;
use Sentry\SentrySdk;
use Sentry\Tracing\SpanContext;
use Sentry\Tracing\SpanStatus;
use Sentry\Tracing\TransactionContext;
use Sentry\Tracing\TransactionSource;
class EventHandler
{
public const QUEUE_PAYLOAD_TRACE_PARENT_DATA = 'sentry_trace_parent_data';
public const QUEUE_PAYLOAD_BAGGAGE_DATA = 'sentry_baggage_data';
/**
* Map event handlers to events.
*
* @var array
*/
protected static $eventHandlerMap = [
'router.matched' => 'routerMatched', // Until Laravel 5.1
RoutingEvents\RouteMatched::class => 'routeMatched', // Since Laravel 5.2
'illuminate.query' => 'query', // Until Laravel 5.1
DatabaseEvents\QueryExecuted::class => 'queryExecuted', // Since Laravel 5.2
];
/**
* Map queue event handlers to events.
*
* @var array
*/
protected static $queueEventHandlerMap = [
QueueEvents\JobProcessing::class => 'queueJobProcessing', // Since Laravel 5.2
QueueEvents\JobProcessed::class => 'queueJobProcessed', // Since Laravel 5.2
QueueEvents\JobExceptionOccurred::class => 'queueJobExceptionOccurred', // Since Laravel 5.2
];
/**
* The Laravel container.
*
* @var \Illuminate\Contracts\Container\Container
*/
private $container;
/**
* Indicates if we should we add SQL queries as spans.
*
* @var bool
*/
private $traceSqlQueries;
/**
* Indicates if we should we add SQL query origin data to query spans.
*
* @var bool
*/
private $traceSqlQueryOrigins;
/**
* Indicates if we should trace queue job spans.
*
* @var bool
*/
private $traceQueueJobs;
/**
* Indicates if we should trace queue jobs as separate transactions.
*
* @var bool
*/
private $traceQueueJobsAsTransactions;
/**
* Holds a reference to the parent queue job span.
*
* @var \Sentry\Tracing\Span|null
*/
private $parentQueueJobSpan;
/**
* Holds a reference to the current queue job span or transaction.
*
* @var \Sentry\Tracing\Transaction|\Sentry\Tracing\Span|null
*/
private $currentQueueJobSpan;
/**
* The backtrace helper.
*
* @var \Sentry\Laravel\Tracing\BacktraceHelper
*/
private $backtraceHelper;
/**
* EventHandler constructor.
*
* @param \Illuminate\Contracts\Container\Container $container
* @param \Sentry\Laravel\Tracing\BacktraceHelper $backtraceHelper
* @param array $config
*/
public function __construct(Container $container, BacktraceHelper $backtraceHelper, array $config)
{
$this->container = $container;
$this->backtraceHelper = $backtraceHelper;
$this->traceSqlQueries = ($config['sql_queries'] ?? true) === true;
$this->traceSqlQueryOrigins = ($config['sql_origin'] ?? true) === true;
$this->traceQueueJobs = ($config['queue_jobs'] ?? false) === true;
$this->traceQueueJobsAsTransactions = ($config['queue_job_transactions'] ?? false) === true;
}
/**
* Attach all event handlers.
*
* @uses self::routeMatchedHandler()
* @uses self::routerMatchedHandler()
* @uses self::queryHandler()
* @uses self::queryExecutedHandler()
*/
public function subscribe(): void
{
try {
/** @var \Illuminate\Contracts\Events\Dispatcher $dispatcher */
$dispatcher = $this->container->make(Dispatcher::class);
foreach (static::$eventHandlerMap as $eventName => $handler) {
$dispatcher->listen($eventName, [$this, $handler]);
}
} catch (BindingResolutionException $e) {
// If we cannot resolve the event dispatcher we also cannot listen to events
}
}
/**
* Attach all queue event handlers.
*
* @param \Illuminate\Queue\QueueManager $queue
*
* @uses self::queueJobProcessedHandler()
* @uses self::queueJobProcessingHandler()
* @uses self::queueJobExceptionOccurredHandler()
*/
public function subscribeQueueEvents(QueueManager $queue): void
{
// If both types of queue job tracing is disabled also do not register the events
if (!$this->traceQueueJobs && !$this->traceQueueJobsAsTransactions) {
return;
}
// The payload create callback was introduced in Laravel 5.7 so we need to guard against older versions
if (method_exists(Queue::class, 'createPayloadUsing')) {
Queue::createPayloadUsing(static function (?string $connection, ?string $queue, ?array $payload): ?array {
$currentSpan = Integration::currentTracingSpan();
if ($currentSpan !== null && $payload !== null) {
$payload[self::QUEUE_PAYLOAD_TRACE_PARENT_DATA] = $currentSpan->toTraceparent();
$payload[self::QUEUE_PAYLOAD_BAGGAGE_DATA] = $currentSpan->toBaggage();
}
return $payload;
});
}
$queue->looping(function () {
$this->afterQueuedJob();
});
try {
/** @var \Illuminate\Contracts\Events\Dispatcher $dispatcher */
$dispatcher = $this->container->make(Dispatcher::class);
foreach (static::$queueEventHandlerMap as $eventName => $handler) {
$dispatcher->listen($eventName, [$this, $handler]);
}
} catch (BindingResolutionException $e) {
// If we cannot resolve the event dispatcher we also cannot listen to events
}
}
/**
* Pass through the event and capture any errors.
*
* @param string $method
* @param array $arguments
*/
public function __call(string $method, array $arguments)
{
$handlerMethod = "{$method}Handler";
if (!method_exists($this, $handlerMethod)) {
throw new RuntimeException("Missing tracing event handler: {$handlerMethod}");
}
try {
call_user_func_array([$this, $handlerMethod], $arguments);
} catch (Exception $exception) {
// Ignore
}
}
/**
* Until Laravel 5.1
*
* @param Route $route
*/
protected function routerMatchedHandler(Route $route): void
{
$transaction = Integration::currentTransaction();
if ($transaction === null) {
return;
}
[$transactionName, $transactionSource] = Integration::extractNameAndSourceForRoute($route);
$transaction->setName($transactionName);
$transaction->getMetadata()->setSource($transactionSource);
}
/**
* Since Laravel 5.2
*
* @param \Illuminate\Routing\Events\RouteMatched $match
*/
protected function routeMatchedHandler(RoutingEvents\RouteMatched $match): void
{
$this->routerMatchedHandler($match->route);
}
/**
* Until Laravel 5.1
*
* @param string $query
* @param array $bindings
* @param int $time
* @param string $connectionName
*/
protected function queryHandler($query, $bindings, $time, $connectionName): void
{
$this->recordQuerySpan($query, $time);
}
/**
* Since Laravel 5.2
*
* @param \Illuminate\Database\Events\QueryExecuted $query
*/
protected function queryExecutedHandler(DatabaseEvents\QueryExecuted $query): void
{
$this->recordQuerySpan($query->sql, $query->time);
}
/**
* Helper to add an query breadcrumb.
*
* @param string $query
* @param float|null $time
*/
private function recordQuerySpan($query, $time): void
{
if (!$this->traceSqlQueries) {
return;
}
$parentSpan = Integration::currentTracingSpan();
// If there is no tracing span active there is no need to handle the event
if ($parentSpan === null) {
return;
}
$context = new SpanContext();
$context->setOp('db.sql.query');
$context->setDescription($query);
$context->setStartTimestamp(microtime(true) - $time / 1000);
$context->setEndTimestamp($context->getStartTimestamp() + $time / 1000);
if ($this->traceSqlQueryOrigins) {
$queryOrigin = $this->resolveQueryOriginFromBacktrace();
if ($queryOrigin !== null) {
$context->setData(['sql.origin' => $queryOrigin]);
}
}
$parentSpan->startChild($context);
}
/**
* Try to find the origin of the SQL query that was just executed.
*
* @return string|null
*/
private function resolveQueryOriginFromBacktrace(): ?string
{
$firstAppFrame = $this->backtraceHelper->findFirstInAppFrameForBacktrace(debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS));
if ($firstAppFrame === null) {
return null;
}
$filePath = $this->backtraceHelper->getOriginalViewPathForFrameOfCompiledViewPath($firstAppFrame) ?? $firstAppFrame->getFile();
return "{$filePath}:{$firstAppFrame->getLine()}";
}
/**
* Since Laravel 5.2
*
* @param \Illuminate\Queue\Events\JobProcessing $event
*/
protected function queueJobProcessingHandler(QueueEvents\JobProcessing $event): void
{
$parentSpan = Integration::currentTracingSpan();
// If there is no tracing span active and we don't trace jobs as transactions there is no need to handle the event
if ($parentSpan === null && !$this->traceQueueJobsAsTransactions) {
return;
}
// If there is a parent span we can record that job as a child unless configured to not do so
if ($parentSpan !== null && !$this->traceQueueJobs) {
return;
}
if ($parentSpan === null) {
$baggage = $event->job->payload()[self::QUEUE_PAYLOAD_BAGGAGE_DATA] ?? null;
$traceParent = $event->job->payload()[self::QUEUE_PAYLOAD_TRACE_PARENT_DATA] ?? null;
$context = TransactionContext::fromHeaders($traceParent ?? '', $baggage ?? '');
// If the parent transaction was not sampled we also stop the queue job from being recorded
if ($context->getParentSampled() === false) {
return;
}
} else {
$context = new SpanContext;
}
$job = [
'job' => $event->job->getName(),
'queue' => $event->job->getQueue(),
'attempts' => $event->job->attempts(),
'connection' => $event->connectionName,
];
// Resolve name exists only from Laravel 5.3+
$resolvedJobName = method_exists($event->job, 'resolveName')
? $event->job->resolveName()
: null;
if ($resolvedJobName !== null) {
$job['resolved'] = $resolvedJobName;
}
if ($context instanceof TransactionContext) {
$context->setName($resolvedJobName ?? $event->job->getName());
$context->setSource(TransactionSource::task());
}
$context->setOp('queue.process');
$context->setData($job);
$context->setStartTimestamp(microtime(true));
// When the parent span is null we start a new transaction otherwise we start a child of the current span
if ($parentSpan === null) {
$this->currentQueueJobSpan = SentrySdk::getCurrentHub()->startTransaction($context);
} else {
$this->currentQueueJobSpan = $parentSpan->startChild($context);
}
$this->parentQueueJobSpan = $parentSpan;
SentrySdk::getCurrentHub()->setSpan($this->currentQueueJobSpan);
}
/**
* Since Laravel 5.2
*
* @param \Illuminate\Queue\Events\JobExceptionOccurred $event
*/
protected function queueJobExceptionOccurredHandler(QueueEvents\JobExceptionOccurred $event): void
{
$this->afterQueuedJob(SpanStatus::internalError());
}
/**
* Since Laravel 5.2
*
* @param \Illuminate\Queue\Events\JobProcessed $event
*/
protected function queueJobProcessedHandler(QueueEvents\JobProcessed $event): void
{
$this->afterQueuedJob(SpanStatus::ok());
}
private function afterQueuedJob(?SpanStatus $status = null): void
{
if ($this->currentQueueJobSpan === null) {
return;
}
$this->currentQueueJobSpan->setStatus($status);
$this->currentQueueJobSpan->finish();
$this->currentQueueJobSpan = null;
SentrySdk::getCurrentHub()->setSpan($this->parentQueueJobSpan);
$this->parentQueueJobSpan = null;
}
}