PHP-FPM icon

PHP-FPM

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.

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.

Name Description Default Required
update_every Data collection frequency. 1 False
autodetection_retry Recheck interval in seconds. Zero means no recheck will be scheduled. 0 False
url Server URL. http://127.0.0.1/status?full&json True
socket Server Unix socket. False
address Server address in IP:PORT format. False
fcgi_path Status path. /status False
timeout HTTP request timeout. 1 False
username Username for basic HTTP authentication. False
password Password for basic HTTP authentication. False
proxy_url Proxy URL. False
proxy_username Username for proxy basic HTTP authentication. False
proxy_password Password for proxy basic HTTP authentication. False
method HTTP request method. GET False
body HTTP request body. False
headers HTTP request headers. False
not_follow_redirects Redirect handling policy. Controls whether the client follows redirects. False False
tls_skip_verify Server certificate chain and hostname validation policy. Controls whether the client performs this check. False False
tls_ca Certification authority that the client uses when verifying the server’s certificates. False
tls_cert Client TLS certificate. False
tls_key Client TLS key. False

Examples

HTTP

Collecting data from a local instance over HTTP.

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

Collecting data from a local instance over Unix socket.

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

Collecting data from a local instance over TCP socket.

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.

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

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

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:

Metric Dimensions Unit
phpfpm.connections active, max_active, idle connections
phpfpm.requests requests requests/s
phpfpm.performance max_children_reached, slow_requests status
phpfpm.request_duration min, max, avg milliseconds
phpfpm.request_cpu min, max, avg percentage
phpfpm.request_mem min, max, avg KB

Alerts

There are no alerts configured by default for this integration.

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

Get Netdata

Sign up for free

Want to see a demonstration of Netdata for multiple use cases?

Go to Live Demo