phpfpm

README

PHP-FPM monitoring with Netdata

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

This module will monitor one or more php-fpm instances, depending on your configuration.

Requirements

• php-fpm with enabled status page:
  • open the php-fpm configuration file.
  • inside this file, find and uncomment the variable pm.status_path = /status.

Metrics

All metrics have "phpfpm." prefix.

Metric	Scope	Dimensions	Units
connections	global	active, max_active, idle	connections
requests	global	requests	requests/s
performance	global	max_children_reached, slow_requests	status
request_duration	global	min, max, avg	milliseconds
request_cpu	global	min, max, avg	percentage
request_mem	global	min, max, avg	KB

Configuration

Edit the go.d/phpfpm.conf configuration file using edit-config from the Netdata config directory, which is typically at /etc/netdata.

cd /etc/netdata # Replace this path with your Netdata config directory
sudo ./edit-config go.d/phpfpm.conf

Needs only url, socket or address. Here is an example for local and remote servers:

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

  - name: local
    url: http://[::1]/status?full&json

  - name: local_socket
    socket: '/tmp/php-fpm.sock'

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

  - name: remote
    address: 203.0.113.10:9000

For all available options please see module configuration file.

Troubleshooting

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.

First, navigate to your plugins' directory, usually at /usr/libexec/netdata/plugins.d/. If that's not the case on your system, open netdata.conf and look for the setting plugins directory. Once you're in the plugin's directory, switch to the netdata user.

cd /usr/libexec/netdata/plugins.d/
sudo -u netdata -s

You can now 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