2018-02-18 11:07:17 +00:00
# php-fpm_exporter
2020-03-11 23:48:34 +00:00
2018-02-18 23:18:49 +00:00
[](https://goreportcard.com/report/github.com/hipages/php-fpm_exporter)
[](https://godoc.org/github.com/hipages/php-fpm_exporter)
2020-03-11 23:48:34 +00:00
[](https://sonarcloud.io/dashboard?id=hipages_php-fpm_exporter)
2018-02-28 01:13:10 +00:00
[](https://hub.docker.com/r/hipages/php-fpm_exporter/)
2018-05-24 09:44:23 +00:00
[](http://isitmaintained.com/project/hipages/php-fpm_exporter "Average time to resolve an issue")
[](http://isitmaintained.com/project/hipages/php-fpm_exporter "Percentage of issues still open")
2018-12-04 21:37:36 +00:00
[](https://www.codetriage.com/hipages/php-fpm_exporter)
2019-01-25 11:36:57 +00:00
[](#contributors)
2018-02-18 23:18:49 +00:00
2018-02-20 01:34:04 +00:00
A [prometheus ](https://prometheus.io/ ) exporter for PHP-FPM.
2018-02-18 11:07:17 +00:00
The exporter connects directly to PHP-FPM and exports the metrics via HTTP.
A webserver such as NGINX or Apache is **NOT** needed!
2020-03-11 23:48:34 +00:00
## Table of Contents
<!-- toc -->
- [Features ](#features )
- [Usage ](#usage )
* [Options and defaults ](#options-and-defaults )
* [Why `--phpfpm.fix-process-count`? ](#why---phpfpmfix-process-count )
* [CLI Examples ](#cli-examples )
* [Docker Examples ](#docker-examples )
* [Kubernetes Example ](#kubernetes-example )
- [Metrics collected ](#metrics-collected )
- [Grafana Dasbhoard for Kubernetes ](#grafana-dasbhoard-for-kubernetes )
- [FAQ ](#faq )
- [Development ](#development )
* [E2E Tests ](#e2e-tests )
- [Contributing ](#contributing )
- [Contributors ](#contributors )
- [Alternatives ](#alternatives )
<!-- tocstop -->
2018-02-18 11:07:17 +00:00
## Features
* Export single or multiple pools
* Export to CLI as text or JSON
* Connects directly to PHP-FPM via TCP or Socket
2018-02-20 01:34:04 +00:00
* Maps environment variables to CLI options
2018-03-01 06:09:33 +00:00
* Fix for PHP-FPM metrics oddities
* [Grafana Dashboard ](https://grafana.com/dashboards/4912 ) for Kubernetes
2018-02-18 11:07:17 +00:00
## Usage
2018-02-20 01:34:04 +00:00
`php-fpm_exporter` is released as [binary ](https://github.com/hipages/php-fpm_exporter/releases ) and [docker ](https://hub.docker.com/r/hipages/php-fpm_exporter/ ) image.
It uses sensible defaults which usually avoids the need to use command parameters or environment variables.
2018-02-18 11:07:17 +00:00
2018-02-20 01:34:04 +00:00
`php-fpm_exporter` supports 2 commands, `get` and `server` .
The `get` command allows to retrieve information from PHP-FPM without running as a server and exposing an endpoint.
The `server` command runs the server required for prometheus to retrieve the statistics.
### Options and defaults
| Option | Description | Environment variable | Default value |
|------------------------|-------------------------------------------------------|------------------------------|-----------------|
| `--web.listen-address` | Address on which to expose metrics and web interface. | `PHP_FPM_WEB_LISTEN_ADDRESS` | [`:9253` ](https://github.com/prometheus/prometheus/wiki/Default-port-allocations ) |
| `--web.telemetry-path` | Path under which to expose metrics. | `PHP_FPM_WEB_TELEMETRY_PATH` | `/metrics` |
| `--phpfpm.scrape-uri` | FastCGI address, e.g. unix:///tmp/php.sock;/status or tcp://127.0.0.1:9000/status | `PHP_FPM_SCRAPE_URI` | `tcp://127.0.0.1:9000/status` |
2018-02-25 11:06:23 +00:00
| `--phpfpm.fix-process-count` | Enable to calculate process numbers via php-fpm_exporter since PHP-FPM sporadically reports wrong active/idle/total process numbers. | `PHP_FPM_FIX_PROCESS_COUNT` | `false` |
| `--log.level` | Only log messages with the given severity or above. Valid levels: [debug, info, warn, error, fatal] (default "error") | `PHP_FPM_LOG_LEVEL` | info |
2018-02-20 01:34:04 +00:00
2018-02-27 08:29:50 +00:00
### Why `--phpfpm.fix-process-count`?
`php-fpm_exporter` implements an option to "fix" the reported metrics based on the provided processes list by PHP-FPM.
We have seen PHP-FPM provide metrics (e.g. active processes) which don't match reality.
Specially `active processes` being larger than `max_children` and the actual number of running processes on the host.
Looking briefly at the source code of PHP-FPM it appears a scoreboard is being kept and the values are increased/decreased once an action is executed.
The metric `active processes` is also an accumulation of multiple states (e.g. Reading headers, Getting request information, Running).
Which shouldn't matter and `active processes` should still be equal or lower to `max_children` .
`--phpfpm.fix-process-count` will emulate PHP-FPMs implementation including the accumulation of multiple states.
If you like to have a more granular reporting please use `phpfpm_process_state` .
* https://bugs.php.net/bug.php?id=76003
* https://stackoverflow.com/questions/48961556/can-active-processes-be-larger-than-max-children-for-php-fpm
2018-02-20 01:34:04 +00:00
### CLI Examples
* Retrieve information from PHP-FPM running on `127.0.0.1:9000` with status endpoint being `/status`
2018-02-20 02:45:18 +00:00
```
php-fpm_exporter get
```
2018-02-18 11:07:17 +00:00
2018-02-20 01:34:04 +00:00
* Retrieve information from PHP-FPM running on `127.0.0.1:9000` and `127.0.0.1:9001`
2018-02-20 02:45:18 +00:00
```
php-fpm_exporter get --phpfpm.scrape-uri tcp://127.0.0.1:9000/status,tcp://127.0.0.1:9001/status
```
2018-02-18 11:07:17 +00:00
2018-02-20 01:34:04 +00:00
* Run as server with 2 pools:
2018-02-20 02:45:18 +00:00
```
php-fpm_exporter server --phpfpm.scrape-uri tcp://127.0.0.1:9000/status,tcp://127.0.0.1:9001/status
```
2018-02-18 11:07:17 +00:00
2018-02-25 22:36:01 +00:00
* Run as server and enable process count fix via environment variable:
```
PHP_FPM_FIX_PROCESS_COUNT=1 go run main.go server --web.listen-address ":12345" --log.level=debug
```
2018-02-20 01:34:04 +00:00
### Docker Examples
2018-02-20 02:45:18 +00:00
* Run docker manually
```
docker pull hipages/php-fpm_exporter
docker run -it --rm -e PHP_FPM_SCRAPE_URI="tcp://127.0.0.1:9000/status,tcp://127.0.0.1:9001/status" hipages/php-fpm_exporter
```
* Run the docker-compose example
```
git clone git@github.com:hipages/php-fpm_exporter.git
cd php-fpm_exporter/test
docker-compose -p php-fpm_exporter up
```
You can now access the following links:
* Prometheus: http://127.0.0.1:9090/
* php-fpm_exporter metrics: http://127.0.0.1:9253/metrics
2018-02-20 03:54:36 +00:00
[](https://asciinema.org/a/1msR8nqAsFdHzROosUb7PiHvf)
2018-02-20 01:34:04 +00:00
2018-02-25 00:10:08 +00:00
### Kubernetes Example
2020-03-11 23:48:34 +00:00
TBD
2018-02-20 01:34:04 +00:00
## Metrics collected
```
# HELP phpfpm_accepted_connections The number of requests accepted by the pool.
# TYPE phpfpm_accepted_connections counter
# HELP phpfpm_active_processes The number of active processes.
# TYPE phpfpm_active_processes gauge
# HELP phpfpm_idle_processes The number of idle processes.
# TYPE phpfpm_idle_processes gauge
# HELP phpfpm_listen_queue The number of requests in the queue of pending connections.
# TYPE phpfpm_listen_queue gauge
# HELP phpfpm_listen_queue_length The size of the socket queue of pending connections.
# TYPE phpfpm_listen_queue_length gauge
# HELP phpfpm_max_active_processes The maximum number of active processes since FPM has started.
# TYPE phpfpm_max_active_processes counter
# HELP phpfpm_max_children_reached The number of times, the process limit has been reached, when pm tries to start more children (works only for pm 'dynamic' and 'ondemand').
# TYPE phpfpm_max_children_reached counter
# HELP phpfpm_max_listen_queue The maximum number of requests in the queue of pending connections since FPM has started.
# TYPE phpfpm_max_listen_queue counter
2018-02-28 23:54:12 +00:00
# HELP phpfpm_process_last_request_cpu The %cpu the last request consumed.
2018-02-25 22:36:01 +00:00
# TYPE phpfpm_process_last_request_cpu gauge
2018-02-28 23:54:12 +00:00
# HELP phpfpm_process_last_request_memory The max amount of memory the last request consumed.
2018-02-25 22:36:01 +00:00
# TYPE phpfpm_process_last_request_memory gauge
2018-02-28 23:54:12 +00:00
# HELP phpfpm_process_request_duration The duration in microseconds of the requests.
# TYPE phpfpm_process_request_duration gauge
# HELP phpfpm_process_requests The number of requests the process has served.
2018-02-25 22:36:01 +00:00
# TYPE phpfpm_process_requests counter
2018-02-28 23:54:12 +00:00
# HELP phpfpm_process_state The state of the process (Idle, Running, ...).
# TYPE phpfpm_process_state gauge
2018-02-22 05:06:07 +00:00
# HELP phpfpm_scrape_failures The number of failures scraping from PHP-FPM.
# TYPE phpfpm_scrape_failures counter
2018-02-20 01:34:04 +00:00
# HELP phpfpm_slow_requests The number of requests that exceeded your 'request_slowlog_timeout' value.
# TYPE phpfpm_slow_requests counter
# HELP phpfpm_start_since The number of seconds since FPM has started.
# TYPE phpfpm_start_since counter
# HELP phpfpm_total_processes The number of idle + active processes.
# TYPE phpfpm_total_processes gauge
2018-02-22 05:06:07 +00:00
# HELP phpfpm_up Could PHP-FPM be reached?
# TYPE phpfpm_up gauge
2018-02-20 01:34:04 +00:00
```
2018-02-18 23:20:00 +00:00
2018-03-01 06:09:33 +00:00
## Grafana Dasbhoard for Kubernetes
2018-03-01 06:10:29 +00:00
The Grafana dashboard can be found [here ](https://grafana.com/dashboards/4912 ).
2021-05-12 10:04:03 +00:00
There is also a more generic version [here ](./grafana/kubernetes-php-fpm.json ).
2018-03-01 06:09:33 +00:00
< img src = "https://grafana.com/api/dashboards/4912/images/3079/image" width = "600" >
2018-02-22 05:06:07 +00:00
## FAQ
* **How to update "Metrics collected"?**
Copy& paste the output from:
```
curl http://127.0.0.1:12345/metrics | grep phpfpm | grep "#"
```
2020-03-11 23:48:34 +00:00
## Development
2018-02-20 01:34:04 +00:00
2020-03-11 23:48:34 +00:00
### E2E Tests
The E2E tests are based on docker-compose and bats-core. Install the required components, e.g. via brew on MacOS:
```bash
brew tap kaos/shell
brew install docker-compose bats-core kaos/shell/bats-assert kaos/shell/bats-support
```
After the components are installed run the E2E tests:
```bash
2022-02-08 22:45:36 +00:00
make test-e2e
2020-03-11 23:48:34 +00:00
```
## Contributing
Contributions are greatly appreciated.
The maintainers actively manage the issues list, and try to highlight issues suitable for newcomers.
The project follows the typical GitHub pull request model.
See " [How to Contribute to Open Source ](https://opensource.guide/how-to-contribute/ ) " for more details.
Before starting any work, please either comment on an existing issue, or file a new one.
2019-01-25 11:12:03 +00:00
## Contributors
Thanks goes to these wonderful people ([emoji key](https://github.com/all-contributors/all-contributors#emoji-key)):
<!-- ALL - CONTRIBUTORS - LIST:START - Do not remove or modify this section -->
2020-03-11 01:18:44 +00:00
<!-- prettier - ignore - start -->
<!-- markdownlint - disable -->
< table >
< tr >
2021-01-07 22:48:25 +00:00
< td align = "center" > < a href = "http://enricostahn.com" > < img src = "https://avatars3.githubusercontent.com/u/362174?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > Enrico Stahn< / b > < / sub > < / a > < br / > < a href = "#question-estahn" title = "Answering Questions" > 💬< / a > < a href = "https://github.com/hipages/php-fpm_exporter/commits?author=estahn" title = "Code" > 💻< / a > < a href = "https://github.com/hipages/php-fpm_exporter/commits?author=estahn" title = "Documentation" > 📖< / a > < a href = "#maintenance-estahn" title = "Maintenance" > 🚧< / a > < a href = "https://github.com/hipages/php-fpm_exporter/commits?author=estahn" title = "Tests" > ⚠️< / a > < / td >
< td align = "center" > < a href = "https://github.com/XooR" > < img src = "https://avatars2.githubusercontent.com/u/120429?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > Stanislav Antic< / b > < / sub > < / a > < br / > < a href = "https://github.com/hipages/php-fpm_exporter/commits?author=XooR" title = "Code" > 💻< / a > < / td >
< td align = "center" > < a href = "http://herb123456.blogspot.com/" > < img src = "https://avatars1.githubusercontent.com/u/1568165?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > herb< / b > < / sub > < / a > < br / > < a href = "https://github.com/hipages/php-fpm_exporter/commits?author=herb123456" title = "Code" > 💻< / a > < / td >
< td align = "center" > < a href = "https://github.com/Nyoroon" > < img src = "https://avatars1.githubusercontent.com/u/182203?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > Smoked Cheese< / b > < / sub > < / a > < br / > < a href = "https://github.com/hipages/php-fpm_exporter/issues?q=author%3ANyoroon" title = "Bug reports" > 🐛< / a > < a href = "https://github.com/hipages/php-fpm_exporter/commits?author=Nyoroon" title = "Code" > 💻< / a > < / td >
< td align = "center" > < a href = "https://www.old-games.ru" > < img src = "https://avatars3.githubusercontent.com/u/7388179?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > Alexander< / b > < / sub > < / a > < br / > < a href = "https://github.com/hipages/php-fpm_exporter/commits?author=sas1024" title = "Code" > 💻< / a > < / td >
< td align = "center" > < a href = "https://github.com/stanxing" > < img src = "https://avatars2.githubusercontent.com/u/23288646?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > Stan Xing< / b > < / sub > < / a > < br / > < a href = "https://github.com/hipages/php-fpm_exporter/commits?author=stanxing" title = "Code" > 💻< / a > < / td >
< td align = "center" > < a href = "https://github.com/itcsoft54" > < img src = "https://avatars2.githubusercontent.com/u/22459145?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > itcsoft54< / b > < / sub > < / a > < br / > < a href = "https://github.com/hipages/php-fpm_exporter/commits?author=itcsoft54" title = "Code" > 💻< / a > < / td >
< / tr >
< tr >
< td align = "center" > < a href = "http://128.io" > < img src = "https://avatars0.githubusercontent.com/u/44527?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > John S Long< / b > < / sub > < / a > < br / > < a href = "#infra-adduc" title = "Infrastructure (Hosting, Build-Tools, etc)" > 🚇< / a > < / td >
2021-04-21 23:39:15 +00:00
< td align = "center" > < a href = "https://github.com/danielocallaghan" > < img src = "https://avatars.githubusercontent.com/u/62488?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > Daniel O'Callaghan< / b > < / sub > < / a > < br / > < a href = "https://github.com/hipages/php-fpm_exporter/commits?author=danielocallaghan" title = "Code" > 💻< / a > < / td >
2021-05-12 10:14:58 +00:00
< td align = "center" > < a href = "https://github.com/stchr" > < img src = "https://avatars.githubusercontent.com/u/166079?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > Simon Stücher< / b > < / sub > < / a > < br / > < a href = "https://github.com/hipages/php-fpm_exporter/issues?q=author%3Astchr" title = "Bug reports" > 🐛< / a > < / td >
2021-05-12 10:10:20 +00:00
< td align = "center" > < a href = "https://sterba.dev" > < img src = "https://avatars.githubusercontent.com/u/48120735?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > André Sterba< / b > < / sub > < / a > < br / > < a href = "https://github.com/hipages/php-fpm_exporter/commits?author=andresterba" title = "Code" > 💻< / a > < / td >
2020-03-11 01:18:44 +00:00
< / tr >
< / table >
2021-01-07 22:48:25 +00:00
<!-- markdownlint - restore -->
2020-03-11 01:18:44 +00:00
<!-- prettier - ignore - end -->
2021-01-07 22:48:25 +00:00
2019-01-25 11:12:03 +00:00
<!-- ALL - CONTRIBUTORS - LIST:END -->
2019-01-25 11:36:57 +00:00
This project follows the [all-contributors ](https://github.com/all-contributors/all-contributors ) specification. Contributions of any kind welcome!
2020-03-11 23:48:34 +00:00
2020-11-21 11:21:31 +00:00
## Stargazers over time
[](https://starchart.cc/hipages/php-fpm_exporter)
2020-03-11 23:48:34 +00:00
## Alternatives
* [bakins/php-fpm-exporter ](https://github.com/bakins/php-fpm-exporter )
* [peakgames/php-fpm-prometheus ](https://github.com/peakgames/php-fpm-prometheus )
* [craigmj/phpfpm_exporter ](https://github.com/craigmj/phpfpm_exporter )
