Skip to main content

PHP-FPM

Plugin: go.d.plugin Module: phpfpm

Overview

This collector monitors PHP-FPM instances.

This collector is supported on all platforms.

This collector supports collecting metrics from multiple instances of this integration, including remote instances.

Default Behavior

Auto-Detection

This integration doesn't support auto-detection.

Limits

The default configuration for this integration does not impose any limits on data collection.

Performance Impact

The default configuration for this integration is not expected to impose a significant performance impact on the system.

Metrics

Metrics grouped by scope.

The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.

Per PHP-FPM instance

These metrics refer to the entire monitored application.

This scope has no labels.

Metrics:

MetricDimensionsUnit
phpfpm.connectionsactive, max_active, idleconnections
phpfpm.requestsrequestsrequests/s
phpfpm.performancemax_children_reached, slow_requestsstatus
phpfpm.request_durationmin, max, avgmilliseconds
phpfpm.request_cpumin, max, avgpercentage
phpfpm.request_memmin, max, avgKB

Alerts

There are no alerts configured by default for this integration.

Setup

Prerequisites

Enable status page

Uncomment the pm.status_path = /status variable in the php-fpm config file.

Configuration

File

The configuration file name for this integration is go.d/phpfpm.conf.

You can edit the configuration file using the edit-config script from the Netdata config directory.

cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config go.d/phpfpm.conf

Options

The following options can be defined globally: update_every, autodetection_retry.

Config options
NameDescriptionDefaultRequired
update_everyData collection frequency.False
autodetection_retryRecheck interval in seconds. Zero means no recheck will be scheduled.False
urlServer URL.True
socketServer Unix socket.False
addressServer address in IP:PORT format.False
fcgi_pathStatus path.False
timeoutHTTP request timeout.False
usernameUsername for basic HTTP authentication.False
passwordPassword for basic HTTP authentication.False
proxy_urlProxy URL.False
proxy_usernameUsername for proxy basic HTTP authentication.False
proxy_passwordPassword for proxy basic HTTP authentication.False
methodHTTP request method.False
bodyHTTP request body.False
headersHTTP request headers.False
not_follow_redirectsRedirect handling policy. Controls whether the client follows redirects.False
tls_skip_verifyServer certificate chain and hostname validation policy. Controls whether the client performs this check.False
tls_caCertification authority that the client uses when verifying the server's certificates.False
tls_certClient TLS certificate.False
tls_keyClient TLS key.False

Examples

HTTP

Collecting data from a local instance over HTTP.

Config
jobs:
- name: local
url: http://localhost/status?full&json

Unix socket

Collecting data from a local instance over Unix socket.

Config
jobs:
- name: local
socket: '/tmp/php-fpm.sock'

TCP socket

Collecting data from a local instance over TCP socket.

Config
jobs:
- name: local
address: 127.0.0.1:9000

Multi-instance

Note: When you define multiple jobs, their names must be unique.

Collecting metrics from local and remote instances.

Config
jobs:
- name: local
url: http://localhost/status?full&json

- name: remote
url: http://203.0.113.10/status?full&json

Troubleshooting

Debug Mode

To troubleshoot issues with the phpfpm collector, run the go.d.plugin with the debug option enabled. The output should give you clues as to why the collector isn't working.

  • Navigate to the plugins.d directory, usually at /usr/libexec/netdata/plugins.d/. If that's not the case on your system, open netdata.conf and look for the plugins setting under [directories].

    cd /usr/libexec/netdata/plugins.d/
  • Switch to the netdata user.

    sudo -u netdata -s
  • Run the go.d.plugin to debug the collector:

    ./go.d.plugin -d -m phpfpm

Do you have any feedback for this page? If so, you can open a new issue on our netdata/learn repository.