RoadRunner v2 bridge to Spiral Framework

Requirements

Make sure that your server is configured with following PHP version and extensions:

PHP 8.1+
Spiral framework 3.0+

Installation

To install the package:

composer require spiral/roadrunner-bridge

After package install you need to add bootloaders from the package in your application on the top of the list.

use Spiral\RoadRunnerBridge\Bootloader as RoadRunnerBridge;

protected const LOAD = [
    RoadRunnerBridge\HttpBootloader::class, // Optional, if it needs to work with http plugin
    RoadRunnerBridge\QueueBootloader::class, // Optional, if it needs to work with jobs plugin
    RoadRunnerBridge\CacheBootloader::class, // Optional, if it needs to work with KV plugin
    RoadRunnerBridge\GRPCBootloader::class, // Optional, if it needs to work with GRPC plugin
    RoadRunnerBridge\BroadcastingBootloader::class, // Optional, if it needs to work with broadcasting plugin
    RoadRunnerBridge\CommandBootloader::class,
    RoadRunnerBridge\TcpBootloader::class, // Optional, if it needs to work with TCP plugin
    RoadRunnerBridge\MetricsBootloader::class, // Optional, if it needs to work with metrics plugin
    RoadRunnerBridge\LoggerBootloader::class, // Optional, if it needs to work with app-logger plugin
    // ...
];

Cache

Configuration

You can create config file app/config/cache.php if you want to configure Cache storages. In this file, you may specify which cache driver you would like to be used by default throughout your application.

<?php

declare(strict_types=1);

use Spiral\Cache\Storage\ArrayStorage;
use Spiral\Cache\Storage\FileStorage;

return [

    'default' => 'array',
    
    /**
     *  Aliases for storages, if you want to use domain specific storages
     */
    'aliases' => [
        'user-data' => 'localMemory'
    ],

    'storages' => [

        'local' => [
            // Alias for ArrayStorage type
            'type' => 'array',
        ],
        
        'localMemory' => [
            'type' => ArrayStorage::class,
        ],

        'file' => [
            // Alias for FileStorage type
            'type' => 'file',
            'path' => __DIR__.'/../../runtime/cache',
        ],
        
    ],

    /**
     * Aliases for storage types
     */
    'typeAliases' => [
        'array' => ArrayStorage::class,
        'file' => FileStorage::class,
    ],
];

Working with default storage

At first, you need to specify default storage in configuration file, and it will be bound with Psr\SimpleCache\CacheInterface and will be automatically delivered by the container (auto-wiring).

'default' => 'array',

use Psr\SimpleCache\CacheInterface;

class MyService {

    private CacheInterface $cache;
    private PostReposiory $posts;
    
    public function __construct(CacheInterface $cache, PostReposiory $posts) 
    {
        $this->cache = $cache;
        $this->posts = $posts;
    }

    public function handle(): void
    {
        $posts = $this->posts->findAll();
        $this->cache->set('posts', $posts);
        
        // ...
    }
}

Working with storage provider

Storage provider provides convenient access to the underlying implementations of the Psr\SimpleCache\CacheInterface cache contract. Using the Storage provider, you may access various cache stores via the storage method. The key passed to the store method should correspond to one of the storages listed in the storages configuration array in your cache configuration file:

use Spiral\Cache\CacheStorageProviderInterface;

class MyService {

    private CacheStorageProviderInterface $cacheManager;
    private PostReposiory $posts;
    
    public function __construct(CacheStorageProviderInterface $cacheManager, PostReposiory $posts) 
    {
        $this->cacheManager = $cacheManager;
        $this->posts = $posts;
    }

    public function handle(): void
    {
        /** @var \Psr\SimpleCache\CacheInterface $cache */
        $cache = $this->cacheManager->storage('inMemory');
        
        $posts = $this->posts->findAll();
        $this->cache->set('posts', $posts);
        
        // ...
    }
}

Working with domain specific storages

You may even associate a domain specific storage name with one of the configured storage and then request storage by its alias:

'aliases' => [
    'user-data' => 'localMemory'
],
'storages' => [
    'localMemory' => [
        'type' => ArrayStorage::class,
    ],
    // ...
],

use Spiral\Cache\CacheStorageProviderInterface;

class MyService {

    private CacheStorageProviderInterface $cacheManager;
    private PostReposiory $posts;
    
    public function __construct(CacheStorageProviderInterface $cacheManager, UserRepository $posts) 
    {
        $this->cacheManager = $cacheManager;
        $this->posts = $posts;
    }

    public function handle(): void
    {
        /** @var \Psr\SimpleCache\CacheInterface $cache */
        $cache = $this->cacheManager->storage('user-data');
        
        // ...
    }
}

Adding custom cache storages

There are two ways to add cache storages:

Create a new class that implements \Psr\SimpleCache\CacheInterface interface.

final class DatabaseStorage implements \Psr\SimpleCache\CacheInterface
{
    private string $table;
    
    public function __construct(string $table) 
    {
        $this->table = $table;
    }

    // ..
}

And then just use it in your config

'memcached' => [
    'type' => DatabaseStorage::class,
    'table' => 'cache',
],

Cache storage will be automatically resolved by Spiral\Core\FactoryInterface and all the data from its config will be passed in its __constructor. It will look like:

$factory->make(DatabaseStorage::class, [
    'table' => 'cache'
])

Console commands

Command	Description
cache:clear	Clear cache for default cache storage
cache:clear {storage}	Clear cache for specific cache storage

Queue

Roadrunner queues provide a unified queueing API across a variety of different queue backends. Full information about supported pipelines you can read on official site https://roadrunner.dev/docs/beep-beep-jobs.

Configuration

You can create config file app/config/queue.php if you want to configure Queue connections:

<?php

declare(strict_types=1);

use Spiral\RoadRunner\Jobs\Queue\MemoryCreateInfo;
use Spiral\RoadRunner\Jobs\Queue\AMQPCreateInfo;
use Spiral\RoadRunner\Jobs\Queue\BeanstalkCreateInfo;
use Spiral\RoadRunner\Jobs\Queue\SQSCreateInfo;

return [
    /**
     *  Default queue connection name
     */
    'default' => env('QUEUE_CONNECTION', 'sync'),

    /**
     *  Aliases for queue connections, if you want to use domain specific queues
     */
    'aliases' => [
        // 'mail-queue' => 'roadrunner',
        // 'rating-queue' => 'sync',
    ],
    
    /**
     * Queue connections
     * Drivers: "sync", "roadrunner"
     */
    'connections' => [
        'sync' => [
            // Job will be handled immediately without queueing
            'driver' => 'sync',
        ],
        'roadrunner' => [
            'driver' => 'roadrunner',
            'default' => 'local',
            'pipelines' => [
                'local' => [
                    'connector' => new MemoryCreateInfo('local'),
                    // Run consumer for this pipeline on startup (by default)
                    // You can pause consumer for this pipeline via console command
                    // php app.php queue:pause local
                    'consume' => true 
                ],
                // 'amqp' => [
                //     'connector' => new AMQPCreateInfo('bus', ...),
                //     // Don't consume jobs for this pipeline on start
                //     // You can run consumer for this pipeline via console command
                //     // php app.php queue:resume local
                //     'consume' => false 
                // ],
                // 
                // 'beanstalk' => [
                //     'connector' => new BeanstalkCreateInfo('bus', ...),
                // ],
                // 
                // 'sqs' => [
                //     'connector' => new SQSCreateInfo('amazon', ...),
                // ],
            ]
        ],
    ],
    
    'driverAliases' => [
        'sync' => \Spiral\Queue\Driver\SyncDriver::class,
        'roadrunner' => \Spiral\RoadRunnerBridge\Queue\Queue::class,
    ],
    
    'registry' => [
        'handlers' => [],
        'serializers' => [
            \Spiral\Queue\Job\ObjectJob::class => 'json',
            \App\Job\TestJob::class => 'serializer',
            \App\Job\OtherJob::class => CustomSerializer::class,
            \App\Job\FooJob::class => new CustomSerializer(),
            \App\Job\BarJob::class => new \Spiral\Core\Container\Autowire(CustomSerializer::class),
        ]
    ],
];

Connections with roadrunner driver will automatically declare pipelines without configuring on the RoadRunner side. If pipeline will be declared via RoadRunner config, Queue manager will just connect to it (without declaring).

Job handler

To run a job, you must create a proper job handler. The handler must implement Spiral\Queue\HandlerInterface. Handlers are responsible only for job execution. Use Spiral\Queue\JobHandler to simplify your abstraction and perform dependency injection in your handler method invoke:

use Symfony\Contracts\HttpClient\HttpClientInterface;

class PingHandler extends \Spiral\Queue\JobHandler
{
    public function invoke(HttpClientInterface $client, string $url): void
    {
        $status = $client->request('GET', $url)->getStatusCode() === 200;
        echo $status ? 'PONG' : 'ERROR';
    }
}

use Spiral\Queue\QueueInterface;
use Spiral\Queue\QueueConnectionProviderInterface;
use Psr\Container\ContainerInterface;

class MyService {

    private ContainerInterface $container;
    private  QueueInterface $queue;
    
    /**
     * @param QueueInterface $queue - Default queue will be injected
     * @param ContainerInterface $container
     */
    public function __construct(QueueInterface $queue, ContainerInterface $container) 
    {
        $this->container = $container;
        $this->queue = $queue;
    }

    public function handle()
    {
        $queue = $this->queue;
        
        // OR gets queue from manager 

        /** @var QueueManager $queueManager */
        $queueManager = $this->container->get(QueueConnectionProviderInterface::class);
        $queue = $queueManager->getConnection('sync');
        
        $queue->push(PingHandler::class, ['url' => 'https://google.com']);
    }
}

You can bind job names with class handlers:

use Spiral\Queue\QueueRegistry;
/** @var QueueRegistry $registry */
$registry = $queue = $this->container->get(QueueRegistry::class);
$registry->setHandler('ping', PingHandler::class);

/** @var QueueInterface $queue */
$queue = $this->container->get(QueueInterface::class);
$queue->push('ping', ['url' => 'https://google.com']);

Job serializer

You can configure a specific serializer for a particular job. Add a job as a key with the desired serializer as a value in the app/config/queue.php configuration file:

return [
    // ...
    'registry' => [
        'serializers' => [
            \Spiral\Queue\Job\ObjectJob::class => 'json',
            App\Job\TestJob::class => 'serializer',
            App\Job\OtherJob::class => CustomSerializer::class,
            App\Job\FooJob::class => new CustomSerializer(),
            App\Job\BarJob::class => new \Spiral\Core\Container\Autowire(CustomSerializer::class),
        ]
    ],
];

The serializer can be a string key from the Spiral\Serializer\SerializerRegistry. The fully qualified name of the serializer class, serializer instance, Spiral\Core\Container\Autowire instance. The serializer class must implement the Spiral\Serializer\SerializerInterface.

Job DTO's

Job DTO classes are very simple, normally containing only a __invoke or handle method that is invoked when the job is processed by the queue. To get started, let's take a look at an example job class. In this example, we'll pretend we ping a URL:

use Symfony\Contracts\HttpClient\HttpClientInterface;

class Ping
{
    private string $url;
    
    public function __construct(string $url) 
    {
        $this->url = $url;
    }
    
    public function __invoke(HttpClientInterface $client): void
    {
        $status = $client->request('GET', $this->url)->getStatusCode() === 200;
        echo $status ? 'PONG' : 'ERROR';
    }
}

use Spiral\Queue\QueueInterface;

class MyService {

    private QueueInterface $queue;
    
    public function __construct(QueueInterface $queue) 
    {
        $this->queue = $queue;
    }

    public function handle()
    {
        $this->queue->pushObject(new Ping('https://google.com'));
    }
}

Domain specific queues

Domain specific queues are an important part of an application. You can create aliases for exists connections and use them instead of real names. When you decide to switch queue connection for alias, you can do it in one place.

'aliases' => [
    'user-data' => 'sync',
],

use Spiral\Queue\QueueInterface;
use Spiral\Queue\QueueConnectionProviderInterface;
use Psr\Container\ContainerInterface;
use Symfony\Contracts\HttpClient\HttpClientInterface;

class MyService {

    private QueueInterface $queue;
    
    public function __construct(QueueConnectionProviderInterface $manager) 
    {
        $this->queue = $manager->getConnection('user-data');
    }

    public function handle()
    {
        $this->queue->push(...);
    }
}

Push on specific queue

For some queue connections you can specify queue _name where the specific job should be pushed.

use Spiral\Queue\Options;

$this->queue->push('mail.job', [...], Options::onQueue('amqp'));

In case of RoadRunner driver queue are the same as pipelines._

Handle failed jobs

By default, all failed jobs will be sent into spiral log. But you can change default behavior. At first, you need to create your own implementation for Spiral\RoadRunnerBridge\Queue\Failed\FailedJobHandlerInterface

Custom handler example

use Spiral\RoadRunnerBridge\Queue\Failed\FailedJobHandlerInterface;
use Cycle\Database\DatabaseInterface;
use Spiral\Queue\SerializerInterface;

class DatabaseFailedJobsHandler implements FailedJobHandlerInterface
{
    private DatabaseInterface $database;
    private SerializerInterface $serializer;
    
    public function __construct(DatabaseInterface $database, SerializerInterface $serializer)
    {
        $this->database = $database;
        $this->serializer = $serializer;
    }

    public function handle(string $driver, string $queue, string $job, array $payload, \Throwable $e): void
    {
        $this->database
            ->insert('failed_jobs')
            ->values([
                'driver' => $driver,
                'queue' => $queue,
                'job_name' => $job,
                'payload' => $this->serializer->serialize($payload),
                'error' => $e->getMessage(),
            ])
            ->run();
    }
}

Then you need to bind your implementation with Spiral\RoadRunnerBridge\Queue\Failed\FailedJobHandlerInterface interface.

use Spiral\Boot\Bootloader\Bootloader;
use Spiral\RoadRunnerBridge\Queue\Failed\FailedJobHandlerInterface;

final class QueueFailedJobsBootloader extends Bootloader
{
    protected const SINGLETONS = [
        FailedJobHandlerInterface::class => \App\Jobs\DatabaseFailedJobsHandler::class,
    ];
}

And register this bootloader after Spiral\RoadRunnerBridge\Bootloader\QueueBootloader in your application

use Spiral\RoadRunnerBridge\Bootloader as RoadRunnerBridge;
protected const LOAD = [
    RoadRunnerBridge\HttpBootloader::class,
    RoadRunnerBridge\QueueBootloader::class,
    App\Bootloader\QueueFailedJobsBootloader::class,
    RoadRunnerBridge\CommandBootloader::class,
    
    // ...
];

Console commands

Command	Description
roadrunner:list	List available roadrunner pipelines
roadrunner:pause {name}	Pause consuming jobs for pipeline with given name
roadrunner:resume {name}	Resume consuming jobs for pipeline with given name

name - it's a RR jobs pipeline name

Example

'memory' => [
    'driver' => 'roadrunner',
    'connector' => new MemoryCreateInfo('local'),
    'consume' => true // Consume jobs 
],

php app.php queue:pause local

TCP

RoadRunner includes TCP server and can be used to replace classic TCP setup with much greater performance and flexibility.

Bootloader

Add Spiral\RoadRunnerBridge\Bootloader\TcpBootloader to application bootloaders list:

use Spiral\RoadRunnerBridge\Bootloader as RoadRunnerBridge;

protected const LOAD = [
    // ...
    RoadRunnerBridge\TcpBootloader::class, 
    // ...
];

This bootloader adds a dispatcher and necessary services for TCP to work. Also, using the addService and addInterceptors methods can dynamically add services to TCP servers and configure interceptors.

Configuration

Configure tcp section in the RoadRunner .rr.yaml configuration file with needed TCP servers. Example:

tcp:
  servers:
    smtp:
      addr: tcp://127.0.0.1:22
      delimiter: "\r\n" # by default
    monolog:
      addr: tcp://127.0.0.1:9913

  pool:
    num_workers: 2
    max_jobs: 0
    allocate_timeout: 60s
    destroy_timeout: 60s

Create configuration file app/config/tcp.php. In the configuration, it's required to specify the services that will handle requests from a specific TCP server. Optionally, interceptors can be added for each specific server. With the help there, can add some logic before handling the request in service. Configuration example:

<?php

declare(strict_types=1);

return [
    /**
     * Services for each server.
     */
    'services' => [
        'smtp' => SomeService::class,
        'monolog' => OtherService::class
    ],

    /**
     * Interceptors, this section is optional.
     * @see https://spiral.dev/docs/cookbook-domain-core/2.8/en#core-interceptors  
     */
    'interceptors' => [
        // several interceptors
        'smtp' => [
            SomeInterceptor::class, 
            OtherInterceptor::class
        ],
        'monolog' => SomeInterceptor::class // one interceptor 
    ],
    
    'debug' => env('TCP_DEBUG', false)
];

Services

A service must implement the interface Spiral\RoadRunnerBridge\Tcp\Service\ServiceInterface with one required method handle. After processing a request, the handle method must return the Spiral\RoadRunnerBridge\Tcp\Response\ResponseInterface object with result (RespondMessage, CloseConnection, ContinueRead).

Example:

<?php

declare(strict_types=1);

namespace App\Tcp\Service;

use Spiral\RoadRunner\Tcp\Request;
use Spiral\RoadRunnerBridge\Tcp\Response\RespondMessage;
use Spiral\RoadRunnerBridge\Tcp\Response\ResponseInterface;
use Spiral\RoadRunnerBridge\Tcp\Service\ServiceInterface;

class TestService implements ServiceInterface
{
    public function handle(Request $request): ResponseInterface
    {
        // some logic
    
        return new RespondMessage('some message', true);
    }
}

Broadcasting

Configuration

You can create config file app/config/broadcasting.php if you want to configure Broadcasting drivers.

<?php

declare(strict_types=1);

use Psr\Log\LogLevel;
use Spiral\Broadcasting\Driver\LogBroadcast;
use Spiral\Broadcasting\Driver\NullBroadcast;
use Spiral\Core\Container\Autowire;
use Spiral\RoadRunnerBridge\Broadcasting\RoadRunnerBroadcast;
use Spiral\RoadRunnerBridge\Broadcasting\RoadRunnerGuard;

return [
    'default' => env('BROADCAST_CONNECTION', 'null'),

    'authorize' => [
        'path' => env('BROADCAST_AUTHORIZE_PATH'),
        'topics' => [
            // 'topic' => static fn (ServerRequestInterface $request): bool => $request->getHeader('SECRET')[0] == 'secret',
            // 'user.{id}' => static fn ($id, Actor $actor): bool => $actor->getId() === $id
        ],
    ],

    'connections' => [
        'null' => [
            'driver' => 'null',
        ],
        'log' => [
            'driver' => 'log',
            'level' => LogLevel::INFO,
        ],
        'roadrunner' => [
            'driver' => 'roadrunner',
            'guard' => Autowire::wire(RoadRunnerGuard::class),
        ]
    ],
    'driverAliases' => [
        'null' => NullBroadcast::class,
        'log' => LogBroadcast::class,
        'roadrunner' => RoadRunnerBroadcast::class,
    ],
];

Configure broadcasting section in the RoadRunner yaml config:

http:
  address: 0.0.0.0:8000
  middleware: [ "static", "gzip", "websockets", "headers" ]
  static:
    dir: "public"
    forbid: [ ".php" ]
  pool:
    num_workers: 2
  headers:
    cors:
      allowed_origin: "*"
      allowed_headers: "*"
      allowed_methods: "GET,HEAD,POST,PUT,PATCH,DELETE,OPTIONS"

websockets:
  broker: default
  path: "/ws"

broadcast:
  default:
    driver: memory
    config: { }

Working with default driver

use Spiral\Broadcasting\BroadcastInterface;

final class SendVerificationLink 
{
    private BroadcastInterface $broadcast;
    private UserReposiory $users;
    private VerificationLinkGenerator $linkGenerator;
    
    public function __construct(
        BroadcastInterface $broadcast,
        UserReposiory $users,
        VerificationLinkGenerator $linkGenerator
    ) {
        $this->broadcast = $broadcast;
        $this->users = $users;
        $this->linkGenerator = $linkGenerator;
    }

    public function handle(int $userId): void
    {
        $user = $this->users->findByPK($userId);
        
        // ...
        
        $this->broadcast->publish(
            'user.{$user->id}', 
            \sprintf('Your verification link is: %s', $this->linkGenerator->getLink($user))
        );
    }
}

Working with broadcasting manager

use Spiral\Broadcasting\BroadcastManagerInterface;

final class SendVerificationLink 
{
    private BroadcastManagerInterface $broadcastManager;
    private UserReposiory $users;
    private VerificationLinkGenerator $linkGenerator;
    
    public function __construct(
        BroadcastManagerInterface $broadcastManager,
        UserReposiory $users,
        VerificationLinkGenerator $linkGenerator
    ) {
        $this->broadcastManager = $broadcastManager;
        $this->users = $users;
        $this->linkGenerator = $linkGenerator;
    }

    public function handle(int $userId): void
    {
        $broadcast = $this->broadcastManager->connection('log');
        
        // ...
    }
}

GRPC

The GRPC protocol provides an extremely efficient way of cross-service communication for distributed applications. The public toolkit includes instruments to generate client and server code-bases for many languages allowing the developer to use the most optimal language for the task.

Configuration

Install protoc-gen-php-grpc from pre-build binaries.

Create config file app/config/grpc.php if you want to configure generate service classes:

<?php

declare(strict_types=1);

return [
    /**
     * Path to protoc-gen-php-grpc library.
     * Default: null 
     */
    'binaryPath' => null,
    // 'binaryPath' => __DIR__.'/../../protoc-gen-php-grpc',

    'services' => [
        __DIR__.'/../../proto/echo.proto',
    ],
];

Then run console command:

php app.php grpc:generate

Console commands

Command	Description
grpc:services	List available GRPC services
grpc:generate {path=auto} {namespace=auto}	Generate GPRC service code using protobuf specification

Example GRPC service

// app/proto/echo.proto

syntax = "proto3";
package service;

option php_namespace = "App\\GRPC\\EchoService";
option php_metadata_namespace = "App\\GRPC\\EchoService\\GPBMetadata";

service Echo {
    rpc Ping (Message) returns (Message) {
    }
}

message Message {
    string msg = 1;
}

Put proto file into app/config/grpc.php

'services' => [
    __DIR__.'/../../proto/echo.proto',
],

Run console command:

php app.php grpc:generate

Implement EchoInterface interface

// app/src/GRPC/EchoService/EchoService.php

namespace App\GRPC\EchoService;

use Spiral\RoadRunner\GRPC\ContextInterface;

class EchoService implements EchoInterface
{
    public function Ping(ContextInterface $ctx, Message $in): Message
    {
        $out = new Message();

        return $out->setMsg(date('Y-m-d H:i:s').': PONG');
    }
}

Configure grpc section in the RoadRunner yaml config:

grpc:
  listen: "tcp://localhost:9001"
  proto:
    - "proto/echo.proto"

Start server

./rr serve

Full example Echo GRPC service you can find here

Logger

Logger provides a simple way to send log messages to RoadRunner.

Configuration

You can register Spiral\RoadRunnerBridge\Logger\Handler in app/config/monolog.php config:

<?php

declare(strict_types=1);

use Spiral\RoadRunnerBridge\Logger\Handler;

return [
   //...
   
   'handlers' => [
       'roadrunner' => [
           Handler::class,
           // or
           new Autowire(Handler::class, ['formatter' => "%message% foo"]),
       ]
   ]
];

Also you can define a default message format in .env

LOGGER_FORMAT=%message% foo

Handler registration example in a custom bootloader

use Spiral\Boot\Bootloader;
use Spiral\Monolog\Bootloader\MonologBootloader;
use Spiral\RoadRunnerBridge\Logger\Handler;

final class SomeBootloader extends Bootloader
{
    public function init(MonologBootloader $monolog, Handler $handler): void 
    {
        $monolog->addHandler($handler);
    }
}

Usage

<?php

declare(strict_types=1);

use Psr\Log\LoggerInterface;
use Spiral\Router\Annotation\Route;

class HomeController
{
    #[Route(route: '/', name: 'home', methods: ['GET'])]
    public function index(LoggerInterface $logger): string
    {
        $logger->warning('Warning message');
        $logger->error('Error message');
        $logger->debug('Debug message');
        $logger->critical("Critical message");
        $logger->info('Info message');
        $logger->emergency("Emergency message");
    }
}

Meanwhile in RoadRunner...

Roadrunner config example

rpc:
  listen: tcp://127.0.0.1:6001

server:
  command: "php app.php"
  relay: pipes

# serve static files
static:
  dir: "public"

http:
  address: 0.0.0.0:8080
  middleware: [ "gzip", "static" ]
  static:
    dir: "public"
    forbid: [ ".php", ".htaccess" ]
  pool:
    num_workers: 1
    supervisor:
      max_worker_memory: 100

jobs:
  consume: [ ]
  pool:
    num_workers: 2
    supervisor:
      max_worker_memory: 100

kv:
  local:
    driver: memory
    config:
      interval: 60
  redis:
    driver: redis
    config:
      addrs:
        - "localhost:6379"
#grpc:
#  listen: "tcp://localhost:9001"
#  proto:
#    - "first.proto"

Metrics

Metrics service does not require configuration in the application. However, you must activate this service in .rr.yaml:

metrics:
  # prometheus client address (path /metrics added automatically)
  address: localhost:2112

Custom Application metrics

You can also publish application-specific metrics. First, you have to register a metric in your configuration file:

metrics:
  address: localhost:2112
  collect:
    app_metric_counter:
      type: counter
      help: "Application counter."

or declare metrics in PHP code

use Spiral\RoadRunner\Metrics\MetricsInterface;
use Spiral\RoadRunner\Metrics\Collector;

class AppBootloader extends Bootloader
{
//...

    public function boot(MetricsInterface $metrics): void
    {
        $metrics->declare(
            'app_metric_counter',
            Collector::counter()->withHelp('Application counter.')
        );
    }
}

To populate metric from application use Spiral\RoadRunner\Metrics\MetricsInterface:

use Spiral\RoadRunner\Metrics\MetricsInterface; 

// ...

public function index(MetricsInterface $metrics): void
{
    $metrics->add('app_metric_counter', 1);
}

Tagged metrics

You can use tagged (labels) metrics to group values:

metrics:
  address: localhost:2112
  collect:
    app_type_duration:
      type: histogram
      help: "Application counter."
      labels: [ "type" ]

or declare metrics in PHP code:

use Spiral\RoadRunner\Metrics\MetricsInterface;
use Spiral\RoadRunner\Metrics\Collector;

class MetricsBootloader extends Bootloader
{
    //...

    public function boot(MetricsInterface $metrics): void
    {
        $metrics->declare(
            'app_metric_counter',
            Collector::counter()->withHelp('Application counter.')->withLabels('type')
        );
    }
}

You should specify values for your labels while pushing the metric:

use Spiral\RoadRunner\MetricsInterface; 

// ...

public function index(MetricsInterface $metrics): void
{
    $metrics->add('app_type_duration', 0.5, ['some-type']);
}

Note Read more about RoadRunner configuration on official site https://roadrunner.dev.

License:

MIT License (MIT). Please see LICENSE for more information. Maintained by Spiral Scout.

RoadRunner v2 bridge to Spiral Framework

Requirements

Installation

Usage

Cache

Configuration

Working with default storage

Working with storage provider

Working with domain specific storages

Adding custom cache storages

Console commands

Queue

Configuration

Job handler

Job serializer

Job DTO's

Domain specific queues

Push on specific queue

Handle failed jobs

Custom handler example

Console commands

Example

TCP

Bootloader

Configuration

Services

Broadcasting

Configuration

Working with default driver

Working with broadcasting manager

GRPC

Configuration

Console commands

Example GRPC service

Logger

Configuration

Usage

Roadrunner config example

Metrics

Custom Application metrics

Tagged metrics

License:

About

Languages