2 * collectd - src/apache.c
3 * Copyright (C) 2006-2009 Florian octo Forster
4 * Copyright (C) 2007 Florent EppO Monbillard
5 * Copyright (C) 2009 Amit Gupta
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.
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.
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
21 * Florian octo Forster <octo at verplant.org>
22 * Florent EppO Monbillard <eppo at darox.net>
23 * - connections/lighttpd extension
24 * Amit Gupta <amit.gupta221 at gmail.com>
30 #include "configfile.h"
32 #include <curl/curl.h>
51 char *server; /* user specific server type */
53 char apache_curl_error[CURL_ERROR_SIZE];
54 size_t apache_buffer_size;
55 size_t apache_buffer_fill;
59 typedef struct apache_s apache_t;
61 /* TODO: Remove this prototype */
62 static int apache_read_host (user_data_t *user_data);
64 static void apache_free (apache_t *st)
76 sfree (st->apache_buffer);
78 curl_easy_cleanup(st->curl);
83 static size_t apache_curl_callback (void *buf, size_t size, size_t nmemb,
86 size_t len = size * nmemb;
92 ERROR ("apache plugin: apache_curl_callback: "
93 "user_data pointer is NULL.");
100 if ((st->apache_buffer_fill + len) >= st->apache_buffer_size)
104 temp = (char *) realloc (st->apache_buffer,
105 st->apache_buffer_fill + len + 1);
108 ERROR ("apache plugin: realloc failed.");
111 st->apache_buffer = temp;
112 st->apache_buffer_size = st->apache_buffer_fill + len + 1;
115 memcpy (st->apache_buffer + st->apache_buffer_fill, (char *) buf, len);
116 st->apache_buffer_fill += len;
117 st->apache_buffer[st->apache_buffer_fill] = 0;
120 } /* int apache_curl_callback */
122 static size_t apache_header_callback (void *buf, size_t size, size_t nmemb,
125 size_t len = size * nmemb;
131 ERROR ("apache plugin: apache_header_callback: "
132 "user_data pointer is NULL.");
139 /* look for the Server header */
140 if (strncasecmp (buf, "Server: ", strlen ("Server: ")) != 0)
143 if (strstr (buf, "Apache") != NULL)
144 st->server_type = APACHE;
145 else if (strstr (buf, "lighttpd") != NULL)
146 st->server_type = LIGHTTPD;
149 const char *hdr = buf;
151 hdr += strlen ("Server: ");
152 NOTICE ("apache plugin: Unknown server software: %s", hdr);
156 } /* apache_header_callback */
158 /* Configuration handling functiions
160 * <Instance "instance_name">
166 static int config_set_string (char **ret_string, /* {{{ */
171 if ((ci->values_num != 1)
172 || (ci->values[0].type != OCONFIG_TYPE_STRING))
174 WARNING ("apache plugin: The `%s' config option "
175 "needs exactly one string argument.", ci->key);
179 string = strdup (ci->values[0].value.string);
182 ERROR ("apache plugin: strdup failed.");
186 if (*ret_string != NULL)
188 *ret_string = string;
191 } /* }}} int config_set_string */
193 static int config_set_boolean (int *ret_boolean, /* {{{ */
196 if ((ci->values_num != 1)
197 || ((ci->values[0].type != OCONFIG_TYPE_BOOLEAN)
198 && (ci->values[0].type != OCONFIG_TYPE_STRING)))
200 WARNING ("apache plugin: The `%s' config option "
201 "needs exactly one boolean argument.", ci->key);
205 if (ci->values[0].type == OCONFIG_TYPE_BOOLEAN)
207 if (ci->values[0].value.boolean)
212 else /* if (ci->values[0].type != OCONFIG_TYPE_STRING) */
214 char *string = ci->values[0].value.string;
215 if (IS_TRUE (string))
217 else if (IS_FALSE (string))
221 ERROR ("apache plugin: Cannot parse string "
222 "as boolean value: %s", string);
228 } /* }}} int config_set_boolean */
230 static int config_add (oconfig_item_t *ci)
236 if ((ci->values_num != 1)
237 || (ci->values[0].type != OCONFIG_TYPE_STRING))
239 WARNING ("apache plugin: The `%s' config option "
240 "needs exactly one string argument.", ci->key);
244 st = (apache_t *) malloc (sizeof (*st));
247 ERROR ("apache plugin: malloc failed.");
251 memset (st, 0, sizeof (*st));
253 status = config_set_string (&st->name, ci);
259 assert (st->name != NULL);
261 for (i = 0; i < ci->children_num; i++)
263 oconfig_item_t *child = ci->children + i;
265 if (strcasecmp ("URL", child->key) == 0)
266 status = config_set_string (&st->url, child);
267 else if (strcasecmp ("Host", child->key) == 0)
268 status = config_set_string (&st->host, child);
269 else if (strcasecmp ("User", child->key) == 0)
270 status = config_set_string (&st->user, child);
271 else if (strcasecmp ("Password", child->key) == 0)
272 status = config_set_string (&st->pass, child);
273 else if (strcasecmp ("VerifyPeer", child->key) == 0)
274 status = config_set_boolean (&st->verify_peer, child);
275 else if (strcasecmp ("VerifyHost", child->key) == 0)
276 status = config_set_boolean (&st->verify_host, child);
277 else if (strcasecmp ("CACert", child->key) == 0)
278 status = config_set_string (&st->cacert, child);
279 else if (strcasecmp ("Server", child->key) == 0)
280 status = config_set_string (&st->server, child);
283 WARNING ("apache plugin: Option `%s' not allowed here.",
292 /* Check if struct is complete.. */
293 if ((status == 0) && (st->url == NULL))
295 ERROR ("apache plugin: Instance `%s': "
296 "No URL has been configured.",
304 char callback_name[3*DATA_MAX_NAME_LEN];
306 memset (&ud, 0, sizeof (ud));
308 ud.free_func = (void *) apache_free;
310 memset (callback_name, 0, sizeof (callback_name));
311 ssnprintf (callback_name, sizeof (callback_name),
313 (st->host != NULL) ? st->host : hostname_g,
314 (st->name != NULL) ? st->name : "default"),
316 status = plugin_register_complex_read (/* group = */ NULL,
317 /* name = */ callback_name,
318 /* callback = */ apache_read_host,
319 /* interval = */ NULL,
320 /* user_data = */ &ud);
330 } /* int config_add */
332 static int config (oconfig_item_t *ci)
336 oconfig_item_t *lci = NULL; /* legacy config */
338 for (i = 0; i < ci->children_num; i++)
340 oconfig_item_t *child = ci->children + i;
342 if (strcasecmp ("Instance", child->key) == 0 && child->children_num > 0)
346 /* legacy mode - convert to <Instance ...> config */
349 lci = malloc (sizeof(*lci));
352 ERROR ("apache plugin: malloc failed.");
355 memset (lci, '\0', sizeof (*lci));
360 realloc (lci->children,
361 lci->children_num * sizeof (*child));
362 if (lci->children == NULL)
364 ERROR ("apache plugin: realloc failed.");
367 memcpy (&lci->children[lci->children_num-1], child, sizeof (*child));
369 } /* for (ci->children) */
373 /* create a <Instance ""> entry */
374 lci->key = "Instance";
376 lci->values = (oconfig_value_t *) malloc (lci->values_num * sizeof (oconfig_value_t));
377 lci->values[0].type = OCONFIG_TYPE_STRING;
378 lci->values[0].value.string = "";
380 status = config_add (lci);
382 sfree (lci->children);
389 /* initialize curl for each host */
390 static int init_host (apache_t *st) /* {{{ */
392 static char credentials[1024];
394 assert (st->url != NULL);
395 /* (Assured by `config_add') */
397 if (st->curl != NULL)
399 curl_easy_cleanup (st->curl);
403 if ((st->curl = curl_easy_init ()) == NULL)
405 ERROR ("apache plugin: init_host: `curl_easy_init' failed.");
409 curl_easy_setopt (st->curl, CURLOPT_WRITEFUNCTION, apache_curl_callback);
410 curl_easy_setopt (st->curl, CURLOPT_WRITEDATA, st);
412 /* not set as yet if the user specified string doesn't match apache or
413 * lighttpd, then ignore it. Headers will be parsed to find out the
415 st->server_type = -1;
417 if (st->server != NULL)
419 if (strcasecmp(st->server, "apache") == 0)
420 st->server_type = APACHE;
421 else if (strcasecmp(st->server, "lighttpd") == 0)
422 st->server_type = LIGHTTPD;
424 WARNING ("apache plugin: Unknown `Server' setting: %s",
428 /* if not found register a header callback to determine the server_type */
429 if (st->server_type == -1)
431 curl_easy_setopt (st->curl, CURLOPT_HEADERFUNCTION, apache_header_callback);
432 curl_easy_setopt (st->curl, CURLOPT_WRITEHEADER, st);
435 curl_easy_setopt (st->curl, CURLOPT_USERAGENT, PACKAGE_NAME"/"PACKAGE_VERSION);
436 curl_easy_setopt (st->curl, CURLOPT_ERRORBUFFER, st->apache_curl_error);
438 if (st->user != NULL)
442 status = ssnprintf (credentials, sizeof (credentials), "%s:%s",
443 st->user, (st->pass == NULL) ? "" : st->pass);
444 if ((status < 0) || ((size_t) status >= sizeof (credentials)))
446 ERROR ("apache plugin: init_host: Returning an error "
447 "because the credentials have been "
449 curl_easy_cleanup (st->curl);
454 curl_easy_setopt (st->curl, CURLOPT_USERPWD, credentials);
457 curl_easy_setopt (st->curl, CURLOPT_URL, st->url);
458 curl_easy_setopt (st->curl, CURLOPT_FOLLOWLOCATION, 1);
460 if (st->verify_peer != 0)
462 curl_easy_setopt (st->curl, CURLOPT_SSL_VERIFYPEER, 1);
466 curl_easy_setopt (st->curl, CURLOPT_SSL_VERIFYPEER, 0);
469 if (st->verify_host != 0)
471 curl_easy_setopt (st->curl, CURLOPT_SSL_VERIFYHOST, 2);
475 curl_easy_setopt (st->curl, CURLOPT_SSL_VERIFYHOST, 0);
478 if (st->cacert != NULL)
480 curl_easy_setopt (st->curl, CURLOPT_CAINFO, st->cacert);
484 } /* }}} int init_host */
486 static void submit_value (const char *type, const char *type_instance,
487 value_t value, apache_t *st)
489 value_list_t vl = VALUE_LIST_INIT;
494 sstrncpy (vl.host, (st->host != NULL) ? st->host : hostname_g,
497 sstrncpy (vl.plugin, "apache", sizeof (vl.plugin));
498 if (st->name != NULL)
499 sstrncpy (vl.plugin_instance, st->name,
500 sizeof (vl.plugin_instance));
502 sstrncpy (vl.type, type, sizeof (vl.type));
503 if (type_instance != NULL)
504 sstrncpy (vl.type_instance, type_instance,
505 sizeof (vl.type_instance));
507 plugin_dispatch_values (&vl);
508 } /* void submit_value */
510 static void submit_counter (const char *type, const char *type_instance,
511 counter_t c, apache_t *st)
515 submit_value (type, type_instance, v, st);
516 } /* void submit_counter */
518 static void submit_gauge (const char *type, const char *type_instance,
519 gauge_t g, apache_t *st)
523 submit_value (type, type_instance, v, st);
524 } /* void submit_gauge */
526 static void submit_scoreboard (char *buf, apache_t *st)
530 * "_" Waiting for Connection, "S" Starting up,
531 * "R" Reading Request for apache and read-POST for lighttpd,
532 * "W" Sending Reply, "K" Keepalive (read), "D" DNS Lookup,
533 * "C" Closing connection, "L" Logging, "G" Gracefully finishing,
534 * "I" Idle cleanup of worker, "." Open slot with no current process
535 * Lighttpd specific legends -
536 * "E" hard error, "." connect, "h" handle-request,
537 * "q" request-start, "Q" request-end, "s" response-start
538 * "S" response-end, "r" read
540 long long open = 0LL;
541 long long waiting = 0LL;
542 long long starting = 0LL;
543 long long reading = 0LL;
544 long long sending = 0LL;
545 long long keepalive = 0LL;
546 long long dnslookup = 0LL;
547 long long closing = 0LL;
548 long long logging = 0LL;
549 long long finishing = 0LL;
550 long long idle_cleanup = 0LL;
552 /* lighttpd specific */
553 long long hard_error = 0LL;
554 long long lighttpd_read = 0LL;
555 long long handle_request = 0LL;
556 long long request_start = 0LL;
557 long long request_end = 0LL;
558 long long response_start = 0LL;
559 long long response_end = 0LL;
562 for (i = 0; buf[i] != '\0'; i++)
564 if (buf[i] == '.') open++;
565 else if (buf[i] == '_') waiting++;
566 else if (buf[i] == 'S') starting++;
567 else if (buf[i] == 'R') reading++;
568 else if (buf[i] == 'W') sending++;
569 else if (buf[i] == 'K') keepalive++;
570 else if (buf[i] == 'D') dnslookup++;
571 else if (buf[i] == 'C') closing++;
572 else if (buf[i] == 'L') logging++;
573 else if (buf[i] == 'G') finishing++;
574 else if (buf[i] == 'I') idle_cleanup++;
575 else if (buf[i] == 'r') lighttpd_read++;
576 else if (buf[i] == 'h') handle_request++;
577 else if (buf[i] == 'E') hard_error++;
578 else if (buf[i] == 'q') request_start++;
579 else if (buf[i] == 'Q') request_end++;
580 else if (buf[i] == 's') response_start++;
581 else if (buf[i] == 'S') response_end++;
584 if (st->server_type == APACHE)
586 submit_gauge ("apache_scoreboard", "open" , open, st);
587 submit_gauge ("apache_scoreboard", "waiting" , waiting, st);
588 submit_gauge ("apache_scoreboard", "starting" , starting, st);
589 submit_gauge ("apache_scoreboard", "reading" , reading, st);
590 submit_gauge ("apache_scoreboard", "sending" , sending, st);
591 submit_gauge ("apache_scoreboard", "keepalive", keepalive, st);
592 submit_gauge ("apache_scoreboard", "dnslookup", dnslookup, st);
593 submit_gauge ("apache_scoreboard", "closing" , closing, st);
594 submit_gauge ("apache_scoreboard", "logging" , logging, st);
595 submit_gauge ("apache_scoreboard", "finishing", finishing, st);
596 submit_gauge ("apache_scoreboard", "idle_cleanup", idle_cleanup, st);
600 submit_gauge ("apache_scoreboard", "connect" , open, st);
601 submit_gauge ("apache_scoreboard", "close" , closing, st);
602 submit_gauge ("apache_scoreboard", "hard_error" , hard_error, st);
603 submit_gauge ("apache_scoreboard", "read" , lighttpd_read, st);
604 submit_gauge ("apache_scoreboard", "read_post" , reading, st);
605 submit_gauge ("apache_scoreboard", "write" , sending, st);
606 submit_gauge ("apache_scoreboard", "handle_request", handle_request, st);
607 submit_gauge ("apache_scoreboard", "request_start" , request_start, st);
608 submit_gauge ("apache_scoreboard", "request_end" , request_end, st);
609 submit_gauge ("apache_scoreboard", "response_start", response_start, st);
610 submit_gauge ("apache_scoreboard", "response_end" , response_end, st);
614 static int apache_read_host (user_data_t *user_data) /* {{{ */
628 st = user_data->data;
630 assert (st->url != NULL);
631 /* (Assured by `config_add') */
633 if (st->curl == NULL)
637 status = init_host (st);
641 assert (st->curl != NULL);
643 st->apache_buffer_fill = 0;
644 if (curl_easy_perform (st->curl) != 0)
646 ERROR ("apache: curl_easy_perform failed: %s",
647 st->apache_curl_error);
651 /* fallback - server_type to apache if not set at this time */
652 if (st->server_type == -1)
654 WARNING ("apache plugin: Unable to determine server software "
655 "automatically. Will assume Apache.");
656 st->server_type = APACHE;
659 ptr = st->apache_buffer;
661 while ((lines[lines_num] = strtok_r (ptr, "\n\r", &saveptr)) != NULL)
670 for (i = 0; i < lines_num; i++)
672 fields_num = strsplit (lines[i], fields, 4);
676 if ((strcmp (fields[0], "Total") == 0)
677 && (strcmp (fields[1], "Accesses:") == 0))
678 submit_counter ("apache_requests", "",
679 atoll (fields[2]), st);
680 else if ((strcmp (fields[0], "Total") == 0)
681 && (strcmp (fields[1], "kBytes:") == 0))
682 submit_counter ("apache_bytes", "",
683 1024LL * atoll (fields[2]), st);
685 else if (fields_num == 2)
687 if (strcmp (fields[0], "Scoreboard:") == 0)
688 submit_scoreboard (fields[1], st);
689 else if ((strcmp (fields[0], "BusyServers:") == 0) /* Apache 1.* */
690 || (strcmp (fields[0], "BusyWorkers:") == 0) /* Apache 2.* */)
691 submit_gauge ("apache_connections", NULL, atol (fields[1]), st);
692 else if ((strcmp (fields[0], "IdleServers:") == 0) /* Apache 1.x */
693 || (strcmp (fields[0], "IdleWorkers:") == 0) /* Apache 2.x */)
694 submit_gauge ("apache_idle_workers", NULL, atol (fields[1]), st);
698 st->apache_buffer_fill = 0;
701 } /* }}} int apache_read_host */
703 void module_register (void)
705 plugin_register_complex_config ("apache", config);
706 } /* void module_register */
708 /* vim: set sw=8 noet fdm=marker : */