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