minor #27066 [Messenger] unwrap ReceivedMessage in LoggingMiddleware to improve log detail (kbond)

This PR was merged into the 4.1-dev branch.

Discussion
----------

[Messenger] unwrap ReceivedMessage in LoggingMiddleware to improve log detail

| Q             | A
| ------------- | ---
| Branch?       | master
| Bug fix?      | no
| New feature?  | no
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | -
| License       | MIT
| Doc PR        | -

The change gives better visibility in your logs when consuming messages.

Commits
-------

78bb0252b4 [Messenger] unwrap ReceivedMessage in LoggingMiddleware to improve log detail
This commit is contained in:
Tobias Schultze 2018-04-27 01:19:14 +02:00
commit 3b363a8808
1 changed files with 18 additions and 12 deletions

View File

@ -11,6 +11,7 @@
namespace Symfony\Component\Messenger\Middleware;
use Symfony\Component\Messenger\Asynchronous\Transport\ReceivedMessage;
use Symfony\Component\Messenger\MiddlewareInterface;
use Psr\Log\LoggerInterface;
@ -31,28 +32,33 @@ class LoggingMiddleware implements MiddlewareInterface
*/
public function handle($message, callable $next)
{
$this->logger->debug('Starting handling message {class}', array(
'message' => $message,
'class' => \get_class($message),
));
$this->logger->debug('Starting handling message {class}', $this->createContext($message));
try {
$result = $next($message);
} catch (\Throwable $e) {
$this->logger->warning('An exception occurred while handling message {class}', array(
'message' => $message,
'exception' => $e,
'class' => \get_class($message),
$this->logger->warning('An exception occurred while handling message {class}', array_merge(
$this->createContext($message),
array('exception' => $e)
));
throw $e;
}
$this->logger->debug('Finished handling message {class}', array(
'message' => $message,
'class' => \get_class($message),
));
$this->logger->debug('Finished handling message {class}', $this->createContext($message));
return $result;
}
private function createContext($message): array
{
if ($message instanceof ReceivedMessage) {
$message = $message->getMessage();
}
return array(
'message' => $message,
'class' => \get_class($message),
);
}
}