Tideways Middleware for Symfony Messenger

Note

Please note that when using the Tideways-Extension version 5.18.0 or greater this middleware is not needed anymore, as the Tideways instruments the messenger automatically.

See: https://tideways.com/profiler/blog/changelog/automatic-transaction-names-for-symfony-shopware-and-laravel-background-jobs

This middleware for Symfony Messenger starts a Tideways trace for every processed message, names the trace after the message class and implements integration with Tideways exception tracking.

If you want to see traces for processed messages, then the INI setting tideways.enable_cli=1 must be set.

Tideways is a monitoring, profiling and exception tracking combo for PHP.

Installation

composer require tideways/symfony-messenger-middleware

Configuration for Symfony

framework:
  messenger:
    buses:
      default:
        middleware:
          - "Tideways\\SymfonyMessenger\\TidewaysOnlyConsumedByWorkerMiddleware"

services:
  "Tideways\\SymfonyMessenger\\TidewaysOnlyConsumedByWorkerMiddleware": ~

Configuration for Shopware 6.5

Shopware uses the Symfony Messenger under the hood and using this middleware requires just a slightly different configuration:

# config/packages/messenger.yaml
framework:
  messenger:
    # here are other sections "transport", "routing" already configured by Shopware.

    buses:
      messenger.bus.default:
        middleware:
          - "Tideways\\SymfonyMessenger\\TidewaysOnlyConsumedByWorkerMiddleware"

services:
  "Tideways\\SymfonyMessenger\\TidewaysOnlyConsumedByWorkerMiddleware": ~

Configuration for Shopware 6.4

Shopware uses the Symfony Messenger under the hood and using this middleware requires just a slightly different configuration:

# config/packages/messenger.yaml
framework:
  messenger:
    # here might be other config values already "transports" and "routing".

    buses:
      messenger.bus.shopware:
        middleware:
          - "Shopware\\Core\\Framework\\MessageQueue\\Middleware\\RetryMiddleware"
          - "Tideways\\SymfonyMessenger\\TidewaysOnlyConsumedByWorkerMiddleware"

services:
  "Tideways\\SymfonyMessenger\\TidewaysOnlyConsumedByWorkerMiddleware": ~

Configuration for TYPO3

TYPO3 uses the Symfony Messenger under the hood and using this middleware requires just a slightly different configuration:

# YOUR_EXTENSION/Configuration/Services.yaml
services:
  Tideways\SymfonyMessenger\TidewaysOnlyConsumedByWorkerMiddleware:
    tags:
      - name: 'messenger.middleware'
        before: 'Symfony\Component\Messenger\Middleware\SendMessageMiddleware'