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