All about FPM pools

A PHP-FPM pool is the process pool that serves PHP requests for a virtual host.

A project on a PHP template already has one per environment. This article is what you need when you want to resize it, restart it, or create a pool outside a project. It describes how to create one, the sizing fields, and the namespacing toggle.

For changing PHP runtime settings such as max_execution_time on an existing pool, see Change PHP settings.

Where to find FPM pools

In Core, the top-level 'FPM Pools' page lists every pool. Click 'Create' to add one.

Creating an FPM pool

Required fields

• 'Name': lowercase, digits, dash, underscore.
• 'UNIX User': the UNIX user the pool runs as. The PHP version dropdown is filtered to the versions installed on that user's cluster.
• 'PHP Version': the version of PHP this pool runs. This can't be changed after creation.

PHP Settings

Below the core fields, the form has a 'PHP Settings' section for runtime settings like max_execution_time and memory_limit. See Change PHP settings for the full set.

Sizing fields

These control how many PHP-FPM processes (workers) run, when they restart, and when they idle out.

Max Children: concurrent workers

The maximum number of concurrent PHP-FPM workers. Each worker handles one request at a time, so this is also the maximum number of concurrent PHP requests this pool can serve.

If you don't know what to set, use 5.

Max Requests: restart after N

Each worker restarts after handling this many requests. The restart releases any memory the worker leaked.

If you don't know what to set, use 20.

Process Idle Timeout: stop idle workers

If a worker hasn't received a request in this many seconds, it's stopped. This frees memory after a traffic burst.

There's a trade-off. If all workers are stopped, the next incoming request waits while one starts up, so that first request is slightly slower.

If you don't know what to set, use 10.

CPU and memory limits

Both optional:

• 'CPU Limit (cores)': limits the pool to that many CPU cores total.
• 'Memory Limit (MB)': caps total memory across all workers. Minimum 256.

Slow request logging

Set 'Log Slow Requests Threshold' (in seconds) to log any PHP request taking longer than that to the PHP-FPM slow log. Useful for hunting performance issues.

Contact Cyberfusion to retrieve the slow-log results.

Restart and reload

Both live under 'Manage' on the FPM pool page.

• 'Reload' is graceful. Each worker finishes its current request, then restarts. This picks up PHP setting changes without dropping traffic.
• 'Restart' is hard. All workers are killed immediately and replaced with fresh ones. Use this when a worker is stuck, or after cleaning up a hacked site, to make sure no malicious PHP process is still running in memory.

There are two ways to navigate to an FPM pool's 'Manage' section:

Directly

1. Navigate to 'Advanced' > 'FPM Pools'.
2. Select the FPM pool.

Via the project

1. Navigate to 'Projects'.
2. Select the project.
3. Navigate to 'Advanced'.
4. Under the 'FPM Pool' tile, click 'Manage'.

Namespacing

'Is Namespaced' applies several security measures to the FPM pool's processes. Most notably:

• A dedicated /dev/ for the pool.
• When the cluster's UNIX users home directory is /home, the home directories of other UNIX users are hidden, so the FPM pool can't enumerate other users' usernames.

Recommended for shared environments where users aren't fully trusted. See also UNIX user namespacing for the related concept on UNIX users themselves.

Use cases by target group