karo-io/messenger-monitor-bundle

Symfony bundle for information about your Messenger queues and transports

dev-master 2020-03-06 09:33 UTC

Requires

• php: ^7.1.3
• symfony/config: ^4.4|^5.0
• symfony/dependency-injection: ^4.4|^5.0
• symfony/event-dispatcher: ^4.4|^5.0
• symfony/framework-bundle: ^4.4|^5.0
• symfony/http-foundation: ^4.4|^5.0
• symfony/messenger: ^4.4|^5.0
• symfony/polyfill-uuid: ^1.13
• symfony/routing: ^4.4|^5.0
• symfony/twig-bundle: ^4.4|^5.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.16
• symfony/phpunit-bridge: ^5.0

MIT

• Peter Dietrich

README

Work on this repo here is currently stalled. You might want to check out https://github.com/nikophil/messenger-monitor-bundle where @nikophil is putting more energy into it

Messenger Monitor

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

This is in a development phase

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 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 karo-io/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 karo-io/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 [
    // ...
    KaroIO\MessengerMonitorBundle\KaroIOMessengerMonitorBundle::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