From 5079be73d2a568db3fe10a588b025c147a7aff0e Mon Sep 17 00:00:00 2001 From: Enrico Stahn Date: Sun, 18 Feb 2018 22:07:17 +1100 Subject: [PATCH] Add initial README.md --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..ac3c388 --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# php-fpm_exporter + +A prometheus exporter for PHP-FPM. +The exporter connects directly to PHP-FPM and exports the metrics via HTTP. + +A webserver such as NGINX or Apache is **NOT** needed! + +## Features + +* Export single or multiple pools +* Export to CLI as text or JSON +* Connects directly to PHP-FPM via TCP or Socket + +## Usage + +* php-fpm_exporter get --phpfpm.scrape-uri 127.0.0.1:9000,127.0.0.1:9001,[...] +* php-fpm_exporter server --phpfpm.scrape-uri 127.0.0.1:9000,127.0.0.1:9001,[...] + +## Metrics collected + +| Metric | Type | +|--------|------| + + + +## TODO + +- [ ] Test with unix socket \ No newline at end of file