supervisor

supervisor

Biblioteca PHP para la gestión supervisor a través de API XML-RPC.

Instalar

Vía compositor

supervisor ">

composer require supervisor php/ supervisor 

Uso

Esta biblioteca depende de la rápida y potente biblioteca fXmlRpc, que admite varios adaptadores para utilizar su cliente HTTP preferido para realizar conexiones.

En el siguiente ejemplo, utilizaremos la popular biblioteca cliente HTTP Guzzle.

Este ejemplo requiere algunas bibliotecas adicionales para funcionar. Para incluir los componentes adicionales necesarios, puede ejecutar:

composer require guzzlehttp/guzzle:^7.0

Este ejemplo muestra cómo pasar credenciales de autenticación a Guzzle, iniciar el cliente fXmlRpc y pasarlo al supervisor PHP.

supervisor.sock', ], ]); $client = new fXmlRpcClient( 'http://localhost/RPC2', new fXmlRpcTransportPsrTransport( new GuzzleHttpPsr7HttpFactory(), $guzzleClient ) ); // Pass the client to the supervisor library. $ supervisor = new supervisor supervisor ($client); // returns Process object $process = $ supervisor ->getProcess('test_process'); // returns array of process info $ supervisor ->getProcessInfo('test_process'); // same as $ supervisor ->stopProcess($process); $ supervisor ->stopProcess('test_process'); // Don't wait for process start, return immediately $ supervisor ->startProcess($process, false); // returns true if running // same as $process->checkState(Process::RUNNING); $process->isRunning(); // returns process name echo $process; // returns process information $process->getPayload();">

 // Create Guzzle HTTP client
$ guzzleClient = new  GuzzleHttp  Client ([
    ' auth ' => [ ' user ' , ' 123 ' ],
]);

// Pass the url and the guzzle client to the fXmlRpc Client
$ client = new fXmlRpc  Client (
    ' http://127.0.0.1:9001/RPC2 ' ,
    new fXmlRpc  Transport  PsrTransport (
        new GuzzleHttp  Psr7  HttpFactory (),
        $ guzzleClient
    )
);

// Or, if connecting via a Unix Domain Socket
$ guzzleClient = new  GuzzleHttp  Client ([
    ' curl ' => [
         CURLOPT_UNIX_SOCKET_PATH => ' /var/run/ supervisor .sock ' ,
    ],
]);

$ client = new fXmlRpc  Client (
    ' http://localhost/RPC2 ' ,
    new fXmlRpc  Transport  PsrTransport (
        new GuzzleHttp  Psr7  HttpFactory (),
        $ guzzleClient
    )
);

// Pass the client to the supervisor library.
$ supervisor = new supervisor  supervisor ( $ client );

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

// returns array of process info
$ supervisor -> getProcessInfo ( ' test_process ' );

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

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

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

// returns process name
echo $ process ;

// returns process information
$ process -> getPayload ();

Manejo de excepciones

Para cada posible respuesta a un fallo hay una excepción. Estas excepciones amplían una excepción común, por lo que puede detectar una falla específica o todas. Cuando el servidor devuelve una falla desconocida, se genera una instancia si se genera la excepción común. La lista de respuestas a fallos y la excepción apropiada se pueden encontrar en la clase.

supervisor $ supervisor */ try { $ supervisor ->startProcess('process', true); } catch ( supervisor ExceptionFaultBadNameException $e) { // handle bad name error here } catch ( supervisor Exception supervisor Exception $e) { // handle any other errors here }">

 /** @var  supervisor  supervisor $ supervisor */

try {
	$ supervisor -> startProcess ( ' process ' , true );
} catch (  supervisor  Exception  Fault  BadNameException $ e ) {
	// handle bad name error here
} catch (  supervisor  Exception  supervisor Exception $ e ) {
	// handle any other errors here
}

Configuración y escucha de eventos

Los componentes de configuración y eventos se han movido a su propio repositorio.

Más información

Puede encontrar la documentación XML-RPC supervisor aquí: http://supervisord.org/api.html

Aviso

Si utiliza la extensión PHP XML-RPC para analizar respuestas (que está marcada como EXPERIMENTAL ). Esto puede causar problemas al intentar leer o finalizar el registro de un PROCESO. Asegúrese de limpiar sus mensajes de registro. La única información que encontré sobre esto es un comentario.

Contribuyendo

Consulte CONTRIBUCIÓN para obtener más detalles.

Pruebas

$ composer test

Pruebas funcionales (behat):

$ behat

Imagen acoplable

Este repositorio se envía con una configuración de Docker Compose y un Dockerfile para facilitar las pruebas. Las pruebas se pueden ejecutar a través de:

docker-compose run --rm ci

Bibliotecas obsoletas

Si bien este intenta ser un cliente supervisor completo, este no es el primero. Sin embargo, algunos autores decidieron desaprobar sus paquetes a favor de esto:

• supervisor d Cliente PHP
• supervisor índigo

Créditos

• László Monda (autor del supervisor d Cliente PHP)
• Márk Sági-Kazár
• Todos los contribuyentes

Licencia

La Licencia MIT (MIT). Consulte el archivo de licencia para obtener más información.