| 1 | plugin_name: go.d.plugin |
| 2 | modules: |
| 3 | - &module |
| 4 | meta: &meta |
| 5 | id: collector-go.d.plugin-apache |
| 6 | plugin_name: go.d.plugin |
| 7 | module_name: apache |
| 8 | monitored_instance: |
| 9 | name: Apache |
| 10 | link: https://httpd.apache.org/ |
| 11 | icon_filename: apache.svg |
| 12 | categories: |
| 13 | - data-collection.web-servers-and-proxies |
| 14 | keywords: |
| 15 | - webserver |
| 16 | related_resources: |
| 17 | integrations: |
| 18 | list: |
| 19 | - plugin_name: go.d.plugin |
| 20 | module_name: web_log |
| 21 | - plugin_name: go.d.plugin |
| 22 | module_name: httpcheck |
| 23 | - plugin_name: apps.plugin |
| 24 | module_name: apps |
| 25 | info_provided_to_referring_integrations: |
| 26 | description: "" |
| 27 | overview: |
| 28 | data_collection: |
| 29 | metrics_description: | |
| 30 | This collector monitors the activity and performance of Apache servers, and collects metrics such as the number of connections, workers, requests and more. |
| 31 | method_description: | |
| 32 | It sends HTTP requests to the Apache location [server-status](https://httpd.apache.org/docs/2.4/mod/mod_status.html), |
| 33 | which is a built-in location that provides metrics about the Apache server. |
| 34 | supported_platforms: |
| 35 | include: [] |
| 36 | exclude: [] |
| 37 | multi_instance: true |
| 38 | additional_permissions: |
| 39 | description: "" |
| 40 | default_behavior: |
| 41 | auto_detection: |
| 42 | description: | |
| 43 | By default, it detects Apache instances running on localhost that are listening on port 80. |
| 44 | On startup, it tries to collect metrics from: |
| 45 | |
| 46 | - http://localhost/server-status?auto |
| 47 | - http://127.0.0.1/server-status?auto |
| 48 | limits: |
| 49 | description: "" |
| 50 | performance_impact: |
| 51 | description: "" |
| 52 | setup: |
| 53 | prerequisites: |
| 54 | list: |
| 55 | - title: Enable Apache status support |
| 56 | description: | |
| 57 | - Enable and configure [status_module](https://httpd.apache.org/docs/2.4/mod/mod_status.html). |
| 58 | - Ensure that you have [ExtendedStatus](https://httpd.apache.org/docs/2.4/mod/mod_status.html#troubleshoot) set on (enabled by default since Apache v2.3.6). |
| 59 | configuration: |
| 60 | file: |
| 61 | name: go.d/apache.conf |
| 62 | options: |
| 63 | description: | |
| 64 | The following options can be defined globally: update_every, autodetection_retry. |
| 65 | folding: |
| 66 | title: Config options |
| 67 | enabled: true |
| 68 | list: |
| 69 | - name: update_every |
| 70 | description: Data collection interval (seconds). |
| 71 | default_value: 1 |
| 72 | required: false |
| 73 | group: Collection |
| 74 | - name: autodetection_retry |
| 75 | description: Autodetection retry interval (seconds). Set 0 to disable. |
| 76 | default_value: 0 |
| 77 | required: false |
| 78 | group: Collection |
| 79 | |
| 80 | - name: url |
| 81 | description: Target endpoint URL. |
| 82 | default_value: http://127.0.0.1/server-status?auto |
| 83 | required: true |
| 84 | group: Target |
| 85 | - name: timeout |
| 86 | description: HTTP request timeout (seconds). |
| 87 | default_value: 1 |
| 88 | required: false |
| 89 | group: Target |
| 90 | |
| 91 | - name: username |
| 92 | description: Username for Basic HTTP authentication. |
| 93 | default_value: "" |
| 94 | required: false |
| 95 | group: HTTP Auth |
| 96 | - name: password |
| 97 | description: Password for Basic HTTP authentication. |
| 98 | default_value: "" |
| 99 | required: false |
| 100 | group: HTTP Auth |
| 101 | - name: bearer_token_file |
| 102 | description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)." |
| 103 | default_value: "" |
| 104 | required: false |
| 105 | group: HTTP Auth |
| 106 | |
| 107 | - name: tls_skip_verify |
| 108 | description: Skip TLS certificate and hostname verification (insecure). |
| 109 | default_value: no |
| 110 | required: false |
| 111 | group: TLS |
| 112 | - name: tls_ca |
| 113 | description: Path to CA bundle used to validate the server certificate. |
| 114 | default_value: "" |
| 115 | required: false |
| 116 | group: TLS |
| 117 | - name: tls_cert |
| 118 | description: Path to client TLS certificate (for mTLS). |
| 119 | default_value: "" |
| 120 | required: false |
| 121 | group: TLS |
| 122 | - name: tls_key |
| 123 | description: Path to client TLS private key (for mTLS). |
| 124 | default_value: "" |
| 125 | required: false |
| 126 | group: TLS |
| 127 | |
| 128 | - name: proxy_url |
| 129 | description: HTTP proxy URL. |
| 130 | default_value: "" |
| 131 | required: false |
| 132 | group: Proxy |
| 133 | - name: proxy_username |
| 134 | description: Username for proxy Basic HTTP authentication. |
| 135 | default_value: "" |
| 136 | required: false |
| 137 | group: Proxy |
| 138 | - name: proxy_password |
| 139 | description: Password for proxy Basic HTTP authentication. |
| 140 | default_value: "" |
| 141 | required: false |
| 142 | group: Proxy |
| 143 | |
| 144 | - name: method |
| 145 | description: HTTP method to use. |
| 146 | default_value: "GET" |
| 147 | required: false |
| 148 | group: Request |
| 149 | - name: body |
| 150 | description: Request body (e.g., for POST/PUT). |
| 151 | default_value: "" |
| 152 | required: false |
| 153 | group: Request |
| 154 | - name: headers |
| 155 | description: "Additional HTTP headers (one per line as key: value)." |
| 156 | default_value: "" |
| 157 | required: false |
| 158 | group: Request |
| 159 | - name: not_follow_redirects |
| 160 | description: Do not follow HTTP redirects. |
| 161 | default_value: no |
| 162 | required: false |
| 163 | group: Request |
| 164 | - name: force_http2 |
| 165 | description: Force HTTP/2 (including h2c over TCP). |
| 166 | default_value: no |
| 167 | required: false |
| 168 | group: Request |
| 169 | |
| 170 | - name: vnode |
| 171 | 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). |
| 172 | default_value: "" |
| 173 | required: false |
| 174 | group: Virtual Node |
| 175 | examples: |
| 176 | folding: |
| 177 | title: Config |
| 178 | enabled: true |
| 179 | list: |
| 180 | - name: Basic |
| 181 | folding: |
| 182 | enabled: false |
| 183 | description: A basic example configuration. |
| 184 | config: | |
| 185 | jobs: |
| 186 | - name: local |
| 187 | url: http://127.0.0.1/server-status?auto |
| 188 | - name: HTTP authentication |
| 189 | description: Basic HTTP authentication. |
| 190 | config: | |
| 191 | jobs: |
| 192 | - name: local |
| 193 | url: http://127.0.0.1/server-status?auto |
| 194 | username: username |
| 195 | password: password |
| 196 | - name: HTTPS with self-signed certificate |
| 197 | description: Apache with enabled HTTPS and self-signed certificate. |
| 198 | config: | |
| 199 | jobs: |
| 200 | - name: local |
| 201 | url: https://127.0.0.1/server-status?auto |
| 202 | tls_skip_verify: yes |
| 203 | - name: Multi-instance |
| 204 | description: | |
| 205 | > **Note**: When you define multiple jobs, their names must be unique. |
| 206 | |
| 207 | Collecting metrics from local and remote instances. |
| 208 | config: | |
| 209 | jobs: |
| 210 | - name: local |
| 211 | url: http://127.0.0.1/server-status?auto |
| 212 | |
| 213 | - name: remote |
| 214 | url: http://192.0.2.1/server-status?auto |
| 215 | troubleshooting: |
| 216 | problems: |
| 217 | list: [] |
| 218 | alerts: [] |
| 219 | metrics: |
| 220 | folding: |
| 221 | title: Metrics |
| 222 | enabled: false |
| 223 | description: | |
| 224 | All metrics available only if [ExtendedStatus](https://httpd.apache.org/docs/2.4/mod/core.html#extendedstatus) is on. |
| 225 | availability: |
| 226 | - Basic |
| 227 | - Extended |
| 228 | scopes: |
| 229 | - name: global |
| 230 | description: These metrics refer to the entire monitored application. |
| 231 | labels: [] |
| 232 | metrics: |
| 233 | - name: apache.connections |
| 234 | availability: |
| 235 | - Basic |
| 236 | - Extended |
| 237 | description: Connections |
| 238 | unit: connections |
| 239 | chart_type: line |
| 240 | dimensions: |
| 241 | - name: connections |
| 242 | - name: apache.conns_async |
| 243 | availability: |
| 244 | - Basic |
| 245 | - Extended |
| 246 | description: Active Connections |
| 247 | unit: connections |
| 248 | chart_type: stacked |
| 249 | dimensions: |
| 250 | - name: keepalive |
| 251 | - name: closing |
| 252 | - name: writing |
| 253 | - name: apache.workers |
| 254 | availability: |
| 255 | - Basic |
| 256 | - Extended |
| 257 | description: Workers Threads |
| 258 | unit: workers |
| 259 | chart_type: stacked |
| 260 | dimensions: |
| 261 | - name: idle |
| 262 | - name: busy |
| 263 | - name: apache.scoreboard |
| 264 | availability: |
| 265 | - Basic |
| 266 | - Extended |
| 267 | description: Scoreboard |
| 268 | unit: connections |
| 269 | chart_type: line |
| 270 | dimensions: |
| 271 | - name: waiting |
| 272 | - name: starting |
| 273 | - name: reading |
| 274 | - name: sending |
| 275 | - name: keepalive |
| 276 | - name: dns_lookup |
| 277 | - name: closing |
| 278 | - name: logging |
| 279 | - name: finishing |
| 280 | - name: idle_cleanup |
| 281 | - name: open |
| 282 | - name: apache.requests |
| 283 | availability: |
| 284 | - Extended |
| 285 | description: Requests |
| 286 | unit: requests/s |
| 287 | chart_type: line |
| 288 | dimensions: |
| 289 | - name: requests |
| 290 | - name: apache.net |
| 291 | availability: |
| 292 | - Extended |
| 293 | description: Bandwidth |
| 294 | unit: kilobit/s |
| 295 | chart_type: area |
| 296 | dimensions: |
| 297 | - name: sent |
| 298 | - name: apache.reqpersec |
| 299 | availability: |
| 300 | - Extended |
| 301 | description: Lifetime Average Number Of Requests Per Second |
| 302 | unit: requests/s |
| 303 | chart_type: area |
| 304 | dimensions: |
| 305 | - name: requests |
| 306 | - name: apache.bytespersec |
| 307 | availability: |
| 308 | - Extended |
| 309 | description: Lifetime Average Number Of Bytes Served Per Second |
| 310 | unit: KiB/s |
| 311 | chart_type: area |
| 312 | dimensions: |
| 313 | - name: served |
| 314 | - name: apache.bytesperreq |
| 315 | availability: |
| 316 | - Extended |
| 317 | description: Lifetime Average Response Size |
| 318 | unit: KiB |
| 319 | chart_type: area |
| 320 | dimensions: |
| 321 | - name: size |
| 322 | - name: apache.uptime |
| 323 | availability: |
| 324 | - Extended |
| 325 | description: Uptime |
| 326 | unit: seconds |
| 327 | chart_type: line |
| 328 | dimensions: |
| 329 | - name: uptime |
| 330 | - <<: *module |
| 331 | meta: |
| 332 | <<: *meta |
| 333 | id: collector-go.d.plugin-httpd |
| 334 | monitored_instance: |
| 335 | name: HTTPD |
| 336 | link: https://httpd.apache.org/ |
| 337 | icon_filename: apache.svg |
| 338 | categories: |
| 339 | - data-collection.web-servers-and-proxies |