Source: https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/php-fpm_http?at=release/7.0
PHP-FPM by HTTP
Overview
This template is developed to monitor the FastCGI Process Manager (PHP-FPM) by Zabbix that work without any external scripts. Most of the metrics are collected in one go, thanks to Zabbix bulk data collection.
The template PHP-FPM by Zabbix agent
- collects metrics by polling PHP-FPM status-page with HTTP agent remotely.
Note that this solution supports HTTPS and redirects.
Requirements
Zabbix version: 7.0 and higher.
Tested versions
This template has been tested on:
- PHP 7
- PHP 8
Configuration
Zabbix should be configured according to the instructions in the Templates out of the box section.
Setup
Note that depending on your OS distribution, the PHP-FPM executable/service name can vary. RHEL-like distributions usually name both process and service as php-fpm
, while for Debian/Ubuntu based distributions it may include the version, for example: executable name - php-fpm8.2
, systemd service name - php8.2-fpm
. Adjust the following instructions accordingly if needed.
- Open the PHP-FPM configuration file and enable the status page as shown.
pm.status_path = /status
ping.path = /ping
- Validate the syntax to ensure it is correct before you reload the service. Replace the
<version>
in the command if needed.
$ php-fpm -t
or
$ php-fpm<version> -t
- Reload the
php-fpm
service to make the change active. Replace the<version>
in the command if needed.
$ systemctl reload php-fpm
or
$ systemctl reload php<version>-fpm
- Next, edit the configuration of your web server.
If you use Nginx, edit the configuration file of your Nginx server block (virtual host) and add the location block below it.
# Enable php-fpm status page
location ~ ^/(status|ping)$ {
## disable access logging for request if you prefer
access_log off;
## Only allow trusted IPs for security, deny everyone else
# allow 127.0.0.1;
# allow 1.2.3.4; # your IP here
# deny all;
fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
fastcgi_index index.php;
include fastcgi_params;
## Now the port or socket of the php-fpm pool we want the status of
fastcgi_pass 127.0.0.1:9000;
# fastcgi_pass unix:/run/php-fpm/your_socket.sock;
}
If you use Apache, edit the configuration file of the virtual host and add the following location blocks.
<LocationMatch "/status">
Require ip 127.0.0.1
# Require ip 1.2.3.4 # Your IP here
# Adjust the path to the socket if needed
ProxyPass "unix:/run/php-fpm/www.sock|fcgi://localhost/status"
</LocationMatch>
<LocationMatch "/ping">
Require ip 127.0.0.1
# Require ip 1.2.3.4 # Your IP here
# Adjust the path to the socket if needed
ProxyPass "unix:/run/php-fpm/www.sock|fcgi://localhost/ping"
</LocationMatch>
- Check the web server configuration syntax. The command may vary depending on the OS distribution and web server.
$ nginx -t
or
$ httpd -t
or
$ apachectl configtest
- Reload the web server configuration. The command may vary depending on the OS distribution and web server.
$ systemctl reload nginx
or
$ systemctl reload httpd
or
$ systemctl reload apache2
- Verify that the pages are available with these commands.
curl -L 127.0.0.1/status
curl -L 127.0.0.1/ping
If you use another location of the status/ping pages, don't forget to change the {$PHP_FPM.STATUS.PAGE}/{$PHP_FPM.PING.PAGE}
macro.
If you use another web server port or scheme for the location of the PHP-FPM status/ping pages, don't forget to change the macros {$PHP_FPM.SCHEME}
and {$PHP_FPM.PORT}
.
Macros used
Name | Description | Default |
---|---|---|
{$PHP_FPM.PORT} | The port of the PHP-FPM status host or container. |
80 |
{$PHP_FPM.SCHEME} | Request scheme which may be http or https |
http |
{$PHP_FPM.HOST} | The hostname or IP address of the PHP-FPM status for a host or container. |
localhost |
{$PHP_FPM.STATUS.PAGE} | The path of the PHP-FPM status page. |
status |
{$PHP_FPM.PING.PAGE} | The path of the PHP-FPM ping page. |
ping |
{$PHP_FPM.PING.REPLY} | The expected reply to the ping. |
pong |
{$PHP_FPM.QUEUE.WARN.MAX} | The maximum percent of the PHP-FPM queue usage for a trigger expression. |
80 |
Items
Name | Description | Type | Key and additional info |
---|---|---|---|
Get ping page | HTTP agent | php-fpm.get_ping | |
Get status page | HTTP agent | php-fpm.get_status | |
Ping | Dependent item | php-fpm.ping Preprocessing
|
|
Processes, active | The total number of active processes. |
Dependent item | php-fpm.processes_active Preprocessing
|
Version | The current version of the PHP. You can get it from the HTTP-Header "X-Powered-By"; it may not work if you have changed the default HTTP-headers. |
Dependent item | php-fpm.version Preprocessing
|
Pool name | The name of the current pool. |
Dependent item | php-fpm.name Preprocessing
|
Uptime | It indicates how long has this pool been running. |
Dependent item | php-fpm.uptime Preprocessing
|
Start time | The time when this pool was started. |
Dependent item | php-fpm.start_time Preprocessing
|
Processes, total | The total number of server processes currently running. |
Dependent item | php-fpm.processes_total Preprocessing
|
Processes, idle | The total number of idle processes. |
Dependent item | php-fpm.processes_idle Preprocessing
|
Process manager | The method used by the process manager to control the number of child processes for this pool. |
Dependent item | php-fpm.process_manager Preprocessing
|
Processes, max active | The highest value of "active processes" since the PHP-FPM server was started. |
Dependent item | php-fpm.processes_max_active Preprocessing
|
Accepted connections per second | The number of accepted requests per second. |
Dependent item | php-fpm.conn_accepted.rate Preprocessing
|
Slow requests | The number of requests that has exceeded your |
Dependent item | php-fpm.slow_requests Preprocessing
|
Listen queue | The current number of connections that have been initiated but not yet accepted. |
Dependent item | php-fpm.listen_queue Preprocessing
|
Listen queue, max | The maximum number of requests in the queue of pending connections since this FPM pool was started. |
Dependent item | php-fpm.listen_queue_max Preprocessing
|
Listen queue, len | The size of the socket queue of pending connections. |
Dependent item | php-fpm.listen_queue_len Preprocessing
|
Queue usage | The utilization of the queue. |
Calculated | php-fpm.listen_queue_usage |
Max children reached | The number of times that |
Dependent item | php-fpm.max_children Preprocessing
|
Triggers
Name | Description | Expression | Severity | Dependencies and additional info |
---|---|---|---|---|
Service is down | last(/PHP-FPM by HTTP/php-fpm.ping)=0 or nodata(/PHP-FPM by HTTP/php-fpm.ping,3m)=1 |
High | Manual close: Yes | |
Version has changed | The PHP-FPM version has changed. Acknowledge to close the problem manually. |
last(/PHP-FPM by HTTP/php-fpm.version,#1)<>last(/PHP-FPM by HTTP/php-fpm.version,#2) and length(last(/PHP-FPM by HTTP/php-fpm.version))>0 |
Info | Manual close: Yes |
Failed to fetch info data | Zabbix has not received any data for items for the last 30 minutes. |
nodata(/PHP-FPM by HTTP/php-fpm.uptime,30m)=1 |
Info | Manual close: Yes Depends on:
|
Pool has been restarted | Uptime is less than 10 minutes. |
last(/PHP-FPM by HTTP/php-fpm.uptime)<10m |
Info | Manual close: Yes |
Manager changed | The PHP-FPM manager has changed. Acknowledge to close the problem manually. |
last(/PHP-FPM by HTTP/php-fpm.process_manager,#1)<>last(/PHP-FPM by HTTP/php-fpm.process_manager,#2) |
Info | Manual close: Yes |
Detected slow requests | The PHP-FPM has detected a slow request. |
min(/PHP-FPM by HTTP/php-fpm.slow_requests,#3)>0 |
Warning | |
Queue utilization is high | The queue for this pool has reached |
min(/PHP-FPM by HTTP/php-fpm.listen_queue_usage,15m) > {$PHP_FPM.QUEUE.WARN.MAX} |
Warning |
Feedback
Please report any issues with the template at https://support.zabbix.com
You can also provide feedback, discuss the template, or ask for help at ZABBIX forums