phpfpm

README

PHP-FPM collector

Overview

PHP-FPM is an alternative PHP FastCGI implementation with some additional features useful for sites of any size, especially busier sites.

This collector monitors one or more PHP-FPM instances, depending on your configuration..

Collected 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.

global

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

Setup

Prerequisites

Enable status page

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

Configuration

File

The configuration file name is go.d/phpfpm.conf.

The file format is YAML. Generally, the format is:

update_every: 1
autodetection_retry: 0
jobs:
  - name: some_name1
  - name: some_name1

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

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

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
  

Documentation

Index

• type Charts
• type Config
• type Dims
• type Phpfpm
  • func New() *Phpfpm
  • func (Phpfpm) Charts() *Charts
  • func (p *Phpfpm) Check() bool
  • func (Phpfpm) Cleanup()
  • func (p *Phpfpm) Collect() map[string]int64
  • func (p *Phpfpm) Init() bool

Types

type Charts

type Charts = module.Charts

Charts is an alias for module.Charts

type Config

type Config struct {
	web.HTTP `yaml:",inline"`
	Socket   string `yaml:"socket"`
	Address  string `yaml:"address"`
	FcgiPath string `yaml:"fcgi_path"`
}

type Dims

type Dims = module.Dims

Dims is an alias for module.Dims

type Phpfpm

type Phpfpm struct {
	module.Base
	Config `yaml:",inline"`
	// contains filtered or unexported fields
}

func New

func New() *Phpfpm

func (Phpfpm) Charts

func (Phpfpm) Charts() *Charts

func (*Phpfpm) Check

func (p *Phpfpm) Check() bool

func (Phpfpm) Cleanup

func (Phpfpm) Cleanup()

func (*Phpfpm) Collect

func (p *Phpfpm) Collect() map[string]int64

func (*Phpfpm) Init

func (p *Phpfpm) Init() bool