2 * collectd - src/curl.c
3 * Copyright (C) 2006-2009 Florian octo Forster
4 * Copyright (C) 2009 Aman Gupta
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation; only version 2 of the License is applicable.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20 * Florian octo Forster <octo at verplant.org>
21 * Aman Gupta <aman at tmm1.net>
27 #include "configfile.h"
28 #include "utils_match.h"
30 #include <curl/curl.h>
36 typedef struct web_match_s web_match_t;
37 struct web_match_s /* {{{ */
51 typedef struct web_page_s web_page_t;
52 struct web_page_s /* {{{ */
66 char curl_errbuf[CURL_ERROR_SIZE];
79 /* static CURLM *curl = NULL; */
80 static web_page_t *pages_g = NULL;
85 static size_t cc_curl_callback (void *buf, /* {{{ */
86 size_t size, size_t nmemb, void *user_data)
99 if ((wp->buffer_fill + len) >= wp->buffer_size)
104 temp_size = wp->buffer_fill + len + 1;
105 temp = (char *) realloc (wp->buffer, temp_size);
108 ERROR ("curl plugin: realloc failed.");
112 wp->buffer_size = temp_size;
115 memcpy (wp->buffer + wp->buffer_fill, (char *) buf, len);
116 wp->buffer_fill += len;
117 wp->buffer[wp->buffer_fill] = 0;
120 } /* }}} size_t cc_curl_callback */
122 static void cc_web_match_free (web_match_t *wm) /* {{{ */
129 sfree (wm->instance);
130 match_destroy (wm->match);
131 cc_web_match_free (wm->next);
133 } /* }}} void cc_web_match_free */
135 static void cc_web_page_free (web_page_t *wp) /* {{{ */
140 if (wp->curl != NULL)
141 curl_easy_cleanup (wp->curl);
144 sfree (wp->instance);
149 sfree (wp->credentials);
154 cc_web_match_free (wp->matches);
155 cc_web_page_free (wp->next);
157 } /* }}} void cc_web_page_free */
159 static int cc_config_add_string (const char *name, char **dest, /* {{{ */
162 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
164 WARNING ("curl plugin: `%s' needs exactly one string argument.", name);
169 *dest = strdup (ci->values[0].value.string);
174 } /* }}} int cc_config_add_string */
176 static int cc_config_set_boolean (const char *name, int *dest, /* {{{ */
179 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_BOOLEAN))
181 WARNING ("curl plugin: `%s' needs exactly one boolean argument.", name);
185 *dest = ci->values[0].value.boolean ? 1 : 0;
188 } /* }}} int cc_config_set_boolean */
190 static int cc_config_add_match_dstype (int *dstype_ret, /* {{{ */
195 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
197 WARNING ("curl plugin: `DSType' needs exactly one string argument.");
201 if (strncasecmp ("Gauge", ci->values[0].value.string,
202 strlen ("Gauge")) == 0)
204 dstype = UTILS_MATCH_DS_TYPE_GAUGE;
205 if (strcasecmp ("GaugeAverage", ci->values[0].value.string) == 0)
206 dstype |= UTILS_MATCH_CF_GAUGE_AVERAGE;
207 else if (strcasecmp ("GaugeMin", ci->values[0].value.string) == 0)
208 dstype |= UTILS_MATCH_CF_GAUGE_MIN;
209 else if (strcasecmp ("GaugeMax", ci->values[0].value.string) == 0)
210 dstype |= UTILS_MATCH_CF_GAUGE_MAX;
211 else if (strcasecmp ("GaugeLast", ci->values[0].value.string) == 0)
212 dstype |= UTILS_MATCH_CF_GAUGE_LAST;
216 else if (strncasecmp ("Counter", ci->values[0].value.string,
217 strlen ("Counter")) == 0)
219 dstype = UTILS_MATCH_DS_TYPE_COUNTER;
220 if (strcasecmp ("CounterSet", ci->values[0].value.string) == 0)
221 dstype |= UTILS_MATCH_CF_COUNTER_SET;
222 else if (strcasecmp ("CounterAdd", ci->values[0].value.string) == 0)
223 dstype |= UTILS_MATCH_CF_COUNTER_ADD;
224 else if (strcasecmp ("CounterInc", ci->values[0].value.string) == 0)
225 dstype |= UTILS_MATCH_CF_COUNTER_INC;
229 else if (strncasecmp ("Derive", ci->values[0].value.string,
230 strlen ("Derive")) == 0)
232 dstype = UTILS_MATCH_DS_TYPE_DERIVE;
233 if (strcasecmp ("DeriveSet", ci->values[0].value.string) == 0)
234 dstype |= UTILS_MATCH_CF_DERIVE_SET;
235 else if (strcasecmp ("DeriveAdd", ci->values[0].value.string) == 0)
236 dstype |= UTILS_MATCH_CF_DERIVE_ADD;
237 else if (strcasecmp ("DeriveInc", ci->values[0].value.string) == 0)
238 dstype |= UTILS_MATCH_CF_DERIVE_INC;
242 else if (strncasecmp ("Absolute", ci->values[0].value.string,
243 strlen ("Absolute")) == 0)
245 dstype = UTILS_MATCH_DS_TYPE_ABSOLUTE;
246 if (strcasecmp ("AbsoluteSet", ci->values[0].value.string) == 0) /* Absolute DS is reset-on-read so no sense doin anything else but set */
247 dstype |= UTILS_MATCH_CF_ABSOLUTE_SET;
259 WARNING ("curl plugin: `%s' is not a valid argument to `DSType'.",
260 ci->values[0].value.string);
264 *dstype_ret = dstype;
266 } /* }}} int cc_config_add_match_dstype */
268 static int cc_config_add_match (web_page_t *page, /* {{{ */
275 if (ci->values_num != 0)
277 WARNING ("curl plugin: Ignoring arguments for the `Match' block.");
280 match = (web_match_t *) malloc (sizeof (*match));
283 ERROR ("curl plugin: malloc failed.");
286 memset (match, 0, sizeof (*match));
289 for (i = 0; i < ci->children_num; i++)
291 oconfig_item_t *child = ci->children + i;
293 if (strcasecmp ("Regex", child->key) == 0)
294 status = cc_config_add_string ("Regex", &match->regex, child);
295 else if (strcasecmp ("ExcludeRegex", child->key) == 0)
296 status = cc_config_add_string ("ExcludeRegex", &match->exclude_regex, child);
297 else if (strcasecmp ("DSType", child->key) == 0)
298 status = cc_config_add_match_dstype (&match->dstype, child);
299 else if (strcasecmp ("Type", child->key) == 0)
300 status = cc_config_add_string ("Type", &match->type, child);
301 else if (strcasecmp ("Instance", child->key) == 0)
302 status = cc_config_add_string ("Instance", &match->instance, child);
305 WARNING ("curl plugin: Option `%s' not allowed here.", child->key);
311 } /* for (i = 0; i < ci->children_num; i++) */
315 if (match->regex == NULL)
317 WARNING ("curl plugin: `Regex' missing in `Match' block.");
321 if (match->type == NULL)
323 WARNING ("curl plugin: `Type' missing in `Match' block.");
327 if (match->dstype == 0)
329 WARNING ("curl plugin: `DSType' missing in `Match' block.");
334 } /* while (status == 0) */
339 match->match = match_create_simple (match->regex, match->exclude_regex,
341 if (match->match == NULL)
343 ERROR ("curl plugin: tail_match_add_match_simple failed.");
344 cc_web_match_free (match);
351 prev = page->matches;
352 while ((prev != NULL) && (prev->next != NULL))
356 page->matches = match;
362 } /* }}} int cc_config_add_match */
364 static int cc_page_init_curl (web_page_t *wp) /* {{{ */
366 wp->curl = curl_easy_init ();
367 if (wp->curl == NULL)
369 ERROR ("curl plugin: curl_easy_init failed.");
373 curl_easy_setopt (wp->curl, CURLOPT_NOSIGNAL, 1);
374 curl_easy_setopt (wp->curl, CURLOPT_WRITEFUNCTION, cc_curl_callback);
375 curl_easy_setopt (wp->curl, CURLOPT_WRITEDATA, wp);
376 curl_easy_setopt (wp->curl, CURLOPT_USERAGENT,
377 PACKAGE_NAME"/"PACKAGE_VERSION);
378 curl_easy_setopt (wp->curl, CURLOPT_ERRORBUFFER, wp->curl_errbuf);
379 curl_easy_setopt (wp->curl, CURLOPT_URL, wp->url);
380 curl_easy_setopt (wp->curl, CURLOPT_FOLLOWLOCATION, 1);
382 if (wp->user != NULL)
384 size_t credentials_size;
386 credentials_size = strlen (wp->user) + 2;
387 if (wp->pass != NULL)
388 credentials_size += strlen (wp->pass);
390 wp->credentials = (char *) malloc (credentials_size);
391 if (wp->credentials == NULL)
393 ERROR ("curl plugin: malloc failed.");
397 ssnprintf (wp->credentials, credentials_size, "%s:%s",
398 wp->user, (wp->pass == NULL) ? "" : wp->pass);
399 curl_easy_setopt (wp->curl, CURLOPT_USERPWD, wp->credentials);
402 curl_easy_setopt (wp->curl, CURLOPT_SSL_VERIFYPEER, wp->verify_peer);
403 curl_easy_setopt (wp->curl, CURLOPT_SSL_VERIFYHOST,
404 wp->verify_host ? 2 : 0);
405 if (wp->cacert != NULL)
406 curl_easy_setopt (wp->curl, CURLOPT_CAINFO, wp->cacert);
409 } /* }}} int cc_page_init_curl */
411 static int cc_config_add_page (oconfig_item_t *ci) /* {{{ */
417 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
419 WARNING ("curl plugin: `Page' blocks need exactly one string argument.");
423 page = (web_page_t *) malloc (sizeof (*page));
426 ERROR ("curl plugin: malloc failed.");
429 memset (page, 0, sizeof (*page));
433 page->verify_peer = 1;
434 page->verify_host = 1;
435 page->response_time = 0;
437 page->instance = strdup (ci->values[0].value.string);
438 if (page->instance == NULL)
440 ERROR ("curl plugin: strdup failed.");
445 /* Process all children */
447 for (i = 0; i < ci->children_num; i++)
449 oconfig_item_t *child = ci->children + i;
451 if (strcasecmp ("URL", child->key) == 0)
452 status = cc_config_add_string ("URL", &page->url, child);
453 else if (strcasecmp ("User", child->key) == 0)
454 status = cc_config_add_string ("User", &page->user, child);
455 else if (strcasecmp ("Password", child->key) == 0)
456 status = cc_config_add_string ("Password", &page->pass, child);
457 else if (strcasecmp ("VerifyPeer", child->key) == 0)
458 status = cc_config_set_boolean ("VerifyPeer", &page->verify_peer, child);
459 else if (strcasecmp ("VerifyHost", child->key) == 0)
460 status = cc_config_set_boolean ("VerifyHost", &page->verify_host, child);
461 else if (strcasecmp ("MeasureResponseTime", child->key) == 0)
462 status = cc_config_set_boolean (child->key, &page->response_time, child);
463 else if (strcasecmp ("CACert", child->key) == 0)
464 status = cc_config_add_string ("CACert", &page->cacert, child);
465 else if (strcasecmp ("Match", child->key) == 0)
466 /* Be liberal with failing matches => don't set `status'. */
467 cc_config_add_match (page, child);
470 WARNING ("curl plugin: Option `%s' not allowed here.", child->key);
476 } /* for (i = 0; i < ci->children_num; i++) */
478 /* Additionial sanity checks and libCURL initialization. */
481 if (page->url == NULL)
483 WARNING ("curl plugin: `URL' missing in `Page' block.");
487 if (page->matches == NULL && !page->response_time)
489 assert (page->instance != NULL);
490 WARNING ("curl plugin: No (valid) `Match' block "
491 "or MeasureResponseTime within `Page' block `%s'.", page->instance);
496 status = cc_page_init_curl (page);
499 } /* while (status == 0) */
503 cc_web_page_free (page);
507 /* Add the new page to the linked list */
515 while ((prev != NULL) && (prev->next != NULL))
521 } /* }}} int cc_config_add_page */
523 static int cc_config (oconfig_item_t *ci) /* {{{ */
533 for (i = 0; i < ci->children_num; i++)
535 oconfig_item_t *child = ci->children + i;
537 if (strcasecmp ("Page", child->key) == 0)
539 status = cc_config_add_page (child);
547 WARNING ("curl plugin: Option `%s' not allowed here.", child->key);
552 if ((success == 0) && (errors > 0))
554 ERROR ("curl plugin: All statements failed.");
559 } /* }}} int cc_config */
561 static int cc_init (void) /* {{{ */
565 INFO ("curl plugin: No pages have been defined.");
569 } /* }}} int cc_init */
571 static void cc_submit (const web_page_t *wp, const web_match_t *wm, /* {{{ */
572 const cu_match_value_t *mv)
575 value_list_t vl = VALUE_LIST_INIT;
577 values[0] = mv->value;
581 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
582 sstrncpy (vl.plugin, "curl", sizeof (vl.plugin));
583 sstrncpy (vl.plugin_instance, wp->instance, sizeof (vl.plugin_instance));
584 sstrncpy (vl.type, wm->type, sizeof (vl.type));
585 sstrncpy (vl.type_instance, wm->instance, sizeof (vl.type_instance));
587 plugin_dispatch_values (&vl);
588 } /* }}} void cc_submit */
590 static void cc_submit_response_time (const web_page_t *wp, double seconds) /* {{{ */
593 value_list_t vl = VALUE_LIST_INIT;
595 values[0].gauge = seconds;
599 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
600 sstrncpy (vl.plugin, "curl", sizeof (vl.plugin));
601 sstrncpy (vl.plugin_instance, wp->instance, sizeof (vl.plugin_instance));
602 sstrncpy (vl.type, "response_time", sizeof (vl.type));
604 plugin_dispatch_values (&vl);
605 } /* }}} void cc_submit_response_time */
607 static int cc_read_page (web_page_t *wp) /* {{{ */
611 struct timeval start, end;
613 if (wp->response_time)
614 gettimeofday (&start, NULL);
617 status = curl_easy_perform (wp->curl);
620 ERROR ("curl plugin: curl_easy_perform failed with staus %i: %s",
621 status, wp->curl_errbuf);
625 if (wp->response_time)
628 gettimeofday (&end, NULL);
629 secs += end.tv_sec - start.tv_sec;
630 secs += (end.tv_usec - start.tv_usec) / 1000000.0;
631 cc_submit_response_time (wp, secs);
634 for (wm = wp->matches; wm != NULL; wm = wm->next)
636 cu_match_value_t *mv;
638 status = match_apply (wm->match, wp->buffer);
641 WARNING ("curl plugin: match_apply failed.");
645 mv = match_get_user_data (wm->match);
648 WARNING ("curl plugin: match_get_user_data returned NULL.");
652 cc_submit (wp, wm, mv);
653 } /* for (wm = wp->matches; wm != NULL; wm = wm->next) */
656 } /* }}} int cc_read_page */
658 static int cc_read (void) /* {{{ */
662 for (wp = pages_g; wp != NULL; wp = wp->next)
666 } /* }}} int cc_read */
668 static int cc_shutdown (void) /* {{{ */
670 cc_web_page_free (pages_g);
674 } /* }}} int cc_shutdown */
676 void module_register (void)
678 plugin_register_complex_config ("curl", cc_config);
679 plugin_register_init ("curl", cc_init);
680 plugin_register_read ("curl", cc_read);
681 plugin_register_shutdown ("curl", cc_shutdown);
682 } /* void module_register */
684 /* vim: set sw=2 sts=2 et fdm=marker : */