{GPL, other}: Relicense to MIT license.
[collectd.git] / src / apache.c
index 9cec8fd..7e4c79b 100644 (file)
@@ -1,6 +1,6 @@
 /**
  * collectd - src/apache.c
- * Copyright (C) 2006-2009  Florian octo Forster
+ * Copyright (C) 2006-2010  Florian octo Forster
  * Copyright (C) 2007       Florent EppO Monbillard
  * Copyright (C) 2009       Amit Gupta
  *
@@ -18,7 +18,7 @@
  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  *
  * Authors:
- *   Florian octo Forster <octo at verplant.org>
+ *   Florian octo Forster <octo at collectd.org>
  *   Florent EppO Monbillard <eppo at darox.net>
  *   - connections/lighttpd extension
  *   Amit Gupta <amit.gupta221 at gmail.com>
 
 #include <curl/curl.h>
 
+enum server_enum
+{
+       APACHE = 0,
+       LIGHTTPD
+};
+
 struct apache_s
 {
+       int server_type;
        char *name;
        char *host;
        char *url;
@@ -41,6 +48,7 @@ struct apache_s
        int   verify_peer;
        int   verify_host;
        char *cacert;
+       char *server; /* user specific server type */
        char *apache_buffer;
        char apache_curl_error[CURL_ERROR_SIZE];
        size_t apache_buffer_size;
@@ -64,6 +72,7 @@ static void apache_free (apache_t *st)
        sfree (st->user);
        sfree (st->pass);
        sfree (st->cacert);
+       sfree (st->server);
        sfree (st->apache_buffer);
        if (st->curl) {
                curl_easy_cleanup(st->curl);
@@ -110,6 +119,44 @@ static size_t apache_curl_callback (void *buf, size_t size, size_t nmemb,
        return (len);
 } /* int apache_curl_callback */
 
+static size_t apache_header_callback (void *buf, size_t size, size_t nmemb,
+               void *user_data)
+{
+       size_t len = size * nmemb;
+       apache_t *st;
+
+       st = user_data;
+       if (st == NULL)
+       {
+               ERROR ("apache plugin: apache_header_callback: "
+                               "user_data pointer is NULL.");
+               return (0);
+       }
+
+       if (len <= 0)
+               return (len);
+
+       /* look for the Server header */
+       if (strncasecmp (buf, "Server: ", strlen ("Server: ")) != 0)
+               return (len);
+
+       if (strstr (buf, "Apache") != NULL)
+               st->server_type = APACHE;
+       else if (strstr (buf, "lighttpd") != NULL)
+               st->server_type = LIGHTTPD;
+       else if (strstr (buf, "IBM_HTTP_Server") != NULL)
+               st->server_type = APACHE;
+       else
+       {
+               const char *hdr = buf;
+
+               hdr += strlen ("Server: ");
+               NOTICE ("apache plugin: Unknown server software: %s", hdr);
+       }
+
+       return (len);
+} /* apache_header_callback */
+
 /* Configuration handling functiions
  * <Plugin apache>
  *   <Instance "instance_name">
@@ -157,7 +204,7 @@ static int config_set_boolean (int *ret_boolean, /* {{{ */
                return (-1);
        }
 
-       if (ci->values[0].type != OCONFIG_TYPE_BOOLEAN)
+       if (ci->values[0].type == OCONFIG_TYPE_BOOLEAN)
        {
                if (ci->values[0].value.boolean)
                        *ret_boolean = 1;
@@ -167,13 +214,9 @@ static int config_set_boolean (int *ret_boolean, /* {{{ */
        else /* if (ci->values[0].type != OCONFIG_TYPE_STRING) */
        {
                char *string = ci->values[0].value.string;
-               if ((strcasecmp ("true", string) == 0)
-                               || (strcasecmp ("yes", string) == 0)
-                               || (strcasecmp ("on", string) == 0))
+               if (IS_TRUE (string))
                        *ret_boolean = 1;
-               else if ((strcasecmp ("false", string) == 0)
-                               || (strcasecmp ("no", string) == 0)
-                               || (strcasecmp ("off", string) == 0))
+               else if (IS_FALSE (string))
                        *ret_boolean = 0;
                else
                {
@@ -235,6 +278,8 @@ static int config_add (oconfig_item_t *ci)
                        status = config_set_boolean (&st->verify_host, child);
                else if (strcasecmp ("CACert", child->key) == 0)
                        status = config_set_string (&st->cacert, child);
+               else if (strcasecmp ("Server", child->key) == 0)
+                       status = config_set_string (&st->server, child);
                else
                {
                        WARNING ("apache plugin: Option `%s' not allowed here.",
@@ -246,6 +291,15 @@ static int config_add (oconfig_item_t *ci)
                        break;
        }
 
+       /* Check if struct is complete.. */
+       if ((status == 0) && (st->url == NULL))
+       {
+               ERROR ("apache plugin: Instance `%s': "
+                               "No URL has been configured.",
+                               st->name);
+               status = -1;
+       }
+
        if (status == 0)
        {
                user_data_t ud;
@@ -261,7 +315,8 @@ static int config_add (oconfig_item_t *ci)
                                (st->host != NULL) ? st->host : hostname_g,
                                (st->name != NULL) ? st->name : "default"),
 
-               status = plugin_register_complex_read (callback_name,
+               status = plugin_register_complex_read (/* group = */ NULL,
+                               /* name      = */ callback_name,
                                /* callback  = */ apache_read_host,
                                /* interval  = */ NULL,
                                /* user_data = */ &ud);
@@ -280,57 +335,22 @@ static int config (oconfig_item_t *ci)
 {
        int status = 0;
        int i;
-       oconfig_item_t *lci = NULL; /* legacy config */
 
        for (i = 0; i < ci->children_num; i++)
        {
                oconfig_item_t *child = ci->children + i;
 
-               if (strcasecmp ("Instance", child->key) == 0 && child->children_num > 0)
+               if (strcasecmp ("Instance", child->key) == 0)
                        config_add (child);
                else
-               {
-                       /* legacy mode - convert to <Instance ...> config */
-                       if (lci == NULL)
-                       {
-                               lci = malloc (sizeof(*lci));
-                               if (lci == NULL)
-                               {
-                                       ERROR ("apache plugin: malloc failed.");
-                                       return (-1);
-                               }
-                               memset (lci, '\0', sizeof (*lci));
-                       }
-
-                       lci->children_num++;
-                       lci->children =
-                               realloc (lci->children,
-                                        lci->children_num * sizeof (*child));
-                       if (lci->children == NULL)
-                       {
-                               ERROR ("apache plugin: realloc failed.");
-                               return (-1);
-                       }
-                       memcpy (&lci->children[lci->children_num-1], child, sizeof (*child));
-               }
+                       WARNING ("apache plugin: The configuration option "
+                                       "\"%s\" is not allowed here. Did you "
+                                       "forget to add an <Instance /> block "
+                                       "around the configuration?",
+                                       child->key);
        } /* for (ci->children) */
 
-       if (lci)
-       {
-               /* create a <Instance ""> entry */
-               lci->key = "Instance";
-               lci->values_num = 1;
-               lci->values = (oconfig_value_t *) malloc (lci->values_num * sizeof (oconfig_value_t));
-               lci->values[0].type = OCONFIG_TYPE_STRING;
-               lci->values[0].value.string = "";
-
-               status = config_add (lci);
-               sfree (lci->values);
-               sfree (lci->children);
-               sfree (lci);
-       }
-
-       return status;
+       return (status);
 } /* int config */
 
 /* initialize curl for each host */
@@ -338,16 +358,13 @@ static int init_host (apache_t *st) /* {{{ */
 {
        static char credentials[1024];
 
-       if (st->url == NULL)
-       {
-               WARNING ("apache plugin: init_host: No URL configured, returning "
-                               "an error.");
-               return (-1);
-       }
+       assert (st->url != NULL);
+       /* (Assured by `config_add') */
 
        if (st->curl != NULL)
        {
                curl_easy_cleanup (st->curl);
+               st->curl = NULL;
        }
 
        if ((st->curl = curl_easy_init ()) == NULL)
@@ -356,9 +373,36 @@ static int init_host (apache_t *st) /* {{{ */
                return (-1);
        }
 
+       curl_easy_setopt (st->curl, CURLOPT_NOSIGNAL, 1L);
        curl_easy_setopt (st->curl, CURLOPT_WRITEFUNCTION, apache_curl_callback);
        curl_easy_setopt (st->curl, CURLOPT_WRITEDATA, st);
-       curl_easy_setopt (st->curl, CURLOPT_USERAGENT, PACKAGE_NAME"/"PACKAGE_VERSION);
+
+       /* not set as yet if the user specified string doesn't match apache or
+        * lighttpd, then ignore it. Headers will be parsed to find out the
+        * server type */
+       st->server_type = -1;
+
+       if (st->server != NULL)
+       {
+               if (strcasecmp(st->server, "apache") == 0)
+                       st->server_type = APACHE;
+               else if (strcasecmp(st->server, "lighttpd") == 0)
+                       st->server_type = LIGHTTPD;
+               else if (strcasecmp(st->server, "ibm_http_server") == 0)
+                       st->server_type = APACHE;
+               else
+                       WARNING ("apache plugin: Unknown `Server' setting: %s",
+                                       st->server);
+       }
+
+       /* if not found register a header callback to determine the server_type */
+       if (st->server_type == -1)
+       {
+               curl_easy_setopt (st->curl, CURLOPT_HEADERFUNCTION, apache_header_callback);
+               curl_easy_setopt (st->curl, CURLOPT_WRITEHEADER, st);
+       }
+
+       curl_easy_setopt (st->curl, CURLOPT_USERAGENT, COLLECTD_USERAGENT);
        curl_easy_setopt (st->curl, CURLOPT_ERRORBUFFER, st->apache_curl_error);
 
        if (st->user != NULL)
@@ -381,23 +425,25 @@ static int init_host (apache_t *st) /* {{{ */
        }
 
        curl_easy_setopt (st->curl, CURLOPT_URL, st->url);
+       curl_easy_setopt (st->curl, CURLOPT_FOLLOWLOCATION, 1L);
+       curl_easy_setopt (st->curl, CURLOPT_MAXREDIRS, 50L);
 
        if (st->verify_peer != 0)
        {
-               curl_easy_setopt (st->curl, CURLOPT_SSL_VERIFYPEER, 1);
+               curl_easy_setopt (st->curl, CURLOPT_SSL_VERIFYPEER, 1L);
        }
        else
        {
-               curl_easy_setopt (st->curl, CURLOPT_SSL_VERIFYPEER, 0);
+               curl_easy_setopt (st->curl, CURLOPT_SSL_VERIFYPEER, 0L);
        }
 
        if (st->verify_host != 0)
        {
-               curl_easy_setopt (st->curl, CURLOPT_SSL_VERIFYHOST, 2);
+               curl_easy_setopt (st->curl, CURLOPT_SSL_VERIFYHOST, 2L);
        }
        else
        {
-               curl_easy_setopt (st->curl, CURLOPT_SSL_VERIFYHOST, 0);
+               curl_easy_setopt (st->curl, CURLOPT_SSL_VERIFYHOST, 0L);
        }
 
        if (st->cacert != NULL)
@@ -432,13 +478,13 @@ static void submit_value (const char *type, const char *type_instance,
        plugin_dispatch_values (&vl);
 } /* void submit_value */
 
-static void submit_counter (const char *type, const char *type_instance,
-               counter_t c, apache_t *st)
+static void submit_derive (const char *type, const char *type_instance,
+               derive_t c, apache_t *st)
 {
        value_t v;
-       v.counter = c;
+       v.derive = c;
        submit_value (type, type_instance, v, st);
-} /* void submit_counter */
+} /* void submit_derive */
 
 static void submit_gauge (const char *type, const char *type_instance,
                gauge_t g, apache_t *st)
@@ -452,10 +498,15 @@ static void submit_scoreboard (char *buf, apache_t *st)
 {
        /*
         * Scoreboard Key:
-        * "_" Waiting for Connection, "S" Starting up, "R" Reading Request,
+        * "_" Waiting for Connection, "S" Starting up,
+        * "R" Reading Request for apache and read-POST for lighttpd,
         * "W" Sending Reply, "K" Keepalive (read), "D" DNS Lookup,
         * "C" Closing connection, "L" Logging, "G" Gracefully finishing,
         * "I" Idle cleanup of worker, "." Open slot with no current process
+        * Lighttpd specific legends -
+        * "E" hard error, "." connect, "h" handle-request,
+        * "q" request-start, "Q" request-end, "s" response-start
+        * "S" response-end, "r" read
         */
        long long open      = 0LL;
        long long waiting   = 0LL;
@@ -469,8 +520,16 @@ static void submit_scoreboard (char *buf, apache_t *st)
        long long finishing = 0LL;
        long long idle_cleanup = 0LL;
 
-       int i;
+       /* lighttpd specific */
+       long long hard_error     = 0LL;
+       long long lighttpd_read  = 0LL;
+       long long handle_request = 0LL;
+       long long request_start  = 0LL;
+       long long request_end    = 0LL;
+       long long response_start = 0LL;
+       long long response_end   = 0LL;
 
+       int i;
        for (i = 0; buf[i] != '\0'; i++)
        {
                if (buf[i] == '.') open++;
@@ -484,19 +543,43 @@ static void submit_scoreboard (char *buf, apache_t *st)
                else if (buf[i] == 'L') logging++;
                else if (buf[i] == 'G') finishing++;
                else if (buf[i] == 'I') idle_cleanup++;
+               else if (buf[i] == 'r') lighttpd_read++;
+               else if (buf[i] == 'h') handle_request++;
+               else if (buf[i] == 'E') hard_error++;
+               else if (buf[i] == 'q') request_start++;
+               else if (buf[i] == 'Q') request_end++;
+               else if (buf[i] == 's') response_start++;
+               else if (buf[i] == 'S') response_end++;
        }
 
-       submit_gauge ("apache_scoreboard", "open"     , open, st);
-       submit_gauge ("apache_scoreboard", "waiting"  , waiting, st);
-       submit_gauge ("apache_scoreboard", "starting" , starting, st);
-       submit_gauge ("apache_scoreboard", "reading"  , reading, st);
-       submit_gauge ("apache_scoreboard", "sending"  , sending, st);
-       submit_gauge ("apache_scoreboard", "keepalive", keepalive, st);
-       submit_gauge ("apache_scoreboard", "dnslookup", dnslookup, st);
-       submit_gauge ("apache_scoreboard", "closing"  , closing, st);
-       submit_gauge ("apache_scoreboard", "logging"  , logging, st);
-       submit_gauge ("apache_scoreboard", "finishing", finishing, st);
-       submit_gauge ("apache_scoreboard", "idle_cleanup", idle_cleanup, st);
+       if (st->server_type == APACHE)
+       {
+               submit_gauge ("apache_scoreboard", "open"     , open, st);
+               submit_gauge ("apache_scoreboard", "waiting"  , waiting, st);
+               submit_gauge ("apache_scoreboard", "starting" , starting, st);
+               submit_gauge ("apache_scoreboard", "reading"  , reading, st);
+               submit_gauge ("apache_scoreboard", "sending"  , sending, st);
+               submit_gauge ("apache_scoreboard", "keepalive", keepalive, st);
+               submit_gauge ("apache_scoreboard", "dnslookup", dnslookup, st);
+               submit_gauge ("apache_scoreboard", "closing"  , closing, st);
+               submit_gauge ("apache_scoreboard", "logging"  , logging, st);
+               submit_gauge ("apache_scoreboard", "finishing", finishing, st);
+               submit_gauge ("apache_scoreboard", "idle_cleanup", idle_cleanup, st);
+       }
+       else
+       {
+               submit_gauge ("apache_scoreboard", "connect"       , open, st);
+               submit_gauge ("apache_scoreboard", "close"         , closing, st);
+               submit_gauge ("apache_scoreboard", "hard_error"    , hard_error, st);
+               submit_gauge ("apache_scoreboard", "read"          , lighttpd_read, st);
+               submit_gauge ("apache_scoreboard", "read_post"     , reading, st);
+               submit_gauge ("apache_scoreboard", "write"         , sending, st);
+               submit_gauge ("apache_scoreboard", "handle_request", handle_request, st);
+               submit_gauge ("apache_scoreboard", "request_start" , request_start, st);
+               submit_gauge ("apache_scoreboard", "request_end"   , request_end, st);
+               submit_gauge ("apache_scoreboard", "response_start", response_start, st);
+               submit_gauge ("apache_scoreboard", "response_end"  , response_end, st);
+       }
 }
 
 static int apache_read_host (user_data_t *user_data) /* {{{ */
@@ -515,6 +598,9 @@ static int apache_read_host (user_data_t *user_data) /* {{{ */
 
        st = user_data->data;
 
+       assert (st->url != NULL);
+       /* (Assured by `config_add') */
+
        if (st->curl == NULL)
        {
                int status;
@@ -525,17 +611,22 @@ static int apache_read_host (user_data_t *user_data) /* {{{ */
        }
        assert (st->curl != NULL);
 
-       if (st->url == NULL)
-               return (-1);
-
        st->apache_buffer_fill = 0;
-       if (curl_easy_perform (st->curl) != 0)
+       if (curl_easy_perform (st->curl) != CURLE_OK)
        {
                ERROR ("apache: curl_easy_perform failed: %s",
                                st->apache_curl_error);
                return (-1);
        }
 
+       /* fallback - server_type to apache if not set at this time */
+       if (st->server_type == -1)
+       {
+               WARNING ("apache plugin: Unable to determine server software "
+                               "automatically. Will assume Apache.");
+               st->server_type = APACHE;
+       }
+
        ptr = st->apache_buffer;
        saveptr = NULL;
        while ((lines[lines_num] = strtok_r (ptr, "\n\r", &saveptr)) != NULL)
@@ -555,19 +646,23 @@ static int apache_read_host (user_data_t *user_data) /* {{{ */
                {
                        if ((strcmp (fields[0], "Total") == 0)
                                        && (strcmp (fields[1], "Accesses:") == 0))
-                               submit_counter ("apache_requests", "",
+                               submit_derive ("apache_requests", "",
                                                atoll (fields[2]), st);
                        else if ((strcmp (fields[0], "Total") == 0)
                                        && (strcmp (fields[1], "kBytes:") == 0))
-                               submit_counter ("apache_bytes", "",
+                               submit_derive ("apache_bytes", "",
                                                1024LL * atoll (fields[2]), st);
                }
                else if (fields_num == 2)
                {
                        if (strcmp (fields[0], "Scoreboard:") == 0)
                                submit_scoreboard (fields[1], st);
-                       else if (strcmp (fields[0], "BusyServers:") == 0)
+                       else if ((strcmp (fields[0], "BusyServers:") == 0) /* Apache 1.* */
+                                       || (strcmp (fields[0], "BusyWorkers:") == 0) /* Apache 2.* */)
                                submit_gauge ("apache_connections", NULL, atol (fields[1]), st);
+                       else if ((strcmp (fields[0], "IdleServers:") == 0) /* Apache 1.x */
+                                       || (strcmp (fields[0], "IdleWorkers:") == 0) /* Apache 2.x */)
+                               submit_gauge ("apache_idle_workers", NULL, atol (fields[1]), st);
                }
        }