yeebase/supervisor

Last activity on 1 January 2017
  • 4
  • 1
  • 4546
composer require yeebase/supervisor

A supervisor client package for Flow applications

1.0.0

A supervisor client package for Flow applications

Version
1.0.0
Type
neos-package
Release Date
20.01.2017 11:01:41
Source
git
Distribution
zip
Requires
Requires (dev)
None
Suggest
None
Provides
None
Conflicts
None
Replaces
None
LGPL-3.0+ 451809e13973ae4c373b317d64a41d50c4b139b2

Yeebase.Supervisor

With this TYPO3 Flow package you can control and monitor your supervisor daemon http://supervisord.org/api.html and all configured processes from your TYPO3 Flow application. You can use it to control workers that compute job queue tickets in a complex MessageQueue scenario.

Yeebase.Supervisor is an excellent addition to TYPO3 Flow's JobQueue.Common package and some MessageQueue backend like JobQueue.Beanstalkd:

You would like to defer jobs in a message queue and do things asyncronous within your TYPO3 Flow application?

An example MessageQueue stack with TYPO3 Flow:

  1. Supervisor Daemon - monitors and controls your job queue workers (they are doing the hard work) http://supervisord.org/
  2. Beanstalkd Message Queue- manages what jobs to give to the workers (stupid, fast) http://kr.github.io/beanstalkd/
  3. TYPO3.Jobqueue.Common - flow package for putting jobs/functions into an asyncronous pipeline (using a simple @Job\Defer annotation) https://git.typo3.org/Packages/TYPO3.Jobqueue.Common.git
  4. TYPO3.Jobqueue.Beanstalkd - The job queue implementation for Beanstalkd backends https://git.typo3.org/Packages/TYPO3.Jobqueue.Beanstalkd.git
  5. Yeebase.Supervisor client package - monitor and control all configured supervisor processes https://git.typo3.org/Packages/TYPO3.Jobqueue.Beanstalkd.git

Installation & configuration

Just add "yeebase/supervisor" as dependency to your composer.json and run a "composer update" in your root folder. You will also have to install the xml-rpc php extension (would be nice to remove this dependency in some future versions).

Configure the supervisor connection in your Settings.yaml:

Yeebase:
  Supervisor:
    host: 'unix:///var/run/supervisor.sock'
    port: -1
    timeout: 30
    username:
    password:

Command line tool

The Yeebase.Supervisor package comes with a simple Flow command controller:

1) Test the connection to supervisor and get some details

./flow supervisor:status

This should output something like this:

Successfully connected to supervisor service:
Address: unix:///var/run/supervisor.sock:-1
Identification: supervisor
Version: 3.0 
Api-Version: 3.0
State: RUNNING

2) Show all configured processes and their details

./flow supervisor:processes status all

Just type ./flow help supervisor to get an overview of all available commands or ./flow help supervisor:processes (f.e.) on how to use a specific command.

Using the SupervisorService in your own classes

The main part of the Yeebase.Supervisor package is a the supervisor client class named "SupervisorService". In TYPO3 Flow you can just inject this class to your custom controllers via the following php code:

...
use Yeebase\Supervisor\Service\SupervisorService;

/**
 * My funky class that shows details about configured supervisor processes
 */
class MyFunkyController extends AbstractBaseController {

    /**
     * @Flow\Inject
     * @var SupervisorService
     */
    protected $supervisorService;
...

If the SupervisorService has been injected you can use it in your class without initializing it manually - something like this:

  function showVersionAction() {
    $this->view->assign('version', $this->supervisorService->getVersion();  
  }
The content of the readme is provided by Github
The same vendor provides 2 package(s).