github.com/netdata/go.d.plugin@v0.58.1/modules/phpfpm/metadata.yaml (about) 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-web-proxies 13 keywords: 14 - phpfpm 15 - php 16 related_resources: 17 integrations: 18 list: [] 19 info_provided_to_referring_integrations: 20 description: "" 21 most_popular: false 22 overview: 23 data_collection: 24 metrics_description: | 25 This collector monitors PHP-FPM instances. 26 method_description: "" 27 supported_platforms: 28 include: [] 29 exclude: [] 30 multi_instance: true 31 additional_permissions: 32 description: "" 33 default_behavior: 34 auto_detection: 35 description: "" 36 limits: 37 description: "" 38 performance_impact: 39 description: "" 40 setup: 41 prerequisites: 42 list: 43 - title: Enable status page 44 description: | 45 Uncomment the `pm.status_path = /status` variable in the `php-fpm` config file. 46 configuration: 47 file: 48 name: go.d/phpfpm.conf 49 options: 50 description: | 51 The following options can be defined globally: update_every, autodetection_retry. 52 folding: 53 title: Config options 54 enabled: true 55 list: 56 - name: update_every 57 description: Data collection frequency. 58 default_value: 1 59 required: false 60 - name: autodetection_retry 61 description: Recheck interval in seconds. Zero means no recheck will be scheduled. 62 default_value: 0 63 required: false 64 - name: url 65 description: Server URL. 66 default_value: http://127.0.0.1/status?full&json 67 required: true 68 - name: socket 69 description: Server Unix socket. 70 default_value: "" 71 required: false 72 - name: address 73 description: Server address in IP:PORT format. 74 default_value: "" 75 required: false 76 - name: fcgi_path 77 description: Status path. 78 default_value: /status 79 required: false 80 - name: timeout 81 description: HTTP request timeout. 82 default_value: 1 83 required: false 84 - name: username 85 description: Username for basic HTTP authentication. 86 default_value: "" 87 required: false 88 - name: password 89 description: Password for basic HTTP authentication. 90 default_value: "" 91 required: false 92 - name: proxy_url 93 description: Proxy URL. 94 default_value: "" 95 required: false 96 - name: proxy_username 97 description: Username for proxy basic HTTP authentication. 98 default_value: "" 99 required: false 100 - name: proxy_password 101 description: Password for proxy basic HTTP authentication. 102 default_value: "" 103 required: false 104 - name: method 105 description: HTTP request method. 106 default_value: GET 107 required: false 108 - name: body 109 description: HTTP request body. 110 default_value: "" 111 required: false 112 - name: headers 113 description: HTTP request headers. 114 default_value: "" 115 required: false 116 - name: not_follow_redirects 117 description: Redirect handling policy. Controls whether the client follows redirects. 118 default_value: false 119 required: false 120 - name: tls_skip_verify 121 description: Server certificate chain and hostname validation policy. Controls whether the client performs this check. 122 default_value: false 123 required: false 124 - name: tls_ca 125 description: Certification authority that the client uses when verifying the server's certificates. 126 default_value: "" 127 required: false 128 - name: tls_cert 129 description: Client TLS certificate. 130 default_value: "" 131 required: false 132 - name: tls_key 133 description: Client TLS key. 134 default_value: "" 135 required: false 136 examples: 137 folding: 138 title: Config 139 enabled: true 140 list: 141 - name: HTTP 142 description: Collecting data from a local instance over HTTP. 143 config: | 144 jobs: 145 - name: local 146 url: http://localhost/status?full&json 147 - name: Unix socket 148 description: Collecting data from a local instance over Unix socket. 149 config: | 150 jobs: 151 - name: local 152 socket: '/tmp/php-fpm.sock' 153 - name: TCP socket 154 description: Collecting data from a local instance over TCP socket. 155 config: | 156 jobs: 157 - name: local 158 address: 127.0.0.1:9000 159 - name: Multi-instance 160 description: | 161 > **Note**: When you define multiple jobs, their names must be unique. 162 163 Collecting metrics from local and remote instances. 164 config: | 165 jobs: 166 - name: local 167 url: http://localhost/status?full&json 168 169 - name: remote 170 url: http://203.0.113.10/status?full&json 171 troubleshooting: 172 problems: 173 list: [] 174 alerts: [] 175 metrics: 176 folding: 177 title: Metrics 178 enabled: false 179 description: "" 180 availability: [] 181 scopes: 182 - name: global 183 description: These metrics refer to the entire monitored application. 184 labels: [] 185 metrics: 186 - name: phpfpm.connections 187 description: Active Connections 188 unit: connections 189 chart_type: line 190 dimensions: 191 - name: active 192 - name: max_active 193 - name: idle 194 - name: phpfpm.requests 195 description: Requests 196 unit: requests/s 197 chart_type: line 198 dimensions: 199 - name: requests 200 - name: phpfpm.performance 201 description: Performance 202 unit: status 203 chart_type: line 204 dimensions: 205 - name: max_children_reached 206 - name: slow_requests 207 - name: phpfpm.request_duration 208 description: Requests Duration Among All Idle Processes 209 unit: milliseconds 210 chart_type: line 211 dimensions: 212 - name: min 213 - name: max 214 - name: avg 215 - name: phpfpm.request_cpu 216 description: Last Request CPU Usage Among All Idle Processes 217 unit: percentage 218 chart_type: line 219 dimensions: 220 - name: min 221 - name: max 222 - name: avg 223 - name: phpfpm.request_mem 224 description: Last Request Memory Usage Among All Idle Processes 225 unit: KB 226 chart_type: line 227 dimensions: 228 - name: min 229 - name: max 230 - name: avg