Code

zfs-arc plugin: check return value of malloc
[collectd.git] / 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  **/
27 #include "collectd.h"
28 #include "common.h"
29 #include "plugin.h"
30 #include "configfile.h"
32 #include <curl/curl.h>
34 enum server_enum
35 {
36         APACHE = 0,
37         LIGHTTPD
38 };
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 */
61 typedef struct apache_s apache_t;
63 /* TODO: Remove this prototype */
64 static int apache_read_host (user_data_t *user_data);
66 static void apache_free (apache_t *st)
67 {
68         if (st == NULL)
69                 return;
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 */
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;
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         }
101         if (len <= 0)
102                 return (len);
104         if ((st->apache_buffer_fill + len) >= st->apache_buffer_size)
105         {
106                 char *temp;
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         }
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;
123         return (len);
124 } /* int apache_curl_callback */
126 static size_t apache_header_callback (void *buf, size_t size, size_t nmemb,
127                 void *user_data)
129         size_t len = size * nmemb;
130         apache_t *st;
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         }
140         if (len <= 0)
141                 return (len);
143         /* look for the Server header */
144         if (strncasecmp (buf, "Server: ", strlen ("Server: ")) != 0)
145                 return (len);
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;
157                 hdr += strlen ("Server: ");
158                 NOTICE ("apache plugin: Unknown server software: %s", hdr);
159         }
161         return (len);
162 } /* apache_header_callback */
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)
174         apache_t *st;
175         int i;
176         int status;
178         st = malloc (sizeof (*st));
179         if (st == NULL)
180         {
181                 ERROR ("apache plugin: malloc failed.");
182                 return (-1);
183         }
184         memset (st, 0, sizeof (*st));
186         st->timeout = -1;
188         status = cf_util_get_string (ci, &st->name);
189         if (status != 0)
190         {
191                 sfree (st);
192                 return (status);
193         }
194         assert (st->name != NULL);
196         for (i = 0; i < ci->children_num; i++)
197         {
198                 oconfig_item_t *child = ci->children + i;
200                 if (strcasecmp ("URL", child->key) == 0)
201                         status = cf_util_get_string (child, &st->url);
202                 else if (strcasecmp ("Host", child->key) == 0)
203                         status = cf_util_get_string (child, &st->host);
204                 else if (strcasecmp ("User", child->key) == 0)
205                         status = cf_util_get_string (child, &st->user);
206                 else if (strcasecmp ("Password", child->key) == 0)
207                         status = cf_util_get_string (child, &st->pass);
208                 else if (strcasecmp ("VerifyPeer", child->key) == 0)
209                         status = cf_util_get_boolean (child, &st->verify_peer);
210                 else if (strcasecmp ("VerifyHost", child->key) == 0)
211                         status = cf_util_get_boolean (child, &st->verify_host);
212                 else if (strcasecmp ("CACert", child->key) == 0)
213                         status = cf_util_get_string (child, &st->cacert);
214                 else if (strcasecmp ("SSLCiphers", child->key) == 0)
215                         status = cf_util_get_string (child, &st->ssl_ciphers);
216                 else if (strcasecmp ("Server", child->key) == 0)
217                         status = cf_util_get_string (child, &st->server);
218                 else if (strcasecmp ("Timeout", child->key) == 0)
219                         status = cf_util_get_int (child, &st->timeout);
220                 else
221                 {
222                         WARNING ("apache plugin: Option `%s' not allowed here.",
223                                         child->key);
224                         status = -1;
225                 }
227                 if (status != 0)
228                         break;
229         }
231         /* Check if struct is complete.. */
232         if ((status == 0) && (st->url == NULL))
233         {
234                 ERROR ("apache plugin: Instance `%s': "
235                                 "No URL has been configured.",
236                                 st->name);
237                 status = -1;
238         }
240         if (status == 0)
241         {
242                 user_data_t ud;
243                 char callback_name[3*DATA_MAX_NAME_LEN];
245                 memset (&ud, 0, sizeof (ud));
246                 ud.data = st;
247                 ud.free_func = (void *) apache_free;
249                 memset (callback_name, 0, sizeof (callback_name));
250                 ssnprintf (callback_name, sizeof (callback_name),
251                                 "apache/%s/%s",
252                                 (st->host != NULL) ? st->host : hostname_g,
253                                 (st->name != NULL) ? st->name : "default"),
255                 status = plugin_register_complex_read (/* group = */ NULL,
256                                 /* name      = */ callback_name,
257                                 /* callback  = */ apache_read_host,
258                                 /* interval  = */ NULL,
259                                 /* user_data = */ &ud);
260         }
262         if (status != 0)
263         {
264                 apache_free (st);
265                 return (-1);
266         }
268         return (0);
269 } /* int config_add */
271 static int config (oconfig_item_t *ci)
273         int status = 0;
274         int i;
276         for (i = 0; i < ci->children_num; i++)
277         {
278                 oconfig_item_t *child = ci->children + i;
280                 if (strcasecmp ("Instance", child->key) == 0)
281                         config_add (child);
282                 else
283                         WARNING ("apache plugin: The configuration option "
284                                         "\"%s\" is not allowed here. Did you "
285                                         "forget to add an <Instance /> block "
286                                         "around the configuration?",
287                                         child->key);
288         } /* for (ci->children) */
290         return (status);
291 } /* int config */
293 /* initialize curl for each host */
294 static int init_host (apache_t *st) /* {{{ */
296         assert (st->url != NULL);
297         /* (Assured by `config_add') */
299         if (st->curl != NULL)
300         {
301                 curl_easy_cleanup (st->curl);
302                 st->curl = NULL;
303         }
305         if ((st->curl = curl_easy_init ()) == NULL)
306         {
307                 ERROR ("apache plugin: init_host: `curl_easy_init' failed.");
308                 return (-1);
309         }
311         curl_easy_setopt (st->curl, CURLOPT_NOSIGNAL, 1L);
312         curl_easy_setopt (st->curl, CURLOPT_WRITEFUNCTION, apache_curl_callback);
313         curl_easy_setopt (st->curl, CURLOPT_WRITEDATA, st);
315         /* not set as yet if the user specified string doesn't match apache or
316          * lighttpd, then ignore it. Headers will be parsed to find out the
317          * server type */
318         st->server_type = -1;
320         if (st->server != NULL)
321         {
322                 if (strcasecmp(st->server, "apache") == 0)
323                         st->server_type = APACHE;
324                 else if (strcasecmp(st->server, "lighttpd") == 0)
325                         st->server_type = LIGHTTPD;
326                 else if (strcasecmp(st->server, "ibm_http_server") == 0)
327                         st->server_type = APACHE;
328                 else
329                         WARNING ("apache plugin: Unknown `Server' setting: %s",
330                                         st->server);
331         }
333         /* if not found register a header callback to determine the server_type */
334         if (st->server_type == -1)
335         {
336                 curl_easy_setopt (st->curl, CURLOPT_HEADERFUNCTION, apache_header_callback);
337                 curl_easy_setopt (st->curl, CURLOPT_WRITEHEADER, st);
338         }
340         curl_easy_setopt (st->curl, CURLOPT_USERAGENT, COLLECTD_USERAGENT);
341         curl_easy_setopt (st->curl, CURLOPT_ERRORBUFFER, st->apache_curl_error);
343         if (st->user != NULL)
344         {
345 #ifdef HAVE_CURLOPT_USERNAME
346                 curl_easy_setopt (st->curl, CURLOPT_USERNAME, st->user);
347                 curl_easy_setopt (st->curl, CURLOPT_PASSWORD,
348                                 (st->pass == NULL) ? "" : st->pass);
349 #else
350                 static char credentials[1024];
351                 int status;
353                 status = ssnprintf (credentials, sizeof (credentials), "%s:%s",
354                                 st->user, (st->pass == NULL) ? "" : st->pass);
355                 if ((status < 0) || ((size_t) status >= sizeof (credentials)))
356                 {
357                         ERROR ("apache plugin: init_host: Returning an error "
358                                         "because the credentials have been "
359                                         "truncated.");
360                         curl_easy_cleanup (st->curl);
361                         st->curl = NULL;
362                         return (-1);
363                 }
365                 curl_easy_setopt (st->curl, CURLOPT_USERPWD, credentials);
366 #endif
367         }
369         curl_easy_setopt (st->curl, CURLOPT_URL, st->url);
370         curl_easy_setopt (st->curl, CURLOPT_FOLLOWLOCATION, 1L);
371         curl_easy_setopt (st->curl, CURLOPT_MAXREDIRS, 50L);
373         curl_easy_setopt (st->curl, CURLOPT_SSL_VERIFYPEER,
374                         (long) st->verify_peer);
375         curl_easy_setopt (st->curl, CURLOPT_SSL_VERIFYHOST,
376                         st->verify_host ? 2L : 0L);
377         if (st->cacert != NULL)
378                 curl_easy_setopt (st->curl, CURLOPT_CAINFO, st->cacert);
379         if (st->ssl_ciphers != NULL)
380                 curl_easy_setopt (st->curl, CURLOPT_SSL_CIPHER_LIST,st->ssl_ciphers);
382 #ifdef HAVE_CURLOPT_TIMEOUT_MS
383         if (st->timeout >= 0)
384                 curl_easy_setopt (st->curl, CURLOPT_TIMEOUT_MS, (long) st->timeout);
385         else
386                 curl_easy_setopt (st->curl, CURLOPT_TIMEOUT_MS,
387                                 CDTIME_T_TO_MS(plugin_get_interval()));
388 #endif
390         return (0);
391 } /* }}} int init_host */
393 static void submit_value (const char *type, const char *type_instance,
394                 value_t value, apache_t *st)
396         value_list_t vl = VALUE_LIST_INIT;
398         vl.values = &value;
399         vl.values_len = 1;
401         sstrncpy (vl.host, (st->host != NULL) ? st->host : hostname_g,
402                         sizeof (vl.host));
404         sstrncpy (vl.plugin, "apache", sizeof (vl.plugin));
405         if (st->name != NULL)
406                 sstrncpy (vl.plugin_instance, st->name,
407                                 sizeof (vl.plugin_instance));
409         sstrncpy (vl.type, type, sizeof (vl.type));
410         if (type_instance != NULL)
411                 sstrncpy (vl.type_instance, type_instance,
412                                 sizeof (vl.type_instance));
414         plugin_dispatch_values (&vl);
415 } /* void submit_value */
417 static void submit_derive (const char *type, const char *type_instance,
418                 derive_t c, apache_t *st)
420         value_t v;
421         v.derive = c;
422         submit_value (type, type_instance, v, st);
423 } /* void submit_derive */
425 static void submit_gauge (const char *type, const char *type_instance,
426                 gauge_t g, apache_t *st)
428         value_t v;
429         v.gauge = g;
430         submit_value (type, type_instance, v, st);
431 } /* void submit_gauge */
433 static void submit_scoreboard (char *buf, apache_t *st)
435         /*
436          * Scoreboard Key:
437          * "_" Waiting for Connection, "S" Starting up,
438          * "R" Reading Request for apache and read-POST for lighttpd,
439          * "W" Sending Reply, "K" Keepalive (read), "D" DNS Lookup,
440          * "C" Closing connection, "L" Logging, "G" Gracefully finishing,
441          * "I" Idle cleanup of worker, "." Open slot with no current process
442          * Lighttpd specific legends -
443          * "E" hard error, "." connect, "h" handle-request,
444          * "q" request-start, "Q" request-end, "s" response-start
445          * "S" response-end, "r" read
446          */
447         long long open      = 0LL;
448         long long waiting   = 0LL;
449         long long starting  = 0LL;
450         long long reading   = 0LL;
451         long long sending   = 0LL;
452         long long keepalive = 0LL;
453         long long dnslookup = 0LL;
454         long long closing   = 0LL;
455         long long logging   = 0LL;
456         long long finishing = 0LL;
457         long long idle_cleanup = 0LL;
459         /* lighttpd specific */
460         long long hard_error     = 0LL;
461         long long lighttpd_read  = 0LL;
462         long long handle_request = 0LL;
463         long long request_start  = 0LL;
464         long long request_end    = 0LL;
465         long long response_start = 0LL;
466         long long response_end   = 0LL;
468         int i;
469         for (i = 0; buf[i] != '\0'; i++)
470         {
471                 if (buf[i] == '.') open++;
472                 else if (buf[i] == '_') waiting++;
473                 else if (buf[i] == 'S') starting++;
474                 else if (buf[i] == 'R') reading++;
475                 else if (buf[i] == 'W') sending++;
476                 else if (buf[i] == 'K') keepalive++;
477                 else if (buf[i] == 'D') dnslookup++;
478                 else if (buf[i] == 'C') closing++;
479                 else if (buf[i] == 'L') logging++;
480                 else if (buf[i] == 'G') finishing++;
481                 else if (buf[i] == 'I') idle_cleanup++;
482                 else if (buf[i] == 'r') lighttpd_read++;
483                 else if (buf[i] == 'h') handle_request++;
484                 else if (buf[i] == 'E') hard_error++;
485                 else if (buf[i] == 'q') request_start++;
486                 else if (buf[i] == 'Q') request_end++;
487                 else if (buf[i] == 's') response_start++;
488                 else if (buf[i] == 'S') response_end++;
489         }
491         if (st->server_type == APACHE)
492         {
493                 submit_gauge ("apache_scoreboard", "open"     , open, st);
494                 submit_gauge ("apache_scoreboard", "waiting"  , waiting, st);
495                 submit_gauge ("apache_scoreboard", "starting" , starting, st);
496                 submit_gauge ("apache_scoreboard", "reading"  , reading, st);
497                 submit_gauge ("apache_scoreboard", "sending"  , sending, st);
498                 submit_gauge ("apache_scoreboard", "keepalive", keepalive, st);
499                 submit_gauge ("apache_scoreboard", "dnslookup", dnslookup, st);
500                 submit_gauge ("apache_scoreboard", "closing"  , closing, st);
501                 submit_gauge ("apache_scoreboard", "logging"  , logging, st);
502                 submit_gauge ("apache_scoreboard", "finishing", finishing, st);
503                 submit_gauge ("apache_scoreboard", "idle_cleanup", idle_cleanup, st);
504         }
505         else
506         {
507                 submit_gauge ("apache_scoreboard", "connect"       , open, st);
508                 submit_gauge ("apache_scoreboard", "close"         , closing, st);
509                 submit_gauge ("apache_scoreboard", "hard_error"    , hard_error, st);
510                 submit_gauge ("apache_scoreboard", "read"          , lighttpd_read, st);
511                 submit_gauge ("apache_scoreboard", "read_post"     , reading, st);
512                 submit_gauge ("apache_scoreboard", "write"         , sending, st);
513                 submit_gauge ("apache_scoreboard", "handle_request", handle_request, st);
514                 submit_gauge ("apache_scoreboard", "request_start" , request_start, st);
515                 submit_gauge ("apache_scoreboard", "request_end"   , request_end, st);
516                 submit_gauge ("apache_scoreboard", "response_start", response_start, st);
517                 submit_gauge ("apache_scoreboard", "response_end"  , response_end, st);
518         }
521 static int apache_read_host (user_data_t *user_data) /* {{{ */
523         char *ptr;
524         char *saveptr;
525         char *line;
527         char *fields[4];
528         int   fields_num;
530         apache_t *st;
532         st = user_data->data;
534         assert (st->url != NULL);
535         /* (Assured by `config_add') */
537         if (st->curl == NULL)
538         {
539                 int status;
541                 status = init_host (st);
542                 if (status != 0)
543                         return (-1);
544         }
545         assert (st->curl != NULL);
547         st->apache_buffer_fill = 0;
548         if (curl_easy_perform (st->curl) != CURLE_OK)
549         {
550                 ERROR ("apache: curl_easy_perform failed: %s",
551                                 st->apache_curl_error);
552                 return (-1);
553         }
555         /* fallback - server_type to apache if not set at this time */
556         if (st->server_type == -1)
557         {
558                 WARNING ("apache plugin: Unable to determine server software "
559                                 "automatically. Will assume Apache.");
560                 st->server_type = APACHE;
561         }
563         ptr = st->apache_buffer;
564         saveptr = NULL;
565         while ((line = strtok_r (ptr, "\n\r", &saveptr)) != NULL)
566         {
567                 ptr = NULL;
568                 fields_num = strsplit (line, fields, STATIC_ARRAY_SIZE (fields));
570                 if (fields_num == 3)
571                 {
572                         if ((strcmp (fields[0], "Total") == 0) && (strcmp (fields[1], "Accesses:") == 0))
573                                 submit_derive ("apache_requests", "", atoll (fields[2]), st);
574                         else if ((strcmp (fields[0], "Total") == 0) && (strcmp (fields[1], "kBytes:") == 0))
575                                 submit_derive ("apache_bytes", "", 1024LL * atoll (fields[2]), st);
576                 }
577                 else if (fields_num == 2)
578                 {
579                         if (strcmp (fields[0], "Scoreboard:") == 0)
580                                 submit_scoreboard (fields[1], st);
581                         else if ((strcmp (fields[0], "BusyServers:") == 0) /* Apache 1.* */
582                                         || (strcmp (fields[0], "BusyWorkers:") == 0) /* Apache 2.* */)
583                                 submit_gauge ("apache_connections", NULL, atol (fields[1]), st);
584                         else if ((strcmp (fields[0], "IdleServers:") == 0) /* Apache 1.x */
585                                         || (strcmp (fields[0], "IdleWorkers:") == 0) /* Apache 2.x */)
586                                 submit_gauge ("apache_idle_workers", NULL, atol (fields[1]), st);
587                 }
588         }
590         st->apache_buffer_fill = 0;
592         return (0);
593 } /* }}} int apache_read_host */
595 static int apache_init (void) /* {{{ */
597         /* Call this while collectd is still single-threaded to avoid
598          * initialization issues in libgcrypt. */
599         curl_global_init (CURL_GLOBAL_SSL);
600         return (0);
601 } /* }}} int apache_init */
603 void module_register (void)
605         plugin_register_complex_config ("apache", config);
606         plugin_register_init ("apache", apache_init);
607 } /* void module_register */
609 /* vim: set sw=8 noet fdm=marker : */