/**
* collectd - src/apache.c
- * Copyright (C) 2006-2008 Florian octo Forster
- * Copyright (C) 2007 Florent EppO Monbillard
- * Copyright (C) 2009 Amit Gupta
+ * Copyright (C) 2006-2009 Florian octo Forster
+ * Copyright (C) 2007 Florent EppO Monbillard
+ * Copyright (C) 2009 Amit Gupta
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the
#include <curl/curl.h>
-enum server_type
+enum server_enum
{
APACHE = 0,
LIGHTTPD
struct apache_s
{
+ int server_type;
char *name;
char *host;
char *url;
char *user;
char *pass;
- char *verify_peer;
- char *verify_host;
+ 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;
typedef struct apache_s apache_t;
-static apache_t **apache = NULL;
-static size_t apache_num = 0;
+/* TODO: Remove this prototype */
+static int apache_read_host (user_data_t *user_data);
static void apache_free (apache_t *st)
{
sfree (st->url);
sfree (st->user);
sfree (st->pass);
- sfree (st->verify_peer);
- sfree (st->verify_host);
sfree (st->cacert);
+ sfree (st->server);
sfree (st->apache_buffer);
if (st->curl) {
curl_easy_cleanup(st->curl);
} /* apache_free */
static size_t apache_curl_callback (void *buf, size_t size, size_t nmemb,
- apache_t *st)
+ void *user_data)
{
size_t len = size * nmemb;
+ apache_t *st;
+
+ st = user_data;
+ if (st == NULL)
+ {
+ ERROR ("apache plugin: apache_curl_callback: "
+ "user_data pointer is NULL.");
+ return (0);
+ }
if (len <= 0)
return (len);
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
+ {
+ 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">
* URL ...
* </Plugin>
*/
-static int config_set_string (char **ret_string,
+static int config_set_string (char **ret_string, /* {{{ */
oconfig_item_t *ci)
{
char *string;
*ret_string = string;
return (0);
-} /* int config_set_string */
+} /* }}} int config_set_string */
+
+static int config_set_boolean (int *ret_boolean, /* {{{ */
+ oconfig_item_t *ci)
+{
+ if ((ci->values_num != 1)
+ || ((ci->values[0].type != OCONFIG_TYPE_BOOLEAN)
+ && (ci->values[0].type != OCONFIG_TYPE_STRING)))
+ {
+ WARNING ("apache plugin: The `%s' config option "
+ "needs exactly one boolean argument.", ci->key);
+ return (-1);
+ }
+
+ if (ci->values[0].type == OCONFIG_TYPE_BOOLEAN)
+ {
+ if (ci->values[0].value.boolean)
+ *ret_boolean = 1;
+ else
+ *ret_boolean = 0;
+ }
+ else /* if (ci->values[0].type != OCONFIG_TYPE_STRING) */
+ {
+ char *string = ci->values[0].value.string;
+ if (IS_TRUE (string))
+ *ret_boolean = 1;
+ else if (IS_FALSE (string))
+ *ret_boolean = 0;
+ else
+ {
+ ERROR ("apache plugin: Cannot parse string "
+ "as boolean value: %s", string);
+ return (-1);
+ }
+ }
+
+ return (0);
+} /* }}} int config_set_boolean */
static int config_add (oconfig_item_t *ci)
{
sfree (st);
return (status);
}
+ assert (st->name != NULL);
for (i = 0; i < ci->children_num; i++)
{
else if (strcasecmp ("Password", child->key) == 0)
status = config_set_string (&st->pass, child);
else if (strcasecmp ("VerifyPeer", child->key) == 0)
- status = config_set_string (&st->verify_peer, child);
+ status = config_set_boolean (&st->verify_peer, child);
else if (strcasecmp ("VerifyHost", child->key) == 0)
- status = config_set_string (&st->verify_host, child);
+ 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.", child->key);
+ WARNING ("apache plugin: Option `%s' not allowed here.",
+ child->key);
status = -1;
}
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)
{
- apache_t **temp;
- temp = (apache_t **) realloc (apache, sizeof (*apache) * (apache_num + 1));
- if (temp == NULL)
- {
- ERROR ("apache plugin: realloc failed");
- status = -1;
- }
- else
- {
- apache = temp;
- apache[apache_num] = st;
- apache_num++;
- }
+ user_data_t ud;
+ char callback_name[3*DATA_MAX_NAME_LEN];
+
+ memset (&ud, 0, sizeof (ud));
+ ud.data = st;
+ ud.free_func = (void *) apache_free;
+
+ memset (callback_name, 0, sizeof (callback_name));
+ ssnprintf (callback_name, sizeof (callback_name),
+ "apache/%s/%s",
+ (st->host != NULL) ? st->host : hostname_g,
+ (st->name != NULL) ? st->name : "default"),
+
+ status = plugin_register_complex_read (/* group = */ NULL,
+ /* name = */ callback_name,
+ /* callback = */ apache_read_host,
+ /* interval = */ NULL,
+ /* user_data = */ &ud);
}
if (status != 0)
return status;
} /* int config */
-
/* initialize curl for each host */
static int init_host (apache_t *st) /* {{{ */
{
static char credentials[1024];
- if (st->url == NULL)
- {
- WARNING ("apache plugin: init: 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)
{
- ERROR ("apache plugin: init: `curl_easy_init' failed.");
+ ERROR ("apache plugin: init_host: `curl_easy_init' failed.");
return (-1);
}
+ curl_easy_setopt (st->curl, CURLOPT_NOSIGNAL, 1);
curl_easy_setopt (st->curl, CURLOPT_WRITEFUNCTION, apache_curl_callback);
curl_easy_setopt (st->curl, CURLOPT_WRITEDATA, st);
+
+ /* 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
+ 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, PACKAGE_NAME"/"PACKAGE_VERSION);
curl_easy_setopt (st->curl, CURLOPT_ERRORBUFFER, st->apache_curl_error);
st->user, (st->pass == NULL) ? "" : st->pass);
if ((status < 0) || ((size_t) status >= sizeof (credentials)))
{
- ERROR ("apache plugin: init: Returning an error "
+ ERROR ("apache plugin: init_host: Returning an error "
"because the credentials have been "
"truncated.");
+ curl_easy_cleanup (st->curl);
+ st->curl = NULL;
return (-1);
}
}
curl_easy_setopt (st->curl, CURLOPT_URL, st->url);
+ curl_easy_setopt (st->curl, CURLOPT_FOLLOWLOCATION, 1);
- if ((st->verify_peer == NULL) || (strcmp (st->verify_peer, "true") == 0))
+ if (st->verify_peer != 0)
{
curl_easy_setopt (st->curl, CURLOPT_SSL_VERIFYPEER, 1);
}
curl_easy_setopt (st->curl, CURLOPT_SSL_VERIFYPEER, 0);
}
- if ((st->verify_host == NULL) || (strcmp (st->verify_host, "true") == 0))
+ if (st->verify_host != 0)
{
curl_easy_setopt (st->curl, CURLOPT_SSL_VERIFYHOST, 2);
}
}
return (0);
-} /* int init_host */
+} /* }}} int init_host */
-static int init (void)
+static void submit_value (const char *type, const char *type_instance,
+ value_t value, apache_t *st)
{
- size_t i;
- int success = 0;
- int status;
-
- for (i = 0; i < apache_num; i++)
- {
- status = init_host (apache[i]);
- if (status == 0)
- success++;
- }
-
- if (success == 0)
- {
- ERROR ("apache plugin init: No host could be initialized. Will return an error so "
- "the plugin will be delayed.");
- return (-1);
- }
-
- return (0);
-} /* int init */
-
-static void set_plugin_instance (apache_t *st, value_list_t *vl)
-{
- /* if there is no instance name, don't set plugin_instance */
- if ( (st->name != NULL)
- && (apache_num > 0) )
- {
- sstrncpy (vl->plugin_instance, st->name, sizeof (vl->plugin_instance));
- }
-} /* void set_plugin */
-
-static void submit_counter (const char *type, const char *type_instance,
- counter_t value, apache_t *st)
-{
- value_t values[1];
value_list_t vl = VALUE_LIST_INIT;
- values[0].counter = value;
-
- vl.values = values;
+ vl.values = &value;
vl.values_len = 1;
- sstrncpy (vl.host, st->host, sizeof (vl.host));
+
+ sstrncpy (vl.host, (st->host != NULL) ? st->host : hostname_g,
+ sizeof (vl.host));
+
sstrncpy (vl.plugin, "apache", sizeof (vl.plugin));
- sstrncpy (vl.plugin_instance, "", sizeof (vl.plugin_instance));
- sstrncpy (vl.type, type, sizeof (vl.type));
+ if (st->name != NULL)
+ sstrncpy (vl.plugin_instance, st->name,
+ sizeof (vl.plugin_instance));
+ sstrncpy (vl.type, type, sizeof (vl.type));
if (type_instance != NULL)
sstrncpy (vl.type_instance, type_instance,
sizeof (vl.type_instance));
- set_plugin_instance (st, &vl);
-
plugin_dispatch_values (&vl);
+} /* void submit_value */
+
+static void submit_counter (const char *type, const char *type_instance,
+ counter_t c, apache_t *st)
+{
+ value_t v;
+ v.counter = c;
+ submit_value (type, type_instance, v, st);
} /* void submit_counter */
static void submit_gauge (const char *type, const char *type_instance,
- gauge_t value, apache_t *st)
+ gauge_t g, apache_t *st)
{
- value_t values[1];
- value_list_t vl = VALUE_LIST_INIT;
-
- values[0].gauge = value;
-
- vl.values = values;
- vl.values_len = 1;
- sstrncpy (vl.host, st->host, sizeof (vl.host));
- sstrncpy (vl.plugin, "apache", sizeof (vl.plugin));
- sstrncpy (vl.plugin_instance, "", sizeof (vl.plugin_instance));
- sstrncpy (vl.type, type, sizeof (vl.type));
+ value_t v;
+ v.gauge = g;
+ submit_value (type, type_instance, v, st);
+} /* void submit_gauge */
- if (type_instance != NULL)
- sstrncpy (vl.type_instance, type_instance,
- sizeof (vl.type_instance));
-
- set_plugin_instance (st, &vl);
-
- plugin_dispatch_values (&vl);
-} /* void submit_counter */
-
-static void submit_scoreboard (char *buf, int server, apache_t *st)
+static void submit_scoreboard (char *buf, apache_t *st)
{
/*
* Scoreboard Key:
long long finishing = 0LL;
long long idle_cleanup = 0LL;
- // lighttpd specific
- long long connect = 0LL;
+ /* lighttpd specific */
long long hard_error = 0LL;
long long lighttpd_read = 0LL;
long long handle_request = 0LL;
long long response_end = 0LL;
int i;
-
for (i = 0; buf[i] != '\0'; i++)
{
if (buf[i] == '.') open++;
else if (buf[i] == 'L') logging++;
else if (buf[i] == 'G') finishing++;
else if (buf[i] == 'I') idle_cleanup++;
- else if (buf[i] == '.') connect++;
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] == 'S') response_end++;
}
- if (server == APACHE)
+ if (st->server_type == APACHE)
{
submit_gauge ("apache_scoreboard", "open" , open, st);
submit_gauge ("apache_scoreboard", "waiting" , waiting, 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
+ }
+ else
{
- submit_gauge ("apache_scoreboard", "connect" , connect, st);
+ 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", "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 (apache_t *st)
+static int apache_read_host (user_data_t *user_data) /* {{{ */
{
int i;
char *fields[4];
int fields_num;
- int server = LIGHTTPD; // default is lighttpd
+
+ apache_t *st;
+
+ st = user_data->data;
+
+ assert (st->url != NULL);
+ /* (Assured by `config_add') */
if (st->curl == NULL)
- return (-1);
- if (st->url == NULL)
- return (-1);
+ {
+ int status;
+
+ status = init_host (st);
+ if (status != 0)
+ return (-1);
+ }
+ assert (st->curl != NULL);
st->apache_buffer_fill = 0;
if (curl_easy_perform (st->curl) != 0)
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)
break;
}
- /* set the host to localhost if st->host is not specified */
- if ( (st->host == NULL)
- || (0 == strcmp(st->host, "")) ) {
- st->host = hostname_g;
- }
-
for (i = 0; i < lines_num; i++)
{
fields_num = strsplit (lines[i], fields, 4);
}
else if (fields_num == 2)
{
- // find out if the server is apache from the mod_status output.
- // apache mod_status output has additional fields which lighttpd
- // mod_status output doesn't have e.g: ReqPerSec.
- // submit_scoreboard needs server type information and thus it is
- // important to pick up a field before scoreboard gets parsed
- // to set the server type
- if (strcmp (fields[0], "ReqPerSec:") == 0)
- server = APACHE;
- else if (strcmp (fields[0], "Scoreboard:") == 0)
- submit_scoreboard (fields[1], server, st);
- else if (strcmp (fields[0], "BusyServers:") == 0)
+ if (strcmp (fields[0], "Scoreboard:") == 0)
+ submit_scoreboard (fields[1], st);
+ 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);
}
}
st->apache_buffer_fill = 0;
return (0);
-} /* int apache_read_host */
-
-static int apache_read (void)
-{
- size_t i;
- int success = 0;
- int status;
-
- for (i = 0; i < apache_num; i++)
- {
- status = apache_read_host (apache[i]);
- if (status == 0)
- success++;
- }
-
- if (success == 0)
- {
- ERROR ("apache plugin: No host could be read. Will return an error so "
- "the plugin will be delayed.");
- return (-1);
- }
-
- return (0);
- } /* int apache_read */
+} /* }}} int apache_read_host */
void module_register (void)
{
plugin_register_complex_config ("apache", config);
- plugin_register_init ("apache", init);
- plugin_register_read ("apache", apache_read);
} /* void module_register */
+
+/* vim: set sw=8 noet fdm=marker : */
projects / collectd.git / blobdiff