This package is abandoned and no longer maintained. The author suggests using the supervisorphp/supervisor package instead.

PHP library for Supervisor

v3.0.0 2015-01-13 01:44 UTC



This package has been moved under SupervisorPHP.

For details see

Indigo Supervisor

Latest Version Software License Build Status Code Coverage Quality Score HHVM Status Total Downloads Dependency Status

PHP library for managing supervisord through XML-RPC API.


Via Composer

$ composer require indigophp/supervisor


use Indigo\Supervisor\Supervisor;
use Indigo\Supervisor\Connector\XmlRpc;
use fXmlRpc\Client;
use fXmlRpc\Transport\Guzzle4Bridge;

// Pass the url and the bridge to the XmlRpc Client
$client = new Client(
	new Guzzle4Bridge(new \GuzzleHttp\Client(['defaults' => ['auth' => ['user', '123']]]))

// Pass the client to the connector
// See the full list of connectors bellow
$connector = new XmlRpc($client);

$supervisor = new Supervisor($connector);

// returns Process object
$process = $supervisor->getProcess('test_process');

// returns array of process info

// same as $supervisor->stopProcess($process);

// Don't wait for process start, return immediately
$supervisor->startProcess($process, false);

// returns true if running
// same as $process->checkState(Process::RUNNING);

// returns process name
echo $process;

// returns process information

Currently available connectors:

Note: fXmlRpc can be used with several HTTP Clients. See the list on it's website. This is the reason why Client specific connectors has been removed.


As of version 3.0.0 setCredentials is no longer part of the Connector interface (meaning responsibility has been fully removed).You have to provide authentication data to the HTTP Client of your choice. (For example Guzzle supports it out-of-the-box) Also, Bridges implemented by fXmlRpc supports to set custom headers.

Exception handling

For each possible fault response there is an exception. These exceptions extend a common exception, so you are able to catch a specific fault or all. When an unknown fault is returned from the server, an instance if the common exception is thrown. The list of fault responses and the appropriate exception can be found in the class.

use Indigo\Supervisor\Exception\Fault;
use Indigo\Supervisor\Exception\Fault\BadName;

try {
} catch (BadName $e) {
	// handle bad name error here
} catch (Fault $e) {
	// handle any other errors here

For developers: Fault exceptions are automatically generated, there is no need to manually modify them.

Configuration and Event listening

Configuration and Event components have been moved into their own repository. See #24 for explanation.

Further info

You can find the XML-RPC documentation here:


If you use PHP XML-RPC extension to parse responses (which is marked as EXPERIMENTAL). This can cause issues when you are trying to read/tail log of a PROCESS. Make sure you clean your log messages. The only information I found about this is a comment.

You will also have to make sure that you always call the functions with correct parameters. Zend connector will trigger an error when incorrect parameters are passed. See this issue for details. (Probably this won't change in near future based on my inspections of the code.) Other connectors will throw a Fault exception.


Here is a list of framework specific bundle packages:


$ phpspec run


Please see CONTRIBUTING for details.



The MIT License (MIT). Please see License File for more information.