phpstreamserver/metrics

Metrics plugin for PHPStreamServer

v0.3.0 2024-12-06 17:26 UTC

Requires

• php: >=8.2
• ext-pcntl: *
• ext-posix: *
• amphp/amp: ^3.0.2
• amphp/http-server: ^3.3.1
• phpstreamserver/core: ^0.3
• phpstreamserver/http-server: ^0.3
• promphp/prometheus_client_php: ^2.12
• revolt/event-loop: ^1.0.6

MIT

• Anton Zenkov

• Metrics
• phpstreamserver

README

Metrics Plugin for PHPStreamServer

The Metrics Plugin for PHPStreamServer extends the core functionality by providing integration with Prometheus, providing an endpoint for exposing application metrics. It provides default metrics to monitor and allows users to define custom metrics as needed.

Features:

• Provides counter, gauge, histogram and summary metrics.
• User defined metrics.

Install

$ composer require phpstreamserver/core phpstreamserver/metrics

Configure

Here is an example of a simple server configuration with metrics.
After startup, metrics are available at http://127.0.0.1:8081/metrics

// server.php

use PHPStreamServer\Core\Plugin\Supervisor\WorkerProcess;
use PHPStreamServer\Core\Server;
use PHPStreamServer\Plugin\Metrics\MetricsPlugin;
use PHPStreamServer\Plugin\Metrics\RegistryInterface;
use Revolt\EventLoop;

$server = new Server();

$server->addPlugin(
    new MetricsPlugin(listen: '0.0.0.0:8081'),
);

$server->addWorker(
    new WorkerProcess(
        name: 'Metrics test',
        count: 2,
        onStart: function (WorkerProcess $worker): void {
            $registry = $worker->container->getService(RegistryInterface::class);
            $counter = $registry->registerCounter(namespace: 'test', name: 'ticks', help: 'Demonsration');

            EventLoop::repeat(1, function () use ($counter) {
                $counter->inc();
            });
        },
    ),
);

exit($server->run());

Run

$ php server.php start