{ "componentChunkName": "component---src-templates-issues-tsx", "path": "/issues/435", "result": {"data":{"issuesJson":{"id":"a8ee11ad-ea11-5412-bc0a-83e8106a4ee2","title":"hipages/php-fpm_exporter: 用于 PHP-FPM 指标的 Prometheus Exporter","number":435,"bodyHTML":"
\n



\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Reposhipages/php-fpm_exporter
Views\"views\"
Stars\"stars\"
Forks\"forks\"
License\"license\"
UpdatedAt\"last-commit\"
CreatedAt\"create-at\"
\n\n

\"\"

\n\n
\n

php-fpm_exporter

\n

\"Test\"
\n\"Go
\n\"GoDoc\"
\n\"Quality
\n\"Docker
\n\"Average
\n\"Percentage
\n\"Open
\n\"All

\n

A prometheus exporter for PHP-FPM.
\nThe exporter connects directly to PHP-FPM and exports the metrics via HTTP.

\n

A webserver such as NGINX or Apache is NOT needed!

\n

Table of Contents

\n\n\n\n

Features

\n\n

Usage

\n

php-fpm_exporter is released as binary and docker image.
\nIt uses sensible defaults which usually avoids the need to use command parameters or environment variables.

\n

php-fpm_exporter supports 2 commands, get and server.
\nThe get command allows to retrieve information from PHP-FPM without running as a server and exposing an endpoint.
\nThe server command runs the server required for prometheus to retrieve the statistics.

\n

Options and defaults

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
OptionDescriptionEnvironment variableDefault value
--web.listen-addressAddress on which to expose metrics and web interface.PHP_FPM_WEB_LISTEN_ADDRESS:9253
--web.telemetry-pathPath under which to expose metrics.PHP_FPM_WEB_TELEMETRY_PATH/metrics
--phpfpm.scrape-uriFastCGI address, e.g. unix:///tmp/php.sock;/status or tcp://127.0.0.1:9000/statusPHP_FPM_SCRAPE_URItcp://127.0.0.1:9000/status
--phpfpm.fix-process-countEnable to calculate process numbers via php-fpm_exporter since PHP-FPM sporadically reports wrong active/idle/total process numbers.PHP_FPM_FIX_PROCESS_COUNTfalse
--log.levelOnly log messages with the given severity or above. Valid levels: [debug, info, warn, error, fatal] (default \"error\")PHP_FPM_LOG_LEVELinfo
\n

Why --phpfpm.fix-process-count?

\n

php-fpm_exporter implements an option to \"fix\" the reported metrics based on the provided processes list by PHP-FPM.

\n

We have seen PHP-FPM provide metrics (e.g. active processes) which don't match reality.
\nSpecially active processes being larger than max_children and the actual number of running processes on the host.
\nLooking 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.
\nThe metric active processes is also an accumulation of multiple states (e.g. Reading headers, Getting request information, Running).
\nWhich shouldn't matter and active processes should still be equal or lower to max_children.

\n

--phpfpm.fix-process-count will emulate PHP-FPMs implementation including the accumulation of multiple states.

\n

If you like to have a more granular reporting please use phpfpm_process_state.

\n\n

CLI Examples

\n\n

Docker Examples

\n\n

Kubernetes Example

\n

TBD

\n

Metrics collected

\n
# HELP phpfpm_accepted_connections The number of requests accepted by the pool.\n# TYPE phpfpm_accepted_connections counter\n# HELP phpfpm_active_processes The number of active processes.\n# TYPE phpfpm_active_processes gauge\n# HELP phpfpm_idle_processes The number of idle processes.\n# TYPE phpfpm_idle_processes gauge\n# HELP phpfpm_listen_queue The number of requests in the queue of pending connections.\n# TYPE phpfpm_listen_queue gauge\n# HELP phpfpm_listen_queue_length The size of the socket queue of pending connections.\n# TYPE phpfpm_listen_queue_length gauge\n# HELP phpfpm_max_active_processes The maximum number of active processes since FPM has started.\n# TYPE phpfpm_max_active_processes counter\n# 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').\n# TYPE phpfpm_max_children_reached counter\n# HELP phpfpm_max_listen_queue The maximum number of requests in the queue of pending connections since FPM has started.\n# TYPE phpfpm_max_listen_queue counter\n# HELP phpfpm_process_last_request_cpu The %cpu the last request consumed.\n# TYPE phpfpm_process_last_request_cpu gauge\n# HELP phpfpm_process_last_request_memory The max amount of memory the last request consumed.\n# TYPE phpfpm_process_last_request_memory gauge\n# HELP phpfpm_process_request_duration The duration in microseconds of the requests.\n# TYPE phpfpm_process_request_duration gauge\n# HELP phpfpm_process_requests The number of requests the process has served.\n# TYPE phpfpm_process_requests counter\n# HELP phpfpm_process_state The state of the process (Idle, Running, ...).\n# TYPE phpfpm_process_state gauge\n# HELP phpfpm_scrape_failures The number of failures scraping from PHP-FPM.\n# TYPE phpfpm_scrape_failures counter\n# HELP phpfpm_slow_requests The number of requests that exceeded your 'request_slowlog_timeout' value.\n# TYPE phpfpm_slow_requests counter\n# HELP phpfpm_start_since The number of seconds since FPM has started.\n# TYPE phpfpm_start_since counter\n# HELP phpfpm_total_processes The number of idle + active processes.\n# TYPE phpfpm_total_processes gauge\n# HELP phpfpm_up Could PHP-FPM be reached?\n# TYPE phpfpm_up gauge\n
\n

Grafana Dasbhoard for Kubernetes

\n

The Grafana dashboard can be found here.
\nThere is also a more generic version here.

\n

\n

FAQ

\n\n

Development

\n

E2E Tests

\n

The E2E tests are based on docker-compose and bats-core. Install the required components, e.g. via brew on MacOS:

\n
brew tap kaos/shell\nbrew install docker-compose bats-core kaos/shell/bats-assert kaos/shell/bats-support
\n

After the components are installed run the E2E tests:

\n
make test-e2e
\n

Contributing

\n

Contributions are greatly appreciated.
\nThe maintainers actively manage the issues list, and try to highlight issues suitable for newcomers.
\nThe project follows the typical GitHub pull request model.
\nSee \" How to Contribute to Open Source \" for more details.
\nBefore starting any work, please either comment on an existing issue, or file a new one.

\n

Contributors

\n

Thanks goes to these wonderful people (emoji key):

\n\n\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\"\"
Enrico Stahn
💬 💻 📖 🚧 ⚠️		\"\"
Stanislav Antic
💻		\"\"
herb
💻		\"\"
Smoked Cheese
🐛 💻		\"\"
Alexander
💻		\"\"
Stan Xing
💻		\"\"
itcsoft54
💻
\"\"
John S Long
🚇		\"\"
Daniel O'Callaghan
💻		\"\"
Simon Stücher
🐛		\"\"
André Sterba
💻
\n\n\n\n

This project follows the all-contributors specification. Contributions of any kind welcome!

\n

Stargazers over time

\n

\"Stargazers

\n

Alternatives

\n","updatedAt":"2025-05-21T16:15:44Z","upvoteCount":null,"author":{"login":"eryajf","avatarUrl":"https://avatars.githubusercontent.com/u/33259379?u=e4a4090a38ac2473aaed4ef9945233636776c6c3&v=4","url":"https://github.com/eryajf"},"category":null,"labels":{"edges":[{"node":{"name":"更多","color":"25B472"}},{"node":{"name":"Prometheus-Exporter","color":"367acb"}},{"node":{"name":"hipages","color":"6370f4"}}]},"comments":{"edges":[]}}},"pageContext":{"number":435,"previous":{"title":"Code-Hex/pget: Golang 编写的可断点续传的文件下载客户端","number":434},"next":{"title":"mtlynch/picoshare: 可建立文件共享服务，支持多种类型，部署简单，易于使用","number":436}}}, "staticQueryHashes": ["151096407","2861350382"]}