src/apache.c

   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 "common.h"
  30 #include "plugin.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
  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
  83 static size_t apache_curl_callback(void *buf, size_t size, size_t nmemb,
  84                                    void *user_data) {
  85   size_t len = size * nmemb;
  86   apache_t *st;
  87
  88   st = user_data;
  89   if (st == NULL) {
  90     ERROR("apache plugin: apache_curl_callback: "
  91           "user_data pointer is NULL.");
  92     return 0;
  93   }
  94
  95   if (len == 0)
  96     return len;
  97
  98   if ((st->apache_buffer_fill + len) >= st->apache_buffer_size) {
  99     char *temp;
 100
 101     temp = realloc(st->apache_buffer, st->apache_buffer_fill + len + 1);
 102     if (temp == NULL) {
 103       ERROR("apache plugin: realloc failed.");
 104       return 0;
 105     }
 106     st->apache_buffer = temp;
 107     st->apache_buffer_size = st->apache_buffer_fill + len + 1;
 108   }
 109
 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;
 113
 114   return len;
 115 } /* int apache_curl_callback */
 116
 117 static size_t apache_header_callback(void *buf, size_t size, size_t nmemb,
 118                                      void *user_data) {
 119   size_t len = size * nmemb;
 120   apache_t *st;
 121
 122   st = user_data;
 123   if (st == NULL) {
 124     ERROR("apache plugin: apache_header_callback: "
 125           "user_data pointer is NULL.");
 126     return 0;
 127   }
 128
 129   if (len == 0)
 130     return len;
 131
 132   /* look for the Server header */
 133   if (strncasecmp(buf, "Server: ", strlen("Server: ")) != 0)
 134     return len;
 135
 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;
 142   else {
 143     const char *hdr = buf;
 144
 145     hdr += strlen("Server: ");
 146     NOTICE("apache plugin: Unknown server software: %s", hdr);
 147   }
 148
 149   return len;
 150 } /* apache_header_callback */
 151
 152 /* Configuration handling functiions
 153  * <Plugin apache>
 154  *   <Instance "instance_name">
 155  *     URL ...
 156  *   </Instance>
 157  *   URL ...
 158  * </Plugin>
 159  */
 160 static int config_add(oconfig_item_t *ci) {
 161   apache_t *st;
 162   int status;
 163
 164   st = calloc(1, sizeof(*st));
 165   if (st == NULL) {
 166     ERROR("apache plugin: calloc failed.");
 167     return -1;
 168   }
 169
 170   st->timeout = -1;
 171
 172   status = cf_util_get_string(ci, &st->name);
 173   if (status != 0) {
 174     sfree(st);
 175     return status;
 176   }
 177   assert(st->name != NULL);
 178
 179   for (int i = 0; i < ci->children_num; i++) {
 180     oconfig_item_t *child = ci->children + i;
 181
 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);
 202     else {
 203       WARNING("apache plugin: Option `%s' not allowed here.", child->key);
 204       status = -1;
 205     }
 206
 207     if (status != 0)
 208       break;
 209   }
 210
 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.",
 215           st->name);
 216     status = -1;
 217   }
 218
 219   if (status == 0) {
 220     char callback_name[3 * DATA_MAX_NAME_LEN];
 221
 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");
 225
 226     status = plugin_register_complex_read(
 227         /* group = */ NULL,
 228         /* name      = */ callback_name,
 229         /* callback  = */ apache_read_host,
 230         /* interval  = */ 0, &(user_data_t){
 231                                  .data = st, .free_func = apache_free,
 232                              });
 233   }
 234
 235   if (status != 0) {
 236     apache_free(st);
 237     return -1;
 238   }
 239
 240   return 0;
 241 } /* int config_add */
 242
 243 static int config(oconfig_item_t *ci) {
 244   int status = 0;
 245
 246   for (int i = 0; i < ci->children_num; i++) {
 247     oconfig_item_t *child = ci->children + i;
 248
 249     if (strcasecmp("Instance", child->key) == 0)
 250       config_add(child);
 251     else
 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?",
 256               child->key);
 257   } /* for (ci->children) */
 258
 259   return status;
 260 } /* int config */
 261
 262 /* initialize curl for each host */
 263 static int init_host(apache_t *st) /* {{{ */
 264 {
 265   assert(st->url != NULL);
 266   /* (Assured by `config_add') */
 267
 268   if (st->curl != NULL) {
 269     curl_easy_cleanup(st->curl);
 270     st->curl = NULL;
 271   }
 272
 273   if ((st->curl = curl_easy_init()) == NULL) {
 274     ERROR("apache plugin: init_host: `curl_easy_init' failed.");
 275     return -1;
 276   }
 277
 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);
 281
 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
 284    * server type */
 285   st->server_type = -1;
 286
 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;
 294     else
 295       WARNING("apache plugin: Unknown `Server' setting: %s", st->server);
 296   }
 297
 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);
 302   }
 303
 304   curl_easy_setopt(st->curl, CURLOPT_USERAGENT, COLLECTD_USERAGENT);
 305   curl_easy_setopt(st->curl, CURLOPT_ERRORBUFFER, st->apache_curl_error);
 306
 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);
 312 #else
 313     static char credentials[1024];
 314     int status;
 315
 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 "
 321             "truncated.");
 322       curl_easy_cleanup(st->curl);
 323       st->curl = NULL;
 324       return -1;
 325     }
 326
 327     curl_easy_setopt(st->curl, CURLOPT_USERPWD, credentials);
 328 #endif
 329   }
 330
 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);
 334
 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);
 341
 342 #ifdef HAVE_CURLOPT_TIMEOUT_MS
 343   if (st->timeout >= 0)
 344     curl_easy_setopt(st->curl, CURLOPT_TIMEOUT_MS, (long)st->timeout);
 345   else
 346     curl_easy_setopt(st->curl, CURLOPT_TIMEOUT_MS,
 347                      (long)CDTIME_T_TO_MS(plugin_get_interval()));
 348 #endif
 349
 350   return 0;
 351 } /* }}} int init_host */
 352
 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;
 356
 357   vl.values = &value;
 358   vl.values_len = 1;
 359
 360   if (st->host != NULL)
 361     sstrncpy(vl.host, st->host, sizeof(vl.host));
 362
 363   sstrncpy(vl.plugin, "apache", sizeof(vl.plugin));
 364   if (st->name != NULL)
 365     sstrncpy(vl.plugin_instance, st->name, sizeof(vl.plugin_instance));
 366
 367   sstrncpy(vl.type, type, sizeof(vl.type));
 368   if (type_instance != NULL)
 369     sstrncpy(vl.type_instance, type_instance, sizeof(vl.type_instance));
 370
 371   plugin_dispatch_values(&vl);
 372 } /* void submit_value */
 373
 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 */
 378
 379 static void submit_gauge(const char *type, const char *type_instance, gauge_t g,
 380                          apache_t *st) {
 381   submit_value(type, type_instance, (value_t){.gauge = g}, st);
 382 } /* void submit_gauge */
 383
 384 static void submit_scoreboard(char *buf, apache_t *st) {
 385   /*
 386    * Scoreboard Key:
 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
 396    */
 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;
 408
 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;
 417
 418   for (int i = 0; buf[i] != '\0'; i++) {
 419     if (buf[i] == '.')
 420       open++;
 421     else if (buf[i] == '_')
 422       waiting++;
 423     else if (buf[i] == 'S')
 424       starting++;
 425     else if (buf[i] == 'R')
 426       reading++;
 427     else if (buf[i] == 'W')
 428       sending++;
 429     else if (buf[i] == 'K')
 430       keepalive++;
 431     else if (buf[i] == 'D')
 432       dnslookup++;
 433     else if (buf[i] == 'C')
 434       closing++;
 435     else if (buf[i] == 'L')
 436       logging++;
 437     else if (buf[i] == 'G')
 438       finishing++;
 439     else if (buf[i] == 'I')
 440       idle_cleanup++;
 441     else if (buf[i] == 'r')
 442       lighttpd_read++;
 443     else if (buf[i] == 'h')
 444       handle_request++;
 445     else if (buf[i] == 'E')
 446       hard_error++;
 447     else if (buf[i] == 'q')
 448       request_start++;
 449     else if (buf[i] == 'Q')
 450       request_end++;
 451     else if (buf[i] == 's')
 452       response_start++;
 453     else if (buf[i] == 'S')
 454       response_end++;
 455   }
 456
 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);
 469   } else {
 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);
 481   }
 482 }
 483
 484 static int apache_read_host(user_data_t *user_data) /* {{{ */
 485 {
 486   char *ptr;
 487   char *saveptr;
 488   char *line;
 489
 490   char *fields[4];
 491   int fields_num;
 492
 493   apache_t *st;
 494
 495   st = user_data->data;
 496
 497   int status;
 498
 499   char *content_type;
 500   static const char *text_plain = "text/plain";
 501
 502   assert(st->url != NULL);
 503   /* (Assured by `config_add') */
 504
 505   if (st->curl == NULL) {
 506     status = init_host(st);
 507     if (status != 0)
 508       return -1;
 509   }
 510   assert(st->curl != NULL);
 511
 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);
 515     return -1;
 516   }
 517
 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;
 523   }
 524
 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);
 532   }
 533
 534   ptr = st->apache_buffer;
 535   saveptr = NULL;
 536   while ((line = strtok_r(ptr, "\n\r", &saveptr)) != NULL) {
 537     ptr = NULL;
 538     fields_num = strsplit(line, fields, STATIC_ARRAY_SIZE(fields));
 539
 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);
 556     }
 557   }
 558
 559   st->apache_buffer_fill = 0;
 560
 561   return 0;
 562 } /* }}} int apache_read_host */
 563
 564 static int apache_init(void) /* {{{ */
 565 {
 566   /* Call this while collectd is still single-threaded to avoid
 567    * initialization issues in libgcrypt. */
 568   curl_global_init(CURL_GLOBAL_SSL);
 569   return 0;
 570 } /* }}} int apache_init */
 571
 572 void module_register(void) {
 573   plugin_register_complex_config("apache", config);
 574   plugin_register_init("apache", apache_init);
 575 } /* void module_register */