github.com/netdata/go.d.plugin@v0.58.1/modules/apache/metadata.yaml (about) 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-web-proxies 14 keywords: 15 - webserver 16 related_resources: 17 integrations: 18 list: 19 - plugin_name: go.d.plugin 20 module_name: weblog 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 most_popular: true 28 overview: 29 data_collection: 30 metrics_description: | 31 This collector monitors the activity and performance of Apache servers, and collects metrics such as the number of connections, workers, requests and more. 32 method_description: | 33 It sends HTTP requests to the Apache location [server-status](https://httpd.apache.org/docs/2.4/mod/mod_status.html), 34 which is a built-in location that provides metrics about the Apache server. 35 supported_platforms: 36 include: [] 37 exclude: [] 38 multi_instance: true 39 additional_permissions: 40 description: "" 41 default_behavior: 42 auto_detection: 43 description: | 44 By default, it detects Apache instances running on localhost that are listening on port 80. 45 On startup, it tries to collect metrics from: 46 47 - http://localhost/server-status?auto 48 - http://127.0.0.1/server-status?auto 49 limits: 50 description: "" 51 performance_impact: 52 description: "" 53 setup: 54 prerequisites: 55 list: 56 - title: Enable Apache status support 57 description: | 58 - Enable and configure [status_module](https://httpd.apache.org/docs/2.4/mod/mod_status.html). 59 - 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). 60 configuration: 61 file: 62 name: go.d/apache.conf 63 options: 64 description: | 65 The following options can be defined globally: update_every, autodetection_retry. 66 folding: 67 title: Config options 68 enabled: true 69 list: 70 - name: update_every 71 description: Data collection frequency. 72 default_value: 1 73 required: false 74 - name: autodetection_retry 75 description: Recheck interval in seconds. Zero means no recheck will be scheduled. 76 default_value: 0 77 required: false 78 - name: url 79 description: Server URL. 80 default_value: http://127.0.0.1/server-status?auto 81 required: true 82 - name: timeout 83 description: HTTP request timeout. 84 default_value: 1 85 required: false 86 - name: username 87 description: Username for basic HTTP authentication. 88 default_value: "" 89 required: false 90 - name: password 91 description: Password for basic HTTP authentication. 92 default_value: "" 93 required: false 94 - name: proxy_url 95 description: Proxy URL. 96 default_value: "" 97 required: false 98 - name: proxy_username 99 description: Username for proxy basic HTTP authentication. 100 default_value: "" 101 required: false 102 - name: proxy_password 103 description: Password for proxy basic HTTP authentication. 104 default_value: "" 105 required: false 106 - name: method 107 description: HTTP request method. 108 default_value: "GET" 109 required: false 110 - name: body 111 description: HTTP request body. 112 default_value: "" 113 required: false 114 - name: headers 115 description: HTTP request headers. 116 default_value: "" 117 required: false 118 - name: not_follow_redirects 119 description: Redirect handling policy. Controls whether the client follows redirects. 120 default_value: no 121 required: false 122 - name: tls_skip_verify 123 description: Server certificate chain and hostname validation policy. Controls whether the client performs this check. 124 default_value: no 125 required: false 126 - name: tls_ca 127 description: Certification authority that the client uses when verifying the server's certificates. 128 default_value: "" 129 required: false 130 - name: tls_cert 131 description: Client TLS certificate. 132 default_value: "" 133 required: false 134 - name: tls_key 135 description: Client TLS key. 136 default_value: "" 137 required: false 138 examples: 139 folding: 140 title: Config 141 enabled: true 142 list: 143 - name: Basic 144 folding: 145 enabled: false 146 description: A basic example configuration. 147 config: | 148 jobs: 149 - name: local 150 url: http://127.0.0.1/server-status?auto 151 - name: HTTP authentication 152 description: Basic HTTP authentication. 153 config: | 154 jobs: 155 - name: local 156 url: http://127.0.0.1/server-status?auto 157 username: username 158 password: password 159 - name: HTTPS with self-signed certificate 160 description: Apache with enabled HTTPS and self-signed certificate. 161 config: | 162 jobs: 163 - name: local 164 url: https://127.0.0.1/server-status?auto 165 tls_skip_verify: yes 166 - name: Multi-instance 167 description: | 168 > **Note**: When you define multiple jobs, their names must be unique. 169 170 Collecting metrics from local and remote instances. 171 config: | 172 jobs: 173 - name: local 174 url: http://127.0.0.1/server-status?auto 175 176 - name: remote 177 url: http://192.0.2.1/server-status?auto 178 troubleshooting: 179 problems: 180 list: [] 181 alerts: [] 182 metrics: 183 folding: 184 title: Metrics 185 enabled: false 186 description: | 187 All metrics available only if [ExtendedStatus](https://httpd.apache.org/docs/2.4/mod/core.html#extendedstatus) is on. 188 availability: 189 - Basic 190 - Extended 191 scopes: 192 - name: global 193 description: These metrics refer to the entire monitored application. 194 labels: [] 195 metrics: 196 - name: apache.connections 197 availability: 198 - Basic 199 - Extended 200 description: Connections 201 unit: connections 202 chart_type: line 203 dimensions: 204 - name: connections 205 - name: apache.conns_async 206 availability: 207 - Basic 208 - Extended 209 description: Active Connections 210 unit: connections 211 chart_type: stacked 212 dimensions: 213 - name: keepalive 214 - name: closing 215 - name: writing 216 - name: apache.workers 217 availability: 218 - Basic 219 - Extended 220 description: Workers Threads 221 unit: workers 222 chart_type: stacked 223 dimensions: 224 - name: idle 225 - name: busy 226 - name: apache.scoreboard 227 availability: 228 - Basic 229 - Extended 230 description: Scoreboard 231 unit: connections 232 chart_type: line 233 dimensions: 234 - name: waiting 235 - name: starting 236 - name: reading 237 - name: sending 238 - name: keepalive 239 - name: dns_lookup 240 - name: closing 241 - name: logging 242 - name: finishing 243 - name: idle_cleanup 244 - name: open 245 - name: apache.requests 246 availability: 247 - Extended 248 description: Requests 249 unit: requests/s 250 chart_type: line 251 dimensions: 252 - name: requests 253 - name: apache.net 254 availability: 255 - Extended 256 description: Bandwidth 257 unit: kilobit/s 258 chart_type: area 259 dimensions: 260 - name: sent 261 - name: apache.reqpersec 262 availability: 263 - Extended 264 description: Lifetime Average Number Of Requests Per Second 265 unit: requests/s 266 chart_type: area 267 dimensions: 268 - name: requests 269 - name: apache.bytespersec 270 availability: 271 - Extended 272 description: Lifetime Average Number Of Bytes Served Per Second 273 unit: KiB/s 274 chart_type: area 275 dimensions: 276 - name: served 277 - name: apache.bytesperreq 278 availability: 279 - Extended 280 description: Lifetime Average Response Size 281 unit: KiB 282 chart_type: area 283 dimensions: 284 - name: size 285 - name: apache.uptime 286 availability: 287 - Extended 288 description: Uptime 289 unit: seconds 290 chart_type: line 291 dimensions: 292 - name: uptime 293 - <<: *module 294 meta: 295 <<: *meta 296 id: collector-go.d.plugin-httpd 297 monitored_instance: 298 name: HTTPD 299 link: https://httpd.apache.org/ 300 icon_filename: apache.svg 301 categories: 302 - data-collection.web-servers-and-web-proxies