README

A PHP-FPM metrics collector for Prometheus Exporter in Laravel applications. This package collects PHP-FPM pool status and process-level metrics and exposes them in Prometheus format.

Requirements

Installation

Install via Composer:

composer require vntrungld/prometheus-exporter-php-fpm-collector

The package uses Laravel's auto-discovery, so the service provider will be automatically registered.

Configuration

Add the collector set to your prometheus-exporter configuration file (config/prometheus-exporter.php):

return [
    // ... other config options

    'collector_sets' => [
        \Vntrungld\PrometheusExporterPhpFpmCollector\PhpFpmCollectorSet::class,
        // ... other collector sets
    ],
];

Available Metrics

Pool-Level Metrics

Process-Level Metrics

Process States

The fpm_process_state metric uses the following state labels:

• Idle - Process is idle
• Getting request informations - Process is getting request info
• Reading headers - Process is reading request headers
• Running - Process is executing
• Ending - Process is ending request
• Finishing - Process is finishing

Example Output

# HELP fpm_up PHP-FPM pool availability
# TYPE fpm_up gauge
fpm_up{pool="www"} 1

# HELP fpm_active_processes The number of active processes
# TYPE fpm_active_processes gauge
fpm_active_processes{pool="www"} 3

# HELP fpm_idle_processes The number of idle processes
# TYPE fpm_idle_processes gauge
fpm_idle_processes{pool="www"} 2

# HELP fpm_process_state Process state indicator
# TYPE fpm_process_state gauge
fpm_process_state{pool="www",child="0",state="Idle"} 1
fpm_process_state{pool="www",child="0",state="Running"} 0
fpm_process_state{pool="www",child="1",state="Idle"} 0
fpm_process_state{pool="www",child="1",state="Running"} 1

PHP-FPM Configuration

For this collector to work, PHP-FPM must be configured to expose status. Ensure your PHP-FPM pool configuration has:

pm.status_path = /status

The collector uses PHP's built-in fpm_get_status() function which is available when running under PHP-FPM.

Testing

Run the test suite:

composer test

Or with PHPUnit directly:

vendor/bin/phpunit

Changelog

Please see the changelog for more information on what has changed recently.

Contributing

Please see contributing.md for details and a todolist.

Security

If you discover any security related issues, please email vn.trungld@gmail.com instead of using the issue tracker.

Credits

• vntrungld
• All Contributors

License

MIT. Please see the license file for more information.