Skip to content

feat(sentry): improve transaction handling in coroutine contexts #922

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
huangdijia merged 1 commit into from
Sep 26, 2025
Merged

feat(sentry): improve transaction handling in coroutine contexts #922

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
286 changes: 152 additions & 134 deletions src/sentry/src/Tracing/Listener/EventHandleListener.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -386,13 +386,21 @@ protected function handleCommandStarting(CommandEvent\BeforeHandle $event): void

$command = $event->getCommand();

startTransaction(
$transaction = startTransaction(
TransactionContext::make()
->setName($command->getName() ?: '<unnamed command>')
->setOp('console.command')
->setDescription($command->getDescription())
->setOrigin('auto.command')
);

Coroutine::inCoroutine() && defer(function () use ($transaction) {
// Make sure the transaction is finished after the command is executed
SentrySdk::getCurrentHub()->setSpan($transaction);

// Finish transaction
$transaction->finish();
});
}

protected function handleCommandFinished(CommandEvent\AfterExecute $event): void
Expand Down Expand Up @@ -435,9 +443,11 @@ protected function handleCommandFinished(CommandEvent\AfterExecute $event): void
$exitCode == SymfonyCommand::SUCCESS ? SpanStatus::ok() : SpanStatus::internalError()
);
} finally {
SentrySdk::getCurrentHub()->setSpan($transaction);
if (! Coroutine::inCoroutine()) {
SentrySdk::getCurrentHub()->setSpan($transaction);

$transaction->finish();
$transaction->finish();
}
}
}

Expand Down Expand Up @@ -504,14 +514,22 @@ protected function handleCrontabTaskStarting(CrontabEvent\BeforeExecute $event):

$crontab = $event->crontab;

startTransaction(
$transaction = startTransaction(
TransactionContext::make()
->setName($crontab->getName() ?: '<unnamed crontab>')
->setOp('crontab.run')
->setDescription($crontab->getMemo())
->setOrigin('auto.crontab')
->setSource(TransactionSource::task())
);

defer(function () use ($transaction) {
// Make sure the transaction is finished after the task is executed
SentrySdk::getCurrentHub()->setSpan($transaction);

// Finish transaction
$transaction->finish();
});
}

protected function handleCrontabTaskFinished(CrontabEvent\FailToExecute|CrontabEvent\AfterExecute $event): void
Expand All @@ -522,33 +540,27 @@ protected function handleCrontabTaskFinished(CrontabEvent\FailToExecute|CrontabE
return;
}

try {
$crontab = $event->crontab;
$transaction->setTags([
'crontab.rule' => $crontab->getRule(),
'crontab.type' => $crontab->getType(),
'crontab.options.is_single' => $crontab->isSingleton(),
'crontab.options.is_on_one_server' => $crontab->isOnOneServer(),
]);

if (method_exists($event, 'getThrowable') && $exception = $event->getThrowable()) {
$transaction->setStatus(SpanStatus::internalError())
->setTags([
'error' => 'true',
'exception.class' => $exception::class,
'exception.code' => (string) $exception->getCode(),
])
->setData([
'exception.message' => $exception->getMessage(),
]);
if ($this->switcher->isTracingExtraTagEnabled('exception.stack_trace')) {
$transaction->setData(['exception.stack_trace' => (string) $exception]);
}
$crontab = $event->crontab;
$transaction->setTags([
'crontab.rule' => $crontab->getRule(),
'crontab.type' => $crontab->getType(),
'crontab.options.is_single' => $crontab->isSingleton(),
'crontab.options.is_on_one_server' => $crontab->isOnOneServer(),
]);

if (method_exists($event, 'getThrowable') && $exception = $event->getThrowable()) {
$transaction->setStatus(SpanStatus::internalError())
->setTags([
'error' => 'true',
'exception.class' => $exception::class,
'exception.code' => (string) $exception->getCode(),
])
->setData([
'exception.message' => $exception->getMessage(),
]);
if ($this->switcher->isTracingExtraTagEnabled('exception.stack_trace')) {
$transaction->setData(['exception.stack_trace' => (string) $exception]);
}
} finally {
SentrySdk::getCurrentHub()->setSpan($transaction);

$transaction->finish();
}
}

Expand All @@ -572,13 +584,21 @@ protected function handleAmqpMessageProcessing(AmqpEvent\BeforeConsume $event):
}
}

startTransaction(
$transaction = startTransaction(
continueTrace($carrier?->getSentryTrace() ?? '', $carrier?->getBaggage() ?? '')
->setName($message::class)
->setOp('queue.process')
->setDescription($message::class)
->setOrigin('auto.amqp')
);

defer(function () use ($transaction) {
// Make sure the transaction is finished after the message is processed
SentrySdk::getCurrentHub()->setSpan($transaction);

// Finish transaction
$transaction->finish();
});
}

protected function handleAmqpMessageProcessed(AmqpEvent\AfterConsume|AmqpEvent\FailToConsume $event): void
Expand All @@ -589,46 +609,40 @@ protected function handleAmqpMessageProcessed(AmqpEvent\AfterConsume|AmqpEvent\F
return;
}

try {
/** @var null|Carrier $carrier */
$carrier = Context::get(Constants::TRACE_CARRIER);

/** @var ConsumerMessage $message */
$message = $event->getMessage();
$transaction->setData([
'messaging.system' => 'amqp',
'messaging.operation' => 'process',
'messaging.message.id' => $carrier?->get('message_id'),
'messaging.message.body.size' => $carrier?->get('body_size'),
'messaging.message.receive.latency' => $carrier?->has('publish_time') ? (microtime(true) - $carrier->get('publish_time')) : null,
'messaging.message.retry.count' => 0,
'messaging.destination.name' => $carrier?->get('destination_name') ?: implode(', ', (array) $message->getRoutingKey()),
'messaging.amqp.message.type' => $message->getTypeString(),
'messaging.amqp.message.routing_key' => $message->getRoutingKey(),
'messaging.amqp.message.exchange' => $message->getExchange(),
'messaging.amqp.message.queue' => $message->getQueue(),
'messaging.amqp.message.pool_name' => $message->getPoolName(),
'messaging.amqp.message.result' => $event instanceof AmqpEvent\AfterConsume ? $event->getResult()->value : 'fail',
]);
/** @var null|Carrier $carrier */
$carrier = Context::get(Constants::TRACE_CARRIER);

if (method_exists($event, 'getThrowable') && $exception = $event->getThrowable()) {
$transaction->setStatus(SpanStatus::internalError())
->setTags([
'error' => 'true',
'exception.class' => $exception::class,
'exception.code' => (string) $exception->getCode(),
])
->setData([
'exception.message' => $exception->getMessage(),
]);
if ($this->switcher->isTracingExtraTagEnabled('exception.stack_trace')) {
$transaction->setData(['exception.stack_trace' => (string) $exception]);
}
/** @var ConsumerMessage $message */
$message = $event->getMessage();
$transaction->setData([
'messaging.system' => 'amqp',
'messaging.operation' => 'process',
'messaging.message.id' => $carrier?->get('message_id'),
'messaging.message.body.size' => $carrier?->get('body_size'),
'messaging.message.receive.latency' => $carrier?->has('publish_time') ? (microtime(true) - $carrier->get('publish_time')) : null,
'messaging.message.retry.count' => 0,
'messaging.destination.name' => $carrier?->get('destination_name') ?: implode(', ', (array) $message->getRoutingKey()),
'messaging.amqp.message.type' => $message->getTypeString(),
'messaging.amqp.message.routing_key' => $message->getRoutingKey(),
'messaging.amqp.message.exchange' => $message->getExchange(),
'messaging.amqp.message.queue' => $message->getQueue(),
'messaging.amqp.message.pool_name' => $message->getPoolName(),
'messaging.amqp.message.result' => $event instanceof AmqpEvent\AfterConsume ? $event->getResult()->value : 'fail',
]);

if (method_exists($event, 'getThrowable') && $exception = $event->getThrowable()) {
$transaction->setStatus(SpanStatus::internalError())
->setTags([
'error' => 'true',
'exception.class' => $exception::class,
'exception.code' => (string) $exception->getCode(),
])
->setData([
'exception.message' => $exception->getMessage(),
]);
if ($this->switcher->isTracingExtraTagEnabled('exception.stack_trace')) {
$transaction->setData(['exception.stack_trace' => (string) $exception]);
}
} finally {
SentrySdk::getCurrentHub()->setSpan($transaction);

$transaction->finish();
}
}

Expand All @@ -652,13 +666,21 @@ protected function handleKafkaMessageProcessing(KafkaEvent\BeforeConsume $event)
}
}

startTransaction(
$transaction = startTransaction(
continueTrace($carrier?->getSentryTrace() ?? '', $carrier?->getBaggage() ?? '')
->setName($consumer->getTopic() . ' process')
->setOp('queue.process')
->setDescription($consumer::class)
->setOrigin('auto.kafka')
);

defer(function () use ($transaction) {
// Make sure the transaction is finished after the message is processed
SentrySdk::getCurrentHub()->setSpan($transaction);

// Finish transaction
$transaction->finish();
});
}

protected function handleKafkaMessageProcessed(KafkaEvent\AfterConsume|KafkaEvent\FailToConsume $event): void
Expand All @@ -669,40 +691,34 @@ protected function handleKafkaMessageProcessed(KafkaEvent\AfterConsume|KafkaEven
return;
}

try {
/** @var null|Carrier $carrier */
$carrier = Context::get(Constants::TRACE_CARRIER);
$consumer = $event->getConsumer();
$transaction->setData([
'messaging.system' => 'kafka',
'messaging.operation' => 'process',
'messaging.message.id' => $carrier?->get('message_id'),
'messaging.message.body.size' => $carrier?->get('body_size'),
'messaging.message.receive.latency' => $carrier?->has('publish_time') ? (microtime(true) - $carrier->get('publish_time')) : null,
'messaging.message.retry.count' => 0,
'messaging.destination.name' => $carrier?->get('destination_name') ?: (is_array($consumer->getTopic()) ? implode(',', $consumer->getTopic()) : $consumer->getTopic()),
'messaging.kafka.consumer.group' => $consumer->getGroupId(),
'messaging.kafka.consumer.pool' => $consumer->getPool(),
]);

if (method_exists($event, 'getThrowable') && $exception = $event->getThrowable()) {
$transaction->setStatus(SpanStatus::internalError())
->setTags([
'error' => 'true',
'exception.class' => $exception::class,
'exception.code' => (string) $exception->getCode(),
])
->setData([
'exception.message' => $exception->getMessage(),
]);
if ($this->switcher->isTracingExtraTagEnabled('exception.stack_trace')) {
$transaction->setData(['exception.stack_trace' => (string) $exception]);
}
/** @var null|Carrier $carrier */
$carrier = Context::get(Constants::TRACE_CARRIER);
$consumer = $event->getConsumer();
$transaction->setData([
'messaging.system' => 'kafka',
'messaging.operation' => 'process',
'messaging.message.id' => $carrier?->get('message_id'),
'messaging.message.body.size' => $carrier?->get('body_size'),
'messaging.message.receive.latency' => $carrier?->has('publish_time') ? (microtime(true) - $carrier->get('publish_time')) : null,
'messaging.message.retry.count' => 0,
'messaging.destination.name' => $carrier?->get('destination_name') ?: (is_array($consumer->getTopic()) ? implode(',', $consumer->getTopic()) : $consumer->getTopic()),
'messaging.kafka.consumer.group' => $consumer->getGroupId(),
'messaging.kafka.consumer.pool' => $consumer->getPool(),
]);

if (method_exists($event, 'getThrowable') && $exception = $event->getThrowable()) {
$transaction->setStatus(SpanStatus::internalError())
->setTags([
'error' => 'true',
'exception.class' => $exception::class,
'exception.code' => (string) $exception->getCode(),
])
->setData([
'exception.message' => $exception->getMessage(),
]);
if ($this->switcher->isTracingExtraTagEnabled('exception.stack_trace')) {
$transaction->setData(['exception.stack_trace' => (string) $exception]);
}
} finally {
SentrySdk::getCurrentHub()->setSpan($transaction);

$transaction->finish();
}
}

Expand All @@ -716,13 +732,21 @@ protected function handleAsyncQueueJobProcessing(AsyncQueueEvent\BeforeHandle $e
$carrier = Context::get(Constants::TRACE_CARRIER, null, Coroutine::parentId());
$job = $event->getMessage()->job();

startTransaction(
$transaction = startTransaction(
continueTrace($carrier?->getSentryTrace() ?? '', $carrier?->getBaggage() ?? '')
->setName($job::class)
->setOp('queue.process')
->setDescription('async_queue: ' . $job::class)
->setOrigin('auto.async_queue')
);

defer(function () use ($transaction) {
// Make sure the transaction is finished after the job is processed
SentrySdk::getCurrentHub()->setSpan($transaction);

// Finish transaction
$transaction->finish();
});
}

protected function handleAsyncQueueJobProcessed(AsyncQueueEvent\AfterHandle|AsyncQueueEvent\RetryHandle|AsyncQueueEvent\FailedHandle $event): void
Expand All @@ -733,37 +757,31 @@ protected function handleAsyncQueueJobProcessed(AsyncQueueEvent\AfterHandle|Asyn
return;
}

try {
/** @var null|Carrier $carrier */
$carrier = Context::get(Constants::TRACE_CARRIER, null, Coroutine::parentId());
$transaction->setData([
'messaging.system' => 'async_queue',
'messaging.operation' => 'process',
'messaging.message.id' => $carrier?->get('message_id'),
'messaging.message.body.size' => $carrier?->get('body_size'),
'messaging.message.receive.latency' => $carrier?->has('publish_time') ? (microtime(true) - $carrier->get('publish_time')) : null,
'messaging.message.retry.count' => $event->getMessage()->getAttempts(),
'messaging.destination.name' => $carrier?->get('destination_name') ?: 'unknown queue',
]);

if (method_exists($event, 'getThrowable') && $exception = $event->getThrowable()) {
$transaction->setStatus(SpanStatus::internalError())
->setTags([
'error' => 'true',
'exception.class' => $exception::class,
'exception.code' => (string) $exception->getCode(),
])
->setData([
'exception.message' => $exception->getMessage(),
]);
if ($this->switcher->isTracingExtraTagEnabled('exception.stack_trace')) {
$transaction->setData(['exception.stack_trace' => (string) $exception]);
}
/** @var null|Carrier $carrier */
$carrier = Context::get(Constants::TRACE_CARRIER, null, Coroutine::parentId());
$transaction->setData([
'messaging.system' => 'async_queue',
'messaging.operation' => 'process',
'messaging.message.id' => $carrier?->get('message_id'),
'messaging.message.body.size' => $carrier?->get('body_size'),
'messaging.message.receive.latency' => $carrier?->has('publish_time') ? (microtime(true) - $carrier->get('publish_time')) : null,
'messaging.message.retry.count' => $event->getMessage()->getAttempts(),
'messaging.destination.name' => $carrier?->get('destination_name') ?: 'unknown queue',
]);

if (method_exists($event, 'getThrowable') && $exception = $event->getThrowable()) {
$transaction->setStatus(SpanStatus::internalError())
->setTags([
'error' => 'true',
'exception.class' => $exception::class,
'exception.code' => (string) $exception->getCode(),
])
->setData([
'exception.message' => $exception->getMessage(),
]);
if ($this->switcher->isTracingExtraTagEnabled('exception.stack_trace')) {
$transaction->setData(['exception.stack_trace' => (string) $exception]);
}
} finally {
SentrySdk::getCurrentHub()->setSpan($transaction);

$transaction->finish();
}
}

Expand Down