1 /**
2 * collectd - src/apache.c
3 * Copyright (C) 2006-2010 Florian octo Forster
4 * Copyright (C) 2007 Florent EppO Monbillard
5 * Copyright (C) 2009 Amit Gupta
6 *
7 * This program is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation; only version 2 of the License is applicable.
10 *
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19 *
20 * Authors:
21 * Florian octo Forster <octo at collectd.org>
22 * Florent EppO Monbillard <eppo at darox.net>
23 * - connections/lighttpd extension
24 * Amit Gupta <amit.gupta221 at gmail.com>
25 **/
26
27 #include "collectd.h"
28
29 #include "plugin.h"
30 #include "utils/common/common.h"
31
32 #include <curl/curl.h>
33
34 enum server_enum { APACHE = 0, LIGHTTPD };
35
36 struct apache_s {
37 int server_type;
38 char *name;
39 char *host;
40 char *url;
41 char *user;
42 char *pass;
43 bool verify_peer;
44 bool verify_host;
45 char *cacert;
46 char *ssl_ciphers;
47 char *server; /* user specific server type */
48 char *apache_buffer;
49 char apache_curl_error[CURL_ERROR_SIZE];
50 size_t apache_buffer_size;
51 size_t apache_buffer_fill;
52 int timeout;
53 CURL *curl;
54 }; /* apache_s */
55
56 typedef struct apache_s apache_t;
57
58 /* TODO: Remove this prototype */
59 static int apache_read_host(user_data_t *user_data);
60
apache_free(void * arg)61 static void apache_free(void *arg) {
62 apache_t *st = arg;
63
64 if (st == NULL)
65 return;
66
67 sfree(st->name);
68 sfree(st->host);
69 sfree(st->url);
70 sfree(st->user);
71 sfree(st->pass);
72 sfree(st->cacert);
73 sfree(st->ssl_ciphers);
74 sfree(st->server);
75 sfree(st->apache_buffer);
76 if (st->curl) {
77 curl_easy_cleanup(st->curl);
78 st->curl = NULL;
79 }
80 sfree(st);
81 } /* apache_free */
82
apache_curl_callback(void * buf,size_t size,size_t nmemb,void * user_data)83 static size_t apache_curl_callback(void *buf, size_t size, size_t nmemb,
84 void *user_data) {
85 apache_t *st = user_data;
86 if (st == NULL) {
87 ERROR("apache plugin: apache_curl_callback: "
88 "user_data pointer is NULL.");
89 return 0;
90 }
91
92 size_t len = size * nmemb;
93 if (len == 0)
94 return len;
95
96 if ((st->apache_buffer_fill + len) >= st->apache_buffer_size) {
97 char *temp = realloc(st->apache_buffer, st->apache_buffer_fill + len + 1);
98 if (temp == NULL) {
99 ERROR("apache plugin: realloc failed.");
100 return 0;
101 }
102 st->apache_buffer = temp;
103 st->apache_buffer_size = st->apache_buffer_fill + len + 1;
104 }
105
106 memcpy(st->apache_buffer + st->apache_buffer_fill, (char *)buf, len);
107 st->apache_buffer_fill += len;
108 st->apache_buffer[st->apache_buffer_fill] = 0;
109
110 return len;
111 } /* int apache_curl_callback */
112
apache_header_callback(void * buf,size_t size,size_t nmemb,void * user_data)113 static size_t apache_header_callback(void *buf, size_t size, size_t nmemb,
114 void *user_data) {
115 apache_t *st = user_data;
116 if (st == NULL) {
117 ERROR("apache plugin: apache_header_callback: "
118 "user_data pointer is NULL.");
119 return 0;
120 }
121
122 size_t len = size * nmemb;
123 if (len == 0)
124 return len;
125
126 /* look for the Server header */
127 if (strncasecmp(buf, "Server: ", strlen("Server: ")) != 0)
128 return len;
129
130 if (strstr(buf, "Apache") != NULL)
131 st->server_type = APACHE;
132 else if (strstr(buf, "lighttpd") != NULL)
133 st->server_type = LIGHTTPD;
134 else if (strstr(buf, "IBM_HTTP_Server") != NULL)
135 st->server_type = APACHE;
136 else {
137 const char *hdr = buf;
138
139 hdr += strlen("Server: ");
140 NOTICE("apache plugin: Unknown server software: %s", hdr);
141 }
142
143 return len;
144 } /* apache_header_callback */
145
146 /* Configuration handling functiions
147 * <Plugin apache>
148 * <Instance "instance_name">
149 * URL ...
150 * </Instance>
151 * URL ...
152 * </Plugin>
153 */
config_add(oconfig_item_t * ci)154 static int config_add(oconfig_item_t *ci) {
155 apache_t *st = calloc(1, sizeof(*st));
156 if (st == NULL) {
157 ERROR("apache plugin: calloc failed.");
158 return -1;
159 }
160
161 st->timeout = -1;
162
163 int status = cf_util_get_string(ci, &st->name);
164 if (status != 0) {
165 sfree(st);
166 return status;
167 }
168 assert(st->name != NULL);
169
170 for (int i = 0; i < ci->children_num; i++) {
171 oconfig_item_t *child = ci->children + i;
172
173 if (strcasecmp("URL", child->key) == 0)
174 status = cf_util_get_string(child, &st->url);
175 else if (strcasecmp("Host", child->key) == 0)
176 status = cf_util_get_string(child, &st->host);
177 else if (strcasecmp("User", child->key) == 0)
178 status = cf_util_get_string(child, &st->user);
179 else if (strcasecmp("Password", child->key) == 0)
180 status = cf_util_get_string(child, &st->pass);
181 else if (strcasecmp("VerifyPeer", child->key) == 0)
182 status = cf_util_get_boolean(child, &st->verify_peer);
183 else if (strcasecmp("VerifyHost", child->key) == 0)
184 status = cf_util_get_boolean(child, &st->verify_host);
185 else if (strcasecmp("CACert", child->key) == 0)
186 status = cf_util_get_string(child, &st->cacert);
187 else if (strcasecmp("SSLCiphers", child->key) == 0)
188 status = cf_util_get_string(child, &st->ssl_ciphers);
189 else if (strcasecmp("Server", child->key) == 0)
190 status = cf_util_get_string(child, &st->server);
191 else if (strcasecmp("Timeout", child->key) == 0)
192 status = cf_util_get_int(child, &st->timeout);
193 else {
194 WARNING("apache plugin: Option `%s' not allowed here.", child->key);
195 status = -1;
196 }
197
198 if (status != 0)
199 break;
200 }
201
202 /* Check if struct is complete.. */
203 if ((status == 0) && (st->url == NULL)) {
204 ERROR("apache plugin: Instance `%s': "
205 "No URL has been configured.",
206 st->name);
207 status = -1;
208 }
209
210 if (status != 0) {
211 apache_free(st);
212 return -1;
213 }
214
215 char callback_name[3 * DATA_MAX_NAME_LEN];
216
217 snprintf(callback_name, sizeof(callback_name), "apache/%s/%s",
218 (st->host != NULL) ? st->host : hostname_g,
219 (st->name != NULL) ? st->name : "default");
220
221 return plugin_register_complex_read(
222 /* group = */ NULL,
223 /* name = */ callback_name,
224 /* callback = */ apache_read_host,
225 /* interval = */ 0,
226 &(user_data_t){
227 .data = st,
228 .free_func = apache_free,
229 });
230 } /* int config_add */
231
config(oconfig_item_t * ci)232 static int config(oconfig_item_t *ci) {
233 for (int i = 0; i < ci->children_num; i++) {
234 oconfig_item_t *child = ci->children + i;
235
236 if (strcasecmp("Instance", child->key) == 0)
237 config_add(child);
238 else
239 WARNING("apache plugin: The configuration option "
240 "\"%s\" is not allowed here. Did you "
241 "forget to add an <Instance /> block "
242 "around the configuration?",
243 child->key);
244 } /* for (ci->children) */
245
246 return 0;
247 } /* int config */
248
249 /* initialize curl for each host */
init_host(apache_t * st)250 static int init_host(apache_t *st) /* {{{ */
251 {
252 assert(st->url != NULL);
253 /* (Assured by `config_add') */
254
255 if (st->curl != NULL) {
256 curl_easy_cleanup(st->curl);
257 st->curl = NULL;
258 }
259
260 if ((st->curl = curl_easy_init()) == NULL) {
261 ERROR("apache plugin: init_host: `curl_easy_init' failed.");
262 return -1;
263 }
264
265 curl_easy_setopt(st->curl, CURLOPT_NOSIGNAL, 1L);
266 curl_easy_setopt(st->curl, CURLOPT_WRITEFUNCTION, apache_curl_callback);
267 curl_easy_setopt(st->curl, CURLOPT_WRITEDATA, st);
268
269 /* not set as yet if the user specified string doesn't match apache or
270 * lighttpd, then ignore it. Headers will be parsed to find out the
271 * server type */
272 st->server_type = -1;
273
274 if (st->server != NULL) {
275 if (strcasecmp(st->server, "apache") == 0)
276 st->server_type = APACHE;
277 else if (strcasecmp(st->server, "lighttpd") == 0)
278 st->server_type = LIGHTTPD;
279 else if (strcasecmp(st->server, "ibm_http_server") == 0)
280 st->server_type = APACHE;
281 else
282 WARNING("apache plugin: Unknown `Server' setting: %s", st->server);
283 }
284
285 /* if not found register a header callback to determine the server_type */
286 if (st->server_type == -1) {
287 curl_easy_setopt(st->curl, CURLOPT_HEADERFUNCTION, apache_header_callback);
288 curl_easy_setopt(st->curl, CURLOPT_WRITEHEADER, st);
289 }
290
291 curl_easy_setopt(st->curl, CURLOPT_USERAGENT, COLLECTD_USERAGENT);
292 curl_easy_setopt(st->curl, CURLOPT_ERRORBUFFER, st->apache_curl_error);
293
294 if (st->user != NULL) {
295 #ifdef HAVE_CURLOPT_USERNAME
296 curl_easy_setopt(st->curl, CURLOPT_USERNAME, st->user);
297 curl_easy_setopt(st->curl, CURLOPT_PASSWORD,
298 (st->pass == NULL) ? "" : st->pass);
299 #else
300 static char credentials[1024];
301 int status = snprintf(credentials, sizeof(credentials), "%s:%s", st->user,
302 (st->pass == NULL) ? "" : st->pass);
303 if ((status < 0) || ((size_t)status >= sizeof(credentials))) {
304 ERROR("apache plugin: init_host: Returning an error "
305 "because the credentials have been "
306 "truncated.");
307 curl_easy_cleanup(st->curl);
308 st->curl = NULL;
309 return -1;
310 }
311
312 curl_easy_setopt(st->curl, CURLOPT_USERPWD, credentials);
313 #endif
314 }
315
316 curl_easy_setopt(st->curl, CURLOPT_FOLLOWLOCATION, 1L);
317 curl_easy_setopt(st->curl, CURLOPT_MAXREDIRS, 50L);
318
319 curl_easy_setopt(st->curl, CURLOPT_SSL_VERIFYPEER, (long)st->verify_peer);
320 curl_easy_setopt(st->curl, CURLOPT_SSL_VERIFYHOST, st->verify_host ? 2L : 0L);
321 if (st->cacert != NULL)
322 curl_easy_setopt(st->curl, CURLOPT_CAINFO, st->cacert);
323 if (st->ssl_ciphers != NULL)
324 curl_easy_setopt(st->curl, CURLOPT_SSL_CIPHER_LIST, st->ssl_ciphers);
325
326 #ifdef HAVE_CURLOPT_TIMEOUT_MS
327 if (st->timeout >= 0)
328 curl_easy_setopt(st->curl, CURLOPT_TIMEOUT_MS, (long)st->timeout);
329 else
330 curl_easy_setopt(st->curl, CURLOPT_TIMEOUT_MS,
331 (long)CDTIME_T_TO_MS(plugin_get_interval()));
332 #endif
333
334 return 0;
335 } /* }}} int init_host */
336
submit_value(const char * type,const char * type_instance,value_t value,apache_t * st)337 static void submit_value(const char *type, const char *type_instance,
338 value_t value, apache_t *st) {
339 value_list_t vl = VALUE_LIST_INIT;
340
341 vl.values = &value;
342 vl.values_len = 1;
343
344 if (st->host != NULL)
345 sstrncpy(vl.host, st->host, sizeof(vl.host));
346
347 sstrncpy(vl.plugin, "apache", sizeof(vl.plugin));
348 if (st->name != NULL)
349 sstrncpy(vl.plugin_instance, st->name, sizeof(vl.plugin_instance));
350
351 sstrncpy(vl.type, type, sizeof(vl.type));
352 if (type_instance != NULL)
353 sstrncpy(vl.type_instance, type_instance, sizeof(vl.type_instance));
354
355 plugin_dispatch_values(&vl);
356 } /* void submit_value */
357
submit_derive(const char * type,const char * type_instance,derive_t d,apache_t * st)358 static void submit_derive(const char *type, const char *type_instance,
359 derive_t d, apache_t *st) {
360 submit_value(type, type_instance, (value_t){.derive = d}, st);
361 } /* void submit_derive */
362
submit_gauge(const char * type,const char * type_instance,gauge_t g,apache_t * st)363 static void submit_gauge(const char *type, const char *type_instance, gauge_t g,
364 apache_t *st) {
365 submit_value(type, type_instance, (value_t){.gauge = g}, st);
366 } /* void submit_gauge */
367
submit_scoreboard(char * buf,apache_t * st)368 static void submit_scoreboard(char *buf, apache_t *st) {
369 /*
370 * Scoreboard Key:
371 * "_" Waiting for Connection, "S" Starting up,
372 * "R" Reading Request for apache and read-POST for lighttpd,
373 * "W" Sending Reply, "K" Keepalive (read), "D" DNS Lookup,
374 * "C" Closing connection, "L" Logging, "G" Gracefully finishing,
375 * "I" Idle cleanup of worker, "." Open slot with no current process
376 * Lighttpd specific legends -
377 * "E" hard error, "." connect, "h" handle-request,
378 * "q" request-start, "Q" request-end, "s" response-start
379 * "S" response-end, "r" read
380 */
381 long long open = 0LL;
382 long long waiting = 0LL;
383 long long starting = 0LL;
384 long long reading = 0LL;
385 long long sending = 0LL;
386 long long keepalive = 0LL;
387 long long dnslookup = 0LL;
388 long long closing = 0LL;
389 long long logging = 0LL;
390 long long finishing = 0LL;
391 long long idle_cleanup = 0LL;
392
393 /* lighttpd specific */
394 long long hard_error = 0LL;
395 long long lighttpd_read = 0LL;
396 long long handle_request = 0LL;
397 long long request_start = 0LL;
398 long long request_end = 0LL;
399 long long response_start = 0LL;
400 long long response_end = 0LL;
401
402 for (int i = 0; buf[i] != '\0'; i++) {
403 if (buf[i] == '.')
404 open++;
405 else if (buf[i] == '_')
406 waiting++;
407 else if (buf[i] == 'S')
408 starting++;
409 else if (buf[i] == 'R')
410 reading++;
411 else if (buf[i] == 'W')
412 sending++;
413 else if (buf[i] == 'K')
414 keepalive++;
415 else if (buf[i] == 'D')
416 dnslookup++;
417 else if (buf[i] == 'C')
418 closing++;
419 else if (buf[i] == 'L')
420 logging++;
421 else if (buf[i] == 'G')
422 finishing++;
423 else if (buf[i] == 'I')
424 idle_cleanup++;
425 else if (buf[i] == 'r')
426 lighttpd_read++;
427 else if (buf[i] == 'h')
428 handle_request++;
429 else if (buf[i] == 'E')
430 hard_error++;
431 else if (buf[i] == 'q')
432 request_start++;
433 else if (buf[i] == 'Q')
434 request_end++;
435 else if (buf[i] == 's')
436 response_start++;
437 else if (buf[i] == 'S')
438 response_end++;
439 }
440
441 if (st->server_type == APACHE) {
442 submit_gauge("apache_scoreboard", "open", open, st);
443 submit_gauge("apache_scoreboard", "waiting", waiting, st);
444 submit_gauge("apache_scoreboard", "starting", starting, st);
445 submit_gauge("apache_scoreboard", "reading", reading, st);
446 submit_gauge("apache_scoreboard", "sending", sending, st);
447 submit_gauge("apache_scoreboard", "keepalive", keepalive, st);
448 submit_gauge("apache_scoreboard", "dnslookup", dnslookup, st);
449 submit_gauge("apache_scoreboard", "closing", closing, st);
450 submit_gauge("apache_scoreboard", "logging", logging, st);
451 submit_gauge("apache_scoreboard", "finishing", finishing, st);
452 submit_gauge("apache_scoreboard", "idle_cleanup", idle_cleanup, st);
453 } else {
454 submit_gauge("apache_scoreboard", "connect", open, st);
455 submit_gauge("apache_scoreboard", "close", closing, st);
456 submit_gauge("apache_scoreboard", "hard_error", hard_error, st);
457 submit_gauge("apache_scoreboard", "read", lighttpd_read, st);
458 submit_gauge("apache_scoreboard", "read_post", reading, st);
459 submit_gauge("apache_scoreboard", "write", sending, st);
460 submit_gauge("apache_scoreboard", "handle_request", handle_request, st);
461 submit_gauge("apache_scoreboard", "request_start", request_start, st);
462 submit_gauge("apache_scoreboard", "request_end", request_end, st);
463 submit_gauge("apache_scoreboard", "response_start", response_start, st);
464 submit_gauge("apache_scoreboard", "response_end", response_end, st);
465 }
466 }
467
apache_read_host(user_data_t * user_data)468 static int apache_read_host(user_data_t *user_data) /* {{{ */
469 {
470 apache_t *st = user_data->data;
471
472 assert(st->url != NULL);
473 /* (Assured by `config_add') */
474
475 if (st->curl == NULL) {
476 if (init_host(st) != 0)
477 return -1;
478 }
479 assert(st->curl != NULL);
480
481 st->apache_buffer_fill = 0;
482
483 curl_easy_setopt(st->curl, CURLOPT_URL, st->url);
484
485 if (curl_easy_perform(st->curl) != CURLE_OK) {
486 ERROR("apache: curl_easy_perform failed: %s", st->apache_curl_error);
487 return -1;
488 }
489
490 /* fallback - server_type to apache if not set at this time */
491 if (st->server_type == -1) {
492 WARNING("apache plugin: Unable to determine server software "
493 "automatically. Will assume Apache.");
494 st->server_type = APACHE;
495 }
496
497 char *content_type;
498 static const char *text_plain = "text/plain";
499 int status =
500 curl_easy_getinfo(st->curl, CURLINFO_CONTENT_TYPE, &content_type);
501 if ((status == CURLE_OK) && (content_type != NULL) &&
502 (strncasecmp(content_type, text_plain, strlen(text_plain)) != 0)) {
503 WARNING("apache plugin: `Content-Type' response header is not `%s' "
504 "(received: `%s'). Expecting unparseable data. Please check `URL' "
505 "parameter (missing `?auto' suffix ?)",
506 text_plain, content_type);
507 }
508
509 char *ptr = st->apache_buffer;
510 char *saveptr = NULL;
511 char *line;
512 /* Apache http mod_status added a second set of BusyWorkers, IdleWorkers in
513 * https://github.com/apache/httpd/commit/6befc18
514 * For Apache 2.4.35 and up we need to ensure only one key is used.
515 * S.a. https://bz.apache.org/bugzilla/show_bug.cgi?id=63300
516 */
517 int apache_connections_submitted = 0, apache_idle_workers_submitted = 0;
518 while ((line = strtok_r(ptr, "\n\r", &saveptr)) != NULL) {
519 ptr = NULL;
520 char *fields[4];
521
522 int fields_num = strsplit(line, fields, STATIC_ARRAY_SIZE(fields));
523
524 if (fields_num == 3) {
525 if ((strcmp(fields[0], "Total") == 0) &&
526 (strcmp(fields[1], "Accesses:") == 0))
527 submit_derive("apache_requests", "", atoll(fields[2]), st);
528 else if ((strcmp(fields[0], "Total") == 0) &&
529 (strcmp(fields[1], "kBytes:") == 0))
530 submit_derive("apache_bytes", "", 1024LL * atoll(fields[2]), st);
531 } else if (fields_num == 2) {
532 if (strcmp(fields[0], "Scoreboard:") == 0)
533 submit_scoreboard(fields[1], st);
534 else if (!apache_connections_submitted &&
535 ((strcmp(fields[0], "BusyServers:") == 0) /* Apache 1.* */
536 || (strcmp(fields[0], "BusyWorkers:") == 0)) /* Apache 2.* */) {
537 submit_gauge("apache_connections", NULL, atol(fields[1]), st);
538 apache_connections_submitted++;
539 } else if (!apache_idle_workers_submitted &&
540 ((strcmp(fields[0], "IdleServers:") == 0) /* Apache 1.x */
541 ||
542 (strcmp(fields[0], "IdleWorkers:") == 0)) /* Apache 2.x */) {
543 submit_gauge("apache_idle_workers", NULL, atol(fields[1]), st);
544 apache_idle_workers_submitted++;
545 }
546 }
547 }
548
549 st->apache_buffer_fill = 0;
550
551 return 0;
552 } /* }}} int apache_read_host */
553
apache_init(void)554 static int apache_init(void) /* {{{ */
555 {
556 /* Call this while collectd is still single-threaded to avoid
557 * initialization issues in libgcrypt. */
558 curl_global_init(CURL_GLOBAL_SSL);
559 return 0;
560 } /* }}} int apache_init */
561
module_register(void)562 void module_register(void) {
563 plugin_register_complex_config("apache", config);
564 plugin_register_init("apache", apache_init);
565 } /* void module_register */
566