2 * collectd - src/curl.c
3 * Copyright (C) 2006-2009 Florian octo Forster
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; only version 2 of the License is applicable.
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19 * Florian octo Forster <octo at verplant.org>
25 #include "configfile.h"
26 #include "utils_match.h"
28 #include <curl/curl.h>
34 typedef struct web_match_s web_match_t;
35 struct web_match_s /* {{{ */
48 typedef struct web_page_s web_page_t;
49 struct web_page_s /* {{{ */
63 char curl_errbuf[CURL_ERROR_SIZE];
76 /* static CURLM *curl = NULL; */
77 static web_page_t *pages_g = NULL;
82 static size_t cc_curl_callback (void *buf, /* {{{ */
83 size_t size, size_t nmemb, void *user_data)
96 if ((wp->buffer_fill + len) >= wp->buffer_size)
101 temp_size = wp->buffer_fill + len + 1;
102 temp = (char *) realloc (wp->buffer, temp_size);
105 ERROR ("curl plugin: realloc failed.");
109 wp->buffer_size = temp_size;
112 memcpy (wp->buffer + wp->buffer_fill, (char *) buf, len);
113 wp->buffer_fill += len;
114 wp->buffer[wp->buffer_fill] = 0;
117 } /* }}} size_t cc_curl_callback */
119 static void cc_web_match_free (web_match_t *wm) /* {{{ */
126 sfree (wm->instance);
127 match_destroy (wm->match);
128 cc_web_match_free (wm->next);
130 } /* }}} void cc_web_match_free */
132 static void cc_web_page_free (web_page_t *wp) /* {{{ */
137 if (wp->curl != NULL)
138 curl_easy_cleanup (wp->curl);
141 sfree (wp->instance);
146 sfree (wp->credentials);
151 cc_web_match_free (wp->matches);
152 cc_web_page_free (wp->next);
154 } /* }}} void cc_web_page_free */
156 static int cc_config_add_string (const char *name, char **dest, /* {{{ */
159 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
161 WARNING ("curl plugin: `%s' needs exactly one string argument.", name);
166 *dest = strdup (ci->values[0].value.string);
171 } /* }}} int cc_config_add_string */
173 static int cc_config_set_boolean (const char *name, int *dest, /* {{{ */
176 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_BOOLEAN))
178 WARNING ("curl plugin: `%s' needs exactly one boolean argument.", name);
182 *dest = ci->values[0].value.boolean ? 1 : 0;
185 } /* }}} int cc_config_set_boolean */
187 static int cc_config_add_match_dstype (int *dstype_ret, /* {{{ */
192 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
194 WARNING ("curl plugin: `DSType' needs exactly one string argument.");
198 if (strncasecmp ("Gauge", ci->values[0].value.string,
199 strlen ("Gauge")) == 0)
201 dstype = UTILS_MATCH_DS_TYPE_GAUGE;
202 if (strcasecmp ("GaugeAverage", ci->values[0].value.string) == 0)
203 dstype |= UTILS_MATCH_CF_GAUGE_AVERAGE;
204 else if (strcasecmp ("GaugeMin", ci->values[0].value.string) == 0)
205 dstype |= UTILS_MATCH_CF_GAUGE_MIN;
206 else if (strcasecmp ("GaugeMax", ci->values[0].value.string) == 0)
207 dstype |= UTILS_MATCH_CF_GAUGE_MAX;
208 else if (strcasecmp ("GaugeLast", ci->values[0].value.string) == 0)
209 dstype |= UTILS_MATCH_CF_GAUGE_LAST;
213 else if (strncasecmp ("Counter", ci->values[0].value.string,
214 strlen ("Counter")) == 0)
216 dstype = UTILS_MATCH_DS_TYPE_COUNTER;
217 if (strcasecmp ("CounterSet", ci->values[0].value.string) == 0)
218 dstype |= UTILS_MATCH_CF_COUNTER_SET;
219 else if (strcasecmp ("CounterAdd", ci->values[0].value.string) == 0)
220 dstype |= UTILS_MATCH_CF_COUNTER_ADD;
221 else if (strcasecmp ("CounterInc", ci->values[0].value.string) == 0)
222 dstype |= UTILS_MATCH_CF_COUNTER_INC;
226 else if (strncasecmp ("Derive", ci->values[0].value.string,
227 strlen ("Derive")) == 0)
229 dstype = UTILS_MATCH_DS_TYPE_DERIVE;
230 if (strcasecmp ("DeriveSet", ci->values[0].value.string) == 0)
231 dstype |= UTILS_MATCH_CF_DERIVE_SET;
232 else if (strcasecmp ("DeriveAdd", ci->values[0].value.string) == 0)
233 dstype |= UTILS_MATCH_CF_DERIVE_ADD;
234 else if (strcasecmp ("DeriveInc", ci->values[0].value.string) == 0)
235 dstype |= UTILS_MATCH_CF_DERIVE_INC;
239 else if (strncasecmp ("Absolute", ci->values[0].value.string,
240 strlen ("Absolute")) == 0)
242 dstype = UTILS_MATCH_DS_TYPE_ABSOLUTE;
243 if (strcasecmp ("AbsoluteSet", ci->values[0].value.string) == 0) /* Absolute DS is reset-on-read so no sense doin anything else but set */
244 dstype |= UTILS_MATCH_CF_ABSOLUTE_SET;
256 WARNING ("curl plugin: `%s' is not a valid argument to `DSType'.",
257 ci->values[0].value.string);
261 *dstype_ret = dstype;
263 } /* }}} int cc_config_add_match_dstype */
265 static int cc_config_add_match (web_page_t *page, /* {{{ */
272 if (ci->values_num != 0)
274 WARNING ("curl plugin: Ignoring arguments for the `Match' block.");
277 match = (web_match_t *) malloc (sizeof (*match));
280 ERROR ("curl plugin: malloc failed.");
283 memset (match, 0, sizeof (*match));
286 for (i = 0; i < ci->children_num; i++)
288 oconfig_item_t *child = ci->children + i;
290 if (strcasecmp ("Regex", child->key) == 0)
291 status = cc_config_add_string ("Regex", &match->regex, child);
292 else if (strcasecmp ("DSType", child->key) == 0)
293 status = cc_config_add_match_dstype (&match->dstype, child);
294 else if (strcasecmp ("Type", child->key) == 0)
295 status = cc_config_add_string ("Type", &match->type, child);
296 else if (strcasecmp ("Instance", child->key) == 0)
297 status = cc_config_add_string ("Instance", &match->instance, child);
300 WARNING ("curl plugin: Option `%s' not allowed here.", child->key);
306 } /* for (i = 0; i < ci->children_num; i++) */
310 if (match->regex == NULL)
312 WARNING ("curl plugin: `Regex' missing in `Match' block.");
316 if (match->type == NULL)
318 WARNING ("curl plugin: `Type' missing in `Match' block.");
322 if (match->dstype == 0)
324 WARNING ("curl plugin: `DSType' missing in `Match' block.");
329 } /* while (status == 0) */
334 match->match = match_create_simple (match->regex, match->dstype);
335 if (match->match == NULL)
337 ERROR ("curl plugin: tail_match_add_match_simple failed.");
338 cc_web_match_free (match);
345 prev = page->matches;
346 while ((prev != NULL) && (prev->next != NULL))
350 page->matches = match;
356 } /* }}} int cc_config_add_match */
358 static int cc_page_init_curl (web_page_t *wp) /* {{{ */
360 wp->curl = curl_easy_init ();
361 if (wp->curl == NULL)
363 ERROR ("curl plugin: curl_easy_init failed.");
367 curl_easy_setopt (wp->curl, CURLOPT_WRITEFUNCTION, cc_curl_callback);
368 curl_easy_setopt (wp->curl, CURLOPT_WRITEDATA, wp);
369 curl_easy_setopt (wp->curl, CURLOPT_USERAGENT,
370 PACKAGE_NAME"/"PACKAGE_VERSION);
371 curl_easy_setopt (wp->curl, CURLOPT_ERRORBUFFER, wp->curl_errbuf);
372 curl_easy_setopt (wp->curl, CURLOPT_URL, wp->url);
373 curl_easy_setopt (wp->curl, CURLOPT_FOLLOWLOCATION, 1);
375 if (wp->user != NULL)
377 size_t credentials_size;
379 credentials_size = strlen (wp->user) + 2;
380 if (wp->pass != NULL)
381 credentials_size += strlen (wp->pass);
383 wp->credentials = (char *) malloc (credentials_size);
384 if (wp->credentials == NULL)
386 ERROR ("curl plugin: malloc failed.");
390 ssnprintf (wp->credentials, credentials_size, "%s:%s",
391 wp->user, (wp->pass == NULL) ? "" : wp->pass);
392 curl_easy_setopt (wp->curl, CURLOPT_USERPWD, wp->credentials);
395 curl_easy_setopt (wp->curl, CURLOPT_SSL_VERIFYPEER, wp->verify_peer);
396 curl_easy_setopt (wp->curl, CURLOPT_SSL_VERIFYHOST,
397 wp->verify_host ? 2 : 0);
398 if (wp->cacert != NULL)
399 curl_easy_setopt (wp->curl, CURLOPT_CAINFO, wp->cacert);
402 } /* }}} int cc_page_init_curl */
404 static int cc_config_add_page (oconfig_item_t *ci) /* {{{ */
410 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
412 WARNING ("curl plugin: `Page' blocks need exactly one string argument.");
416 page = (web_page_t *) malloc (sizeof (*page));
419 ERROR ("curl plugin: malloc failed.");
422 memset (page, 0, sizeof (*page));
426 page->verify_peer = 1;
427 page->verify_host = 1;
428 page->response_time = 0;
430 page->instance = strdup (ci->values[0].value.string);
431 if (page->instance == NULL)
433 ERROR ("curl plugin: strdup failed.");
438 /* Process all children */
440 for (i = 0; i < ci->children_num; i++)
442 oconfig_item_t *child = ci->children + i;
444 if (strcasecmp ("URL", child->key) == 0)
445 status = cc_config_add_string ("URL", &page->url, child);
446 else if (strcasecmp ("User", child->key) == 0)
447 status = cc_config_add_string ("User", &page->user, child);
448 else if (strcasecmp ("Password", child->key) == 0)
449 status = cc_config_add_string ("Password", &page->pass, child);
450 else if (strcasecmp ("VerifyPeer", child->key) == 0)
451 status = cc_config_set_boolean ("VerifyPeer", &page->verify_peer, child);
452 else if (strcasecmp ("VerifyHost", child->key) == 0)
453 status = cc_config_set_boolean ("VerifyHost", &page->verify_host, child);
454 else if (strcasecmp ("MeasureResponseTime", child->key) == 0)
455 status = cc_config_set_boolean (child->key, &page->response_time, child);
456 else if (strcasecmp ("CACert", child->key) == 0)
457 status = cc_config_add_string ("CACert", &page->cacert, child);
458 else if (strcasecmp ("Match", child->key) == 0)
459 /* Be liberal with failing matches => don't set `status'. */
460 cc_config_add_match (page, child);
463 WARNING ("curl plugin: Option `%s' not allowed here.", child->key);
469 } /* for (i = 0; i < ci->children_num; i++) */
471 /* Additionial sanity checks and libCURL initialization. */
474 if (page->url == NULL)
476 WARNING ("curl plugin: `URL' missing in `Page' block.");
480 if (page->matches == NULL && !page->response_time)
482 assert (page->instance != NULL);
483 WARNING ("curl plugin: No (valid) `Match' block "
484 "or MeasureResponseTime within `Page' block `%s'.", page->instance);
489 status = cc_page_init_curl (page);
492 } /* while (status == 0) */
496 cc_web_page_free (page);
500 /* Add the new page to the linked list */
508 while ((prev != NULL) && (prev->next != NULL))
514 } /* }}} int cc_config_add_page */
516 static int cc_config (oconfig_item_t *ci) /* {{{ */
526 for (i = 0; i < ci->children_num; i++)
528 oconfig_item_t *child = ci->children + i;
530 if (strcasecmp ("Page", child->key) == 0)
532 status = cc_config_add_page (child);
540 WARNING ("curl plugin: Option `%s' not allowed here.", child->key);
545 if ((success == 0) && (errors > 0))
547 ERROR ("curl plugin: All statements failed.");
552 } /* }}} int cc_config */
554 static int cc_init (void) /* {{{ */
558 INFO ("curl plugin: No pages have been defined.");
562 } /* }}} int cc_init */
564 static void cc_submit (const web_page_t *wp, const web_match_t *wm, /* {{{ */
565 const cu_match_value_t *mv)
568 value_list_t vl = VALUE_LIST_INIT;
570 values[0] = mv->value;
574 vl.time = time (NULL);
575 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
576 sstrncpy (vl.plugin, "curl", sizeof (vl.plugin));
577 sstrncpy (vl.plugin_instance, wp->instance, sizeof (vl.plugin_instance));
578 sstrncpy (vl.type, wm->type, sizeof (vl.type));
579 sstrncpy (vl.type_instance, wm->instance, sizeof (vl.type_instance));
581 plugin_dispatch_values (&vl);
582 } /* }}} void cc_submit */
584 static void cc_submit_response_time (const web_page_t *wp, double seconds) /* {{{ */
587 value_list_t vl = VALUE_LIST_INIT;
589 values[0].gauge = seconds;
593 vl.time = time (NULL);
594 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
595 sstrncpy (vl.plugin, "curl", sizeof (vl.plugin));
596 sstrncpy (vl.plugin_instance, wp->instance, sizeof (vl.plugin_instance));
597 sstrncpy (vl.type, "response_time", sizeof (vl.type));
599 plugin_dispatch_values (&vl);
600 } /* }}} void cc_submit_response_time */
602 static int cc_read_page (web_page_t *wp) /* {{{ */
606 struct timeval start, end;
608 if (wp->response_time)
609 gettimeofday (&start, NULL);
612 status = curl_easy_perform (wp->curl);
615 ERROR ("curl plugin: curl_easy_perform failed with staus %i: %s",
616 status, wp->curl_errbuf);
620 if (wp->response_time)
623 gettimeofday (&end, NULL);
624 secs += end.tv_sec - start.tv_sec;
625 secs += (end.tv_usec - start.tv_usec) / 1000000.0;
626 cc_submit_response_time (wp, secs);
629 for (wm = wp->matches; wm != NULL; wm = wm->next)
631 cu_match_value_t *mv;
633 status = match_apply (wm->match, wp->buffer);
636 WARNING ("curl plugin: match_apply failed.");
640 mv = match_get_user_data (wm->match);
643 WARNING ("curl plugin: match_get_user_data returned NULL.");
647 cc_submit (wp, wm, mv);
648 } /* for (wm = wp->matches; wm != NULL; wm = wm->next) */
651 } /* }}} int cc_read_page */
653 static int cc_read (void) /* {{{ */
657 for (wp = pages_g; wp != NULL; wp = wp->next)
661 } /* }}} int cc_read */
663 static int cc_shutdown (void) /* {{{ */
665 cc_web_page_free (pages_g);
669 } /* }}} int cc_shutdown */
671 void module_register (void)
673 plugin_register_complex_config ("curl", cc_config);
674 plugin_register_init ("curl", cc_init);
675 plugin_register_read ("curl", cc_read);
676 plugin_register_shutdown ("curl", cc_shutdown);
677 } /* void module_register */
679 /* vim: set sw=2 sts=2 et fdm=marker : */