| 1 | plugin_name: go.d.plugin |
| 2 | modules: |
| 3 | - meta: |
| 4 | id: collector-go.d.plugin-phpfpm |
| 5 | plugin_name: go.d.plugin |
| 6 | module_name: phpfpm |
| 7 | monitored_instance: |
| 8 | name: PHP-FPM |
| 9 | link: https://php-fpm.org/ |
| 10 | icon_filename: php.svg |
| 11 | categories: |
| 12 | - data-collection.web-servers-and-proxies |
| 13 | keywords: |
| 14 | - phpfpm |
| 15 | - php |
| 16 | related_resources: |
| 17 | integrations: |
| 18 | list: [] |
| 19 | info_provided_to_referring_integrations: |
| 20 | description: "" |
| 21 | overview: |
| 22 | data_collection: |
| 23 | metrics_description: | |
| 24 | This collector monitors PHP-FPM instances. |
| 25 | method_description: "" |
| 26 | supported_platforms: |
| 27 | include: [] |
| 28 | exclude: [] |
| 29 | multi_instance: true |
| 30 | additional_permissions: |
| 31 | description: "" |
| 32 | default_behavior: |
| 33 | auto_detection: |
| 34 | description: "" |
| 35 | limits: |
| 36 | description: "" |
| 37 | performance_impact: |
| 38 | description: "" |
| 39 | setup: |
| 40 | prerequisites: |
| 41 | list: |
| 42 | - title: Enable status page |
| 43 | description: | |
| 44 | Uncomment the `pm.status_path = /status` variable in the `php-fpm` config file. |
| 45 | configuration: |
| 46 | file: |
| 47 | name: go.d/phpfpm.conf |
| 48 | options: |
| 49 | description: | |
| 50 | The following options can be defined globally: update_every, autodetection_retry. |
| 51 | folding: |
| 52 | title: Config options |
| 53 | enabled: true |
| 54 | list: |
| 55 | - name: update_every |
| 56 | description: Data collection interval (seconds). |
| 57 | default_value: 1 |
| 58 | required: false |
| 59 | group: Collection |
| 60 | - name: autodetection_retry |
| 61 | description: Autodetection retry interval (seconds). Set 0 to disable. |
| 62 | default_value: 0 |
| 63 | required: false |
| 64 | group: Collection |
| 65 | |
| 66 | - name: url |
| 67 | description: PHP-FPM URL. |
| 68 | default_value: http://127.0.0.1/server-status?auto |
| 69 | required: true |
| 70 | group: Target |
| 71 | - name: address |
| 72 | description: PHP-FPM TCP listening address in IP:PORT format. Preferred over `url` if set. |
| 73 | default_value: "" |
| 74 | required: false |
| 75 | group: Target |
| 76 | - name: socket |
| 77 | description: PHP-FPM Unix socket. Preferred over both `url` and `address` if set. |
| 78 | default_value: "" |
| 79 | required: false |
| 80 | group: Target |
| 81 | - name: fcgi_path |
| 82 | description: URI path to the [FPM status page](https://www.php.net/manual/en/fpm.status.php). |
| 83 | default_value: /status |
| 84 | required: false |
| 85 | group: Target |
| 86 | - name: timeout |
| 87 | description: HTTP request timeout (seconds). |
| 88 | default_value: 1 |
| 89 | required: false |
| 90 | group: Target |
| 91 | |
| 92 | - name: username |
| 93 | description: Username for Basic HTTP authentication. |
| 94 | default_value: "" |
| 95 | required: false |
| 96 | group: HTTP Auth |
| 97 | - name: password |
| 98 | description: Password for Basic HTTP authentication. |
| 99 | default_value: "" |
| 100 | required: false |
| 101 | group: HTTP Auth |
| 102 | - name: bearer_token_file |
| 103 | description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)." |
| 104 | default_value: "" |
| 105 | required: false |
| 106 | group: HTTP Auth |
| 107 | |
| 108 | - name: tls_skip_verify |
| 109 | description: Skip TLS certificate and hostname verification (insecure). |
| 110 | default_value: no |
| 111 | required: false |
| 112 | group: TLS |
| 113 | - name: tls_ca |
| 114 | description: Path to CA bundle used to validate the server certificate. |
| 115 | default_value: "" |
| 116 | required: false |
| 117 | group: TLS |
| 118 | - name: tls_cert |
| 119 | description: Path to client TLS certificate (for mTLS). |
| 120 | default_value: "" |
| 121 | required: false |
| 122 | group: TLS |
| 123 | - name: tls_key |
| 124 | description: Path to client TLS private key (for mTLS). |
| 125 | default_value: "" |
| 126 | required: false |
| 127 | group: TLS |
| 128 | |
| 129 | - name: proxy_url |
| 130 | description: HTTP proxy URL. |
| 131 | default_value: "" |
| 132 | required: false |
| 133 | group: Proxy |
| 134 | - name: proxy_username |
| 135 | description: Username for proxy Basic HTTP authentication. |
| 136 | default_value: "" |
| 137 | required: false |
| 138 | group: Proxy |
| 139 | - name: proxy_password |
| 140 | description: Password for proxy Basic HTTP authentication. |
| 141 | default_value: "" |
| 142 | required: false |
| 143 | group: Proxy |
| 144 | |
| 145 | - name: method |
| 146 | description: HTTP method to use. |
| 147 | default_value: "GET" |
| 148 | required: false |
| 149 | group: Request |
| 150 | - name: body |
| 151 | description: Request body (e.g., for POST/PUT). |
| 152 | default_value: "" |
| 153 | required: false |
| 154 | group: Request |
| 155 | - name: headers |
| 156 | description: "Additional HTTP headers (one per line as key: value)." |
| 157 | default_value: "" |
| 158 | required: false |
| 159 | group: Request |
| 160 | - name: not_follow_redirects |
| 161 | description: Do not follow HTTP redirects. |
| 162 | default_value: no |
| 163 | required: false |
| 164 | group: Request |
| 165 | - name: force_http2 |
| 166 | description: Force HTTP/2 (including h2c over TCP). |
| 167 | default_value: no |
| 168 | required: false |
| 169 | group: Request |
| 170 | |
| 171 | - name: vnode |
| 172 | description: Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). |
| 173 | default_value: "" |
| 174 | required: false |
| 175 | group: Virtual Node |
| 176 | examples: |
| 177 | folding: |
| 178 | title: Config |
| 179 | enabled: true |
| 180 | list: |
| 181 | - name: HTTP |
| 182 | description: Collecting data from a local instance over HTTP. |
| 183 | config: | |
| 184 | jobs: |
| 185 | - name: local |
| 186 | url: http://localhost/status?full&json |
| 187 | - name: Unix socket |
| 188 | description: Collecting data from a local instance over Unix socket. |
| 189 | config: | |
| 190 | jobs: |
| 191 | - name: local |
| 192 | socket: '/tmp/php-fpm.sock' |
| 193 | - name: TCP socket |
| 194 | description: Collecting data from a local instance over TCP socket. |
| 195 | config: | |
| 196 | jobs: |
| 197 | - name: local |
| 198 | address: 127.0.0.1:9000 |
| 199 | - name: Multi-instance |
| 200 | description: | |
| 201 | > **Note**: When you define multiple jobs, their names must be unique. |
| 202 | |
| 203 | Collecting metrics from local and remote instances. |
| 204 | config: | |
| 205 | jobs: |
| 206 | - name: local |
| 207 | url: http://localhost/status?full&json |
| 208 | |
| 209 | - name: remote |
| 210 | url: http://203.0.113.10/status?full&json |
| 211 | troubleshooting: |
| 212 | problems: |
| 213 | list: [] |
| 214 | alerts: [] |
| 215 | metrics: |
| 216 | folding: |
| 217 | title: Metrics |
| 218 | enabled: false |
| 219 | description: "" |
| 220 | availability: [] |
| 221 | scopes: |
| 222 | - name: global |
| 223 | description: These metrics refer to the entire monitored application. |
| 224 | labels: [] |
| 225 | metrics: |
| 226 | - name: phpfpm.connections |
| 227 | description: Active Connections |
| 228 | unit: connections |
| 229 | chart_type: line |
| 230 | dimensions: |
| 231 | - name: active |
| 232 | - name: max_active |
| 233 | - name: idle |
| 234 | - name: phpfpm.requests |
| 235 | description: Requests |
| 236 | unit: requests/s |
| 237 | chart_type: line |
| 238 | dimensions: |
| 239 | - name: requests |
| 240 | - name: phpfpm.performance |
| 241 | description: Performance |
| 242 | unit: status |
| 243 | chart_type: line |
| 244 | dimensions: |
| 245 | - name: max_children_reached |
| 246 | - name: slow_requests |
| 247 | - name: phpfpm.request_duration |
| 248 | description: Requests Duration Among All Idle Processes |
| 249 | unit: milliseconds |
| 250 | chart_type: line |
| 251 | dimensions: |
| 252 | - name: min |
| 253 | - name: max |
| 254 | - name: avg |
| 255 | - name: phpfpm.request_cpu |
| 256 | description: Last Request CPU Usage Among All Idle Processes |
| 257 | unit: percentage |
| 258 | chart_type: line |
| 259 | dimensions: |
| 260 | - name: min |
| 261 | - name: max |
| 262 | - name: avg |
| 263 | - name: phpfpm.request_mem |
| 264 | description: Last Request Memory Usage Among All Idle Processes |
| 265 | unit: KB |
| 266 | chart_type: line |
| 267 | dimensions: |
| 268 | - name: min |
| 269 | - name: max |
| 270 | - name: avg |