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
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 collectd.org>
22 * Florent EppO Monbillard <eppo at darox.net>
23 * - connections/lighttpd extension
24 * Amit Gupta <amit.gupta221 at gmail.com>
32 #include <curl/curl.h>
34 enum server_enum { APACHE = 0, LIGHTTPD };
47 char *server; /* user specific server type */
49 char apache_curl_error[CURL_ERROR_SIZE];
50 size_t apache_buffer_size;
51 size_t apache_buffer_fill;
56 typedef struct apache_s apache_t;
58 /* TODO: Remove this prototype */
59 static int apache_read_host(user_data_t *user_data);
61 static void apache_free(void *arg) {
73 sfree(st->ssl_ciphers);
75 sfree(st->apache_buffer);
77 curl_easy_cleanup(st->curl);
83 static size_t apache_curl_callback(void *buf, size_t size, size_t nmemb,
85 size_t len = size * nmemb;
90 ERROR("apache plugin: apache_curl_callback: "
91 "user_data pointer is NULL.");
98 if ((st->apache_buffer_fill + len) >= st->apache_buffer_size) {
101 temp = realloc(st->apache_buffer, st->apache_buffer_fill + len + 1);
103 ERROR("apache plugin: realloc failed.");
106 st->apache_buffer = temp;
107 st->apache_buffer_size = st->apache_buffer_fill + len + 1;
110 memcpy(st->apache_buffer + st->apache_buffer_fill, (char *)buf, len);
111 st->apache_buffer_fill += len;
112 st->apache_buffer[st->apache_buffer_fill] = 0;
115 } /* int apache_curl_callback */
117 static size_t apache_header_callback(void *buf, size_t size, size_t nmemb,
119 size_t len = size * nmemb;
124 ERROR("apache plugin: apache_header_callback: "
125 "user_data pointer is NULL.");
132 /* look for the Server header */
133 if (strncasecmp(buf, "Server: ", strlen("Server: ")) != 0)
136 if (strstr(buf, "Apache") != NULL)
137 st->server_type = APACHE;
138 else if (strstr(buf, "lighttpd") != NULL)
139 st->server_type = LIGHTTPD;
140 else if (strstr(buf, "IBM_HTTP_Server") != NULL)
141 st->server_type = APACHE;
143 const char *hdr = buf;
145 hdr += strlen("Server: ");
146 NOTICE("apache plugin: Unknown server software: %s", hdr);
150 } /* apache_header_callback */
152 /* Configuration handling functiions
154 * <Instance "instance_name">
160 static int config_add(oconfig_item_t *ci) {
164 st = calloc(1, sizeof(*st));
166 ERROR("apache plugin: calloc failed.");
172 status = cf_util_get_string(ci, &st->name);
177 assert(st->name != NULL);
179 for (int i = 0; i < ci->children_num; i++) {
180 oconfig_item_t *child = ci->children + i;
182 if (strcasecmp("URL", child->key) == 0)
183 status = cf_util_get_string(child, &st->url);
184 else if (strcasecmp("Host", child->key) == 0)
185 status = cf_util_get_string(child, &st->host);
186 else if (strcasecmp("User", child->key) == 0)
187 status = cf_util_get_string(child, &st->user);
188 else if (strcasecmp("Password", child->key) == 0)
189 status = cf_util_get_string(child, &st->pass);
190 else if (strcasecmp("VerifyPeer", child->key) == 0)
191 status = cf_util_get_boolean(child, &st->verify_peer);
192 else if (strcasecmp("VerifyHost", child->key) == 0)
193 status = cf_util_get_boolean(child, &st->verify_host);
194 else if (strcasecmp("CACert", child->key) == 0)
195 status = cf_util_get_string(child, &st->cacert);
196 else if (strcasecmp("SSLCiphers", child->key) == 0)
197 status = cf_util_get_string(child, &st->ssl_ciphers);
198 else if (strcasecmp("Server", child->key) == 0)
199 status = cf_util_get_string(child, &st->server);
200 else if (strcasecmp("Timeout", child->key) == 0)
201 status = cf_util_get_int(child, &st->timeout);
203 WARNING("apache plugin: Option `%s' not allowed here.", child->key);
211 /* Check if struct is complete.. */
212 if ((status == 0) && (st->url == NULL)) {
213 ERROR("apache plugin: Instance `%s': "
214 "No URL has been configured.",
220 char callback_name[3 * DATA_MAX_NAME_LEN];
222 ssnprintf(callback_name, sizeof(callback_name), "apache/%s/%s",
223 (st->host != NULL) ? st->host : hostname_g,
224 (st->name != NULL) ? st->name : "default");
226 status = plugin_register_complex_read(
228 /* name = */ callback_name,
229 /* callback = */ apache_read_host,
230 /* interval = */ 0, &(user_data_t){
231 .data = st, .free_func = apache_free,
241 } /* int config_add */
243 static int config(oconfig_item_t *ci) {
246 for (int i = 0; i < ci->children_num; i++) {
247 oconfig_item_t *child = ci->children + i;
249 if (strcasecmp("Instance", child->key) == 0)
252 WARNING("apache plugin: The configuration option "
253 "\"%s\" is not allowed here. Did you "
254 "forget to add an <Instance /> block "
255 "around the configuration?",
257 } /* for (ci->children) */
262 /* initialize curl for each host */
263 static int init_host(apache_t *st) /* {{{ */
265 assert(st->url != NULL);
266 /* (Assured by `config_add') */
268 if (st->curl != NULL) {
269 curl_easy_cleanup(st->curl);
273 if ((st->curl = curl_easy_init()) == NULL) {
274 ERROR("apache plugin: init_host: `curl_easy_init' failed.");
278 curl_easy_setopt(st->curl, CURLOPT_NOSIGNAL, 1L);
279 curl_easy_setopt(st->curl, CURLOPT_WRITEFUNCTION, apache_curl_callback);
280 curl_easy_setopt(st->curl, CURLOPT_WRITEDATA, st);
282 /* not set as yet if the user specified string doesn't match apache or
283 * lighttpd, then ignore it. Headers will be parsed to find out the
285 st->server_type = -1;
287 if (st->server != NULL) {
288 if (strcasecmp(st->server, "apache") == 0)
289 st->server_type = APACHE;
290 else if (strcasecmp(st->server, "lighttpd") == 0)
291 st->server_type = LIGHTTPD;
292 else if (strcasecmp(st->server, "ibm_http_server") == 0)
293 st->server_type = APACHE;
295 WARNING("apache plugin: Unknown `Server' setting: %s", st->server);
298 /* if not found register a header callback to determine the server_type */
299 if (st->server_type == -1) {
300 curl_easy_setopt(st->curl, CURLOPT_HEADERFUNCTION, apache_header_callback);
301 curl_easy_setopt(st->curl, CURLOPT_WRITEHEADER, st);
304 curl_easy_setopt(st->curl, CURLOPT_USERAGENT, COLLECTD_USERAGENT);
305 curl_easy_setopt(st->curl, CURLOPT_ERRORBUFFER, st->apache_curl_error);
307 if (st->user != NULL) {
308 #ifdef HAVE_CURLOPT_USERNAME
309 curl_easy_setopt(st->curl, CURLOPT_USERNAME, st->user);
310 curl_easy_setopt(st->curl, CURLOPT_PASSWORD,
311 (st->pass == NULL) ? "" : st->pass);
313 static char credentials[1024];
316 status = ssnprintf(credentials, sizeof(credentials), "%s:%s", st->user,
317 (st->pass == NULL) ? "" : st->pass);
318 if ((status < 0) || ((size_t)status >= sizeof(credentials))) {
319 ERROR("apache plugin: init_host: Returning an error "
320 "because the credentials have been "
322 curl_easy_cleanup(st->curl);
327 curl_easy_setopt(st->curl, CURLOPT_USERPWD, credentials);
331 curl_easy_setopt(st->curl, CURLOPT_URL, st->url);
332 curl_easy_setopt(st->curl, CURLOPT_FOLLOWLOCATION, 1L);
333 curl_easy_setopt(st->curl, CURLOPT_MAXREDIRS, 50L);
335 curl_easy_setopt(st->curl, CURLOPT_SSL_VERIFYPEER, (long)st->verify_peer);
336 curl_easy_setopt(st->curl, CURLOPT_SSL_VERIFYHOST, st->verify_host ? 2L : 0L);
337 if (st->cacert != NULL)
338 curl_easy_setopt(st->curl, CURLOPT_CAINFO, st->cacert);
339 if (st->ssl_ciphers != NULL)
340 curl_easy_setopt(st->curl, CURLOPT_SSL_CIPHER_LIST, st->ssl_ciphers);
342 #ifdef HAVE_CURLOPT_TIMEOUT_MS
343 if (st->timeout >= 0)
344 curl_easy_setopt(st->curl, CURLOPT_TIMEOUT_MS, (long)st->timeout);
346 curl_easy_setopt(st->curl, CURLOPT_TIMEOUT_MS,
347 (long)CDTIME_T_TO_MS(plugin_get_interval()));
351 } /* }}} int init_host */
353 static void submit_value(const char *type, const char *type_instance,
354 value_t value, apache_t *st) {
355 value_list_t vl = VALUE_LIST_INIT;
360 if (st->host != NULL)
361 sstrncpy(vl.host, st->host, sizeof(vl.host));
363 sstrncpy(vl.plugin, "apache", sizeof(vl.plugin));
364 if (st->name != NULL)
365 sstrncpy(vl.plugin_instance, st->name, sizeof(vl.plugin_instance));
367 sstrncpy(vl.type, type, sizeof(vl.type));
368 if (type_instance != NULL)
369 sstrncpy(vl.type_instance, type_instance, sizeof(vl.type_instance));
371 plugin_dispatch_values(&vl);
372 } /* void submit_value */
374 static void submit_derive(const char *type, const char *type_instance,
375 derive_t d, apache_t *st) {
376 submit_value(type, type_instance, (value_t){.derive = d}, st);
377 } /* void submit_derive */
379 static void submit_gauge(const char *type, const char *type_instance, gauge_t g,
381 submit_value(type, type_instance, (value_t){.gauge = g}, st);
382 } /* void submit_gauge */
384 static void submit_scoreboard(char *buf, apache_t *st) {
387 * "_" Waiting for Connection, "S" Starting up,
388 * "R" Reading Request for apache and read-POST for lighttpd,
389 * "W" Sending Reply, "K" Keepalive (read), "D" DNS Lookup,
390 * "C" Closing connection, "L" Logging, "G" Gracefully finishing,
391 * "I" Idle cleanup of worker, "." Open slot with no current process
392 * Lighttpd specific legends -
393 * "E" hard error, "." connect, "h" handle-request,
394 * "q" request-start, "Q" request-end, "s" response-start
395 * "S" response-end, "r" read
397 long long open = 0LL;
398 long long waiting = 0LL;
399 long long starting = 0LL;
400 long long reading = 0LL;
401 long long sending = 0LL;
402 long long keepalive = 0LL;
403 long long dnslookup = 0LL;
404 long long closing = 0LL;
405 long long logging = 0LL;
406 long long finishing = 0LL;
407 long long idle_cleanup = 0LL;
409 /* lighttpd specific */
410 long long hard_error = 0LL;
411 long long lighttpd_read = 0LL;
412 long long handle_request = 0LL;
413 long long request_start = 0LL;
414 long long request_end = 0LL;
415 long long response_start = 0LL;
416 long long response_end = 0LL;
418 for (int i = 0; buf[i] != '\0'; i++) {
421 else if (buf[i] == '_')
423 else if (buf[i] == 'S')
425 else if (buf[i] == 'R')
427 else if (buf[i] == 'W')
429 else if (buf[i] == 'K')
431 else if (buf[i] == 'D')
433 else if (buf[i] == 'C')
435 else if (buf[i] == 'L')
437 else if (buf[i] == 'G')
439 else if (buf[i] == 'I')
441 else if (buf[i] == 'r')
443 else if (buf[i] == 'h')
445 else if (buf[i] == 'E')
447 else if (buf[i] == 'q')
449 else if (buf[i] == 'Q')
451 else if (buf[i] == 's')
453 else if (buf[i] == 'S')
457 if (st->server_type == APACHE) {
458 submit_gauge("apache_scoreboard", "open", open, st);
459 submit_gauge("apache_scoreboard", "waiting", waiting, st);
460 submit_gauge("apache_scoreboard", "starting", starting, st);
461 submit_gauge("apache_scoreboard", "reading", reading, st);
462 submit_gauge("apache_scoreboard", "sending", sending, st);
463 submit_gauge("apache_scoreboard", "keepalive", keepalive, st);
464 submit_gauge("apache_scoreboard", "dnslookup", dnslookup, st);
465 submit_gauge("apache_scoreboard", "closing", closing, st);
466 submit_gauge("apache_scoreboard", "logging", logging, st);
467 submit_gauge("apache_scoreboard", "finishing", finishing, st);
468 submit_gauge("apache_scoreboard", "idle_cleanup", idle_cleanup, st);
470 submit_gauge("apache_scoreboard", "connect", open, st);
471 submit_gauge("apache_scoreboard", "close", closing, st);
472 submit_gauge("apache_scoreboard", "hard_error", hard_error, st);
473 submit_gauge("apache_scoreboard", "read", lighttpd_read, st);
474 submit_gauge("apache_scoreboard", "read_post", reading, st);
475 submit_gauge("apache_scoreboard", "write", sending, st);
476 submit_gauge("apache_scoreboard", "handle_request", handle_request, st);
477 submit_gauge("apache_scoreboard", "request_start", request_start, st);
478 submit_gauge("apache_scoreboard", "request_end", request_end, st);
479 submit_gauge("apache_scoreboard", "response_start", response_start, st);
480 submit_gauge("apache_scoreboard", "response_end", response_end, st);
484 static int apache_read_host(user_data_t *user_data) /* {{{ */
495 st = user_data->data;
500 static const char *text_plain = "text/plain";
502 assert(st->url != NULL);
503 /* (Assured by `config_add') */
505 if (st->curl == NULL) {
506 status = init_host(st);
510 assert(st->curl != NULL);
512 st->apache_buffer_fill = 0;
513 if (curl_easy_perform(st->curl) != CURLE_OK) {
514 ERROR("apache: curl_easy_perform failed: %s", st->apache_curl_error);
518 /* fallback - server_type to apache if not set at this time */
519 if (st->server_type == -1) {
520 WARNING("apache plugin: Unable to determine server software "
521 "automatically. Will assume Apache.");
522 st->server_type = APACHE;
525 status = curl_easy_getinfo(st->curl, CURLINFO_CONTENT_TYPE, &content_type);
526 if ((status == CURLE_OK) && (content_type != NULL) &&
527 (strncasecmp(content_type, text_plain, strlen(text_plain)) != 0)) {
528 WARNING("apache plugin: `Content-Type' response header is not `%s' "
529 "(received: `%s'). Expecting unparseable data. Please check `URL' "
530 "parameter (missing `?auto' suffix ?)",
531 text_plain, content_type);
534 ptr = st->apache_buffer;
536 while ((line = strtok_r(ptr, "\n\r", &saveptr)) != NULL) {
538 fields_num = strsplit(line, fields, STATIC_ARRAY_SIZE(fields));
540 if (fields_num == 3) {
541 if ((strcmp(fields[0], "Total") == 0) &&
542 (strcmp(fields[1], "Accesses:") == 0))
543 submit_derive("apache_requests", "", atoll(fields[2]), st);
544 else if ((strcmp(fields[0], "Total") == 0) &&
545 (strcmp(fields[1], "kBytes:") == 0))
546 submit_derive("apache_bytes", "", 1024LL * atoll(fields[2]), st);
547 } else if (fields_num == 2) {
548 if (strcmp(fields[0], "Scoreboard:") == 0)
549 submit_scoreboard(fields[1], st);
550 else if ((strcmp(fields[0], "BusyServers:") == 0) /* Apache 1.* */
551 || (strcmp(fields[0], "BusyWorkers:") == 0) /* Apache 2.* */)
552 submit_gauge("apache_connections", NULL, atol(fields[1]), st);
553 else if ((strcmp(fields[0], "IdleServers:") == 0) /* Apache 1.x */
554 || (strcmp(fields[0], "IdleWorkers:") == 0) /* Apache 2.x */)
555 submit_gauge("apache_idle_workers", NULL, atol(fields[1]), st);
559 st->apache_buffer_fill = 0;
562 } /* }}} int apache_read_host */
564 static int apache_init(void) /* {{{ */
566 /* Call this while collectd is still single-threaded to avoid
567 * initialization issues in libgcrypt. */
568 curl_global_init(CURL_GLOBAL_SSL);
570 } /* }}} int apache_init */
572 void module_register(void) {
573 plugin_register_complex_config("apache", config);
574 plugin_register_init("apache", apache_init);
575 } /* void module_register */