symfonycasts/messenger-monitor-bundle

Symfony bundle for information about your Messenger queues and transports

dev-main 2024-10-22 16:56 UTC

Requires

• php: ^8.1
• ext-json: *
• symfony/config: ^5.4|^6.0|^7.0
• symfony/dependency-injection: ^5.4|^6.0|^7.0
• symfony/event-dispatcher: ^5.4|^6.0|^7.0
• symfony/framework-bundle: ^5.4|^6.0|^7.0
• symfony/http-foundation: ^5.4|^6.0|^7.0
• symfony/http-kernel: ^5.4|^6.0|^7.0
• symfony/messenger: ^5.4|^6.0|^7.0
• symfony/polyfill-uuid: ^1.23
• symfony/routing: ^5.4|^6.0|^7.0
• symfony/twig-bundle: ^5.4|^6.0|^7.0
• twig/twig: ^2.14.7|^3.0

Requires (Dev)

• doctrine/dbal: ^2.13.3
• doctrine/doctrine-bundle: ^2.0
• doctrine/orm: ^2.10
• php-cs-fixer/shim: ^3.17
• symfony/browser-kit: ^5.4|^6.0|^7.0
• symfony/css-selector: ^5.4|^6.0|^7.0
• symfony/doctrine-messenger: ^6.0|^7.0
• symfony/phpunit-bridge: ^5.4|^6.0|^7.0
• symfony/security-bundle: ^5.4|^6.0|^7.0

Conflicts

• symfony/doctrine-bridge: <5.4

MIT

• Peter Dietrich
• Nicolas PHILIPPE

README

Note THIS BUNDLE IS EXPERIMENTAL & UNSTABLE and may not work and probably isn't ready for production. It's also super rough and currently is in a development phase.

A Symfony Bundle to show you information about your Messenger queues/transports.

Implemented Features

• Show queue length in console (configure interval)

Planned Features

• Add admin route to see the queues in the browser
• Auto Refresh
• Refactor queue information to allow additional data
• Collect data (how? TBD)
• Show more queue information (avg time, ago, ...)

Phase 2

• Realtime updates in the browser (use TURTED_reactphp)

Installation

Make sure Composer is installed globally, as explained in the installation chapter of the Composer documentation.

Applications that use Symfony Flex

Open a command console, enter your project directory and execute:

$ composer require symfonycasts/messenger-monitor-bundle

Applications that don't use Symfony Flex

Step 1: Download the Bundle

Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:

$ composer require symfonycasts/messenger-monitor-bundle

Step 2: Enable the Bundle

Then, enable the bundle by adding it to the list of registered bundles in the config/bundles.php file of your project:

// config/bundles.php

return [
    // ...
    SymfonyCasts\MessengerMonitorBundle\SymfonyCastsMessengerMonitorBundle::class => ['all' => true],
];

Usage

• bin/console messenger:monitor to refresh every 3 seconds (default)
• bin/console messenger:monitor -i 0 to get the information only once
• bin/console messenger:monitor -i 1 to refresh every second

Check bin/console help messenger:monitor for more information.