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"
29 #include "utils_time.h"
31 #include <curl/curl.h>
37 typedef struct web_match_s web_match_t;
38 struct web_match_s /* {{{ */
52 typedef struct web_page_s web_page_t;
53 struct web_page_s /* {{{ */
64 struct curl_slist *headers;
70 char curl_errbuf[CURL_ERROR_SIZE];
83 /* static CURLM *curl = NULL; */
84 static web_page_t *pages_g = NULL;
89 static size_t cc_curl_callback (void *buf, /* {{{ */
90 size_t size, size_t nmemb, void *user_data)
103 if ((wp->buffer_fill + len) >= wp->buffer_size)
108 temp_size = wp->buffer_fill + len + 1;
109 temp = (char *) realloc (wp->buffer, temp_size);
112 ERROR ("curl plugin: realloc failed.");
116 wp->buffer_size = temp_size;
119 memcpy (wp->buffer + wp->buffer_fill, (char *) buf, len);
120 wp->buffer_fill += len;
121 wp->buffer[wp->buffer_fill] = 0;
124 } /* }}} size_t cc_curl_callback */
126 static void cc_web_match_free (web_match_t *wm) /* {{{ */
133 sfree (wm->instance);
134 match_destroy (wm->match);
135 cc_web_match_free (wm->next);
137 } /* }}} void cc_web_match_free */
139 static void cc_web_page_free (web_page_t *wp) /* {{{ */
144 if (wp->curl != NULL)
145 curl_easy_cleanup (wp->curl);
148 sfree (wp->instance);
153 sfree (wp->credentials);
155 sfree (wp->post_body);
156 curl_slist_free_all (wp->headers);
160 cc_web_match_free (wp->matches);
161 cc_web_page_free (wp->next);
163 } /* }}} void cc_web_page_free */
165 static int cc_config_append_string (const char *name, struct curl_slist **dest, /* {{{ */
168 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
170 WARNING ("curl plugin: `%s' needs exactly one string argument.", name);
174 *dest = curl_slist_append(*dest, ci->values[0].value.string);
179 } /* }}} int cc_config_append_string */
181 static int cc_config_add_match_dstype (int *dstype_ret, /* {{{ */
186 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
188 WARNING ("curl plugin: `DSType' needs exactly one string argument.");
192 if (strncasecmp ("Gauge", ci->values[0].value.string,
193 strlen ("Gauge")) == 0)
195 dstype = UTILS_MATCH_DS_TYPE_GAUGE;
196 if (strcasecmp ("GaugeAverage", ci->values[0].value.string) == 0)
197 dstype |= UTILS_MATCH_CF_GAUGE_AVERAGE;
198 else if (strcasecmp ("GaugeMin", ci->values[0].value.string) == 0)
199 dstype |= UTILS_MATCH_CF_GAUGE_MIN;
200 else if (strcasecmp ("GaugeMax", ci->values[0].value.string) == 0)
201 dstype |= UTILS_MATCH_CF_GAUGE_MAX;
202 else if (strcasecmp ("GaugeLast", ci->values[0].value.string) == 0)
203 dstype |= UTILS_MATCH_CF_GAUGE_LAST;
207 else if (strncasecmp ("Counter", ci->values[0].value.string,
208 strlen ("Counter")) == 0)
210 dstype = UTILS_MATCH_DS_TYPE_COUNTER;
211 if (strcasecmp ("CounterSet", ci->values[0].value.string) == 0)
212 dstype |= UTILS_MATCH_CF_COUNTER_SET;
213 else if (strcasecmp ("CounterAdd", ci->values[0].value.string) == 0)
214 dstype |= UTILS_MATCH_CF_COUNTER_ADD;
215 else if (strcasecmp ("CounterInc", ci->values[0].value.string) == 0)
216 dstype |= UTILS_MATCH_CF_COUNTER_INC;
220 else if (strncasecmp ("Derive", ci->values[0].value.string,
221 strlen ("Derive")) == 0)
223 dstype = UTILS_MATCH_DS_TYPE_DERIVE;
224 if (strcasecmp ("DeriveSet", ci->values[0].value.string) == 0)
225 dstype |= UTILS_MATCH_CF_DERIVE_SET;
226 else if (strcasecmp ("DeriveAdd", ci->values[0].value.string) == 0)
227 dstype |= UTILS_MATCH_CF_DERIVE_ADD;
228 else if (strcasecmp ("DeriveInc", ci->values[0].value.string) == 0)
229 dstype |= UTILS_MATCH_CF_DERIVE_INC;
233 else if (strncasecmp ("Absolute", ci->values[0].value.string,
234 strlen ("Absolute")) == 0)
236 dstype = UTILS_MATCH_DS_TYPE_ABSOLUTE;
237 if (strcasecmp ("AbsoluteSet", ci->values[0].value.string) == 0) /* Absolute DS is reset-on-read so no sense doin anything else but set */
238 dstype |= UTILS_MATCH_CF_ABSOLUTE_SET;
250 WARNING ("curl plugin: `%s' is not a valid argument to `DSType'.",
251 ci->values[0].value.string);
255 *dstype_ret = dstype;
257 } /* }}} int cc_config_add_match_dstype */
259 static int cc_config_add_match (web_page_t *page, /* {{{ */
266 if (ci->values_num != 0)
268 WARNING ("curl plugin: Ignoring arguments for the `Match' block.");
271 match = (web_match_t *) malloc (sizeof (*match));
274 ERROR ("curl plugin: malloc failed.");
277 memset (match, 0, sizeof (*match));
280 for (i = 0; i < ci->children_num; i++)
282 oconfig_item_t *child = ci->children + i;
284 if (strcasecmp ("Regex", child->key) == 0)
285 status = cf_util_get_string (child, &match->regex);
286 else if (strcasecmp ("ExcludeRegex", child->key) == 0)
287 status = cf_util_get_string (child, &match->exclude_regex);
288 else if (strcasecmp ("DSType", child->key) == 0)
289 status = cc_config_add_match_dstype (&match->dstype, child);
290 else if (strcasecmp ("Type", child->key) == 0)
291 status = cf_util_get_string (child, &match->type);
292 else if (strcasecmp ("Instance", child->key) == 0)
293 status = cf_util_get_string (child, &match->instance);
296 WARNING ("curl plugin: Option `%s' not allowed here.", child->key);
302 } /* for (i = 0; i < ci->children_num; i++) */
306 if (match->regex == NULL)
308 WARNING ("curl plugin: `Regex' missing in `Match' block.");
312 if (match->type == NULL)
314 WARNING ("curl plugin: `Type' missing in `Match' block.");
318 if (match->dstype == 0)
320 WARNING ("curl plugin: `DSType' missing in `Match' block.");
325 } /* while (status == 0) */
330 match->match = match_create_simple (match->regex, match->exclude_regex,
332 if (match->match == NULL)
334 ERROR ("curl plugin: tail_match_add_match_simple failed.");
335 cc_web_match_free (match);
342 prev = page->matches;
343 while ((prev != NULL) && (prev->next != NULL))
347 page->matches = match;
353 } /* }}} int cc_config_add_match */
355 static int cc_page_init_curl (web_page_t *wp) /* {{{ */
357 wp->curl = curl_easy_init ();
358 if (wp->curl == NULL)
360 ERROR ("curl plugin: curl_easy_init failed.");
364 curl_easy_setopt (wp->curl, CURLOPT_NOSIGNAL, 1L);
365 curl_easy_setopt (wp->curl, CURLOPT_WRITEFUNCTION, cc_curl_callback);
366 curl_easy_setopt (wp->curl, CURLOPT_WRITEDATA, wp);
367 curl_easy_setopt (wp->curl, CURLOPT_USERAGENT,
368 PACKAGE_NAME"/"PACKAGE_VERSION);
369 curl_easy_setopt (wp->curl, CURLOPT_ERRORBUFFER, wp->curl_errbuf);
370 curl_easy_setopt (wp->curl, CURLOPT_URL, wp->url);
371 curl_easy_setopt (wp->curl, CURLOPT_FOLLOWLOCATION, 1L);
372 curl_easy_setopt (wp->curl, CURLOPT_MAXREDIRS, 50L);
374 if (wp->user != NULL)
376 size_t credentials_size;
378 credentials_size = strlen (wp->user) + 2;
379 if (wp->pass != NULL)
380 credentials_size += strlen (wp->pass);
382 wp->credentials = (char *) malloc (credentials_size);
383 if (wp->credentials == NULL)
385 ERROR ("curl plugin: malloc failed.");
389 ssnprintf (wp->credentials, credentials_size, "%s:%s",
390 wp->user, (wp->pass == NULL) ? "" : wp->pass);
391 curl_easy_setopt (wp->curl, CURLOPT_USERPWD, wp->credentials);
394 curl_easy_setopt (wp->curl, CURLOPT_SSL_VERIFYPEER, (long) wp->verify_peer);
395 curl_easy_setopt (wp->curl, CURLOPT_SSL_VERIFYHOST,
396 wp->verify_host ? 2L : 0L);
397 if (wp->cacert != NULL)
398 curl_easy_setopt (wp->curl, CURLOPT_CAINFO, wp->cacert);
399 if (wp->headers != NULL)
400 curl_easy_setopt (wp->curl, CURLOPT_HTTPHEADER, wp->headers);
401 if (wp->post_body != NULL)
402 curl_easy_setopt (wp->curl, CURLOPT_POSTFIELDS, wp->post_body);
405 } /* }}} int cc_page_init_curl */
407 static int cc_config_add_page (oconfig_item_t *ci) /* {{{ */
413 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
415 WARNING ("curl plugin: `Page' blocks need exactly one string argument.");
419 page = (web_page_t *) malloc (sizeof (*page));
422 ERROR ("curl plugin: malloc failed.");
425 memset (page, 0, sizeof (*page));
429 page->verify_peer = 1;
430 page->verify_host = 1;
431 page->response_time = 0;
432 page->response_code = 0;
434 page->instance = strdup (ci->values[0].value.string);
435 if (page->instance == NULL)
437 ERROR ("curl plugin: strdup failed.");
442 /* Process all children */
444 for (i = 0; i < ci->children_num; i++)
446 oconfig_item_t *child = ci->children + i;
448 if (strcasecmp ("URL", child->key) == 0)
449 status = cf_util_get_string (child, &page->url);
450 else if (strcasecmp ("User", child->key) == 0)
451 status = cf_util_get_string (child, &page->user);
452 else if (strcasecmp ("Password", child->key) == 0)
453 status = cf_util_get_string (child, &page->pass);
454 else if (strcasecmp ("VerifyPeer", child->key) == 0)
455 status = cf_util_get_boolean (child, &page->verify_peer);
456 else if (strcasecmp ("VerifyHost", child->key) == 0)
457 status = cf_util_get_boolean (child, &page->verify_host);
458 else if (strcasecmp ("MeasureResponseTime", child->key) == 0)
459 status = cf_util_get_boolean (child, &page->response_time);
460 else if (strcasecmp ("MeasureResponseCode", child->key) == 0)
461 status = cf_util_get_boolean (child, &page->response_code);
462 else if (strcasecmp ("CACert", child->key) == 0)
463 status = cf_util_get_string (child, &page->cacert);
464 else if (strcasecmp ("Match", child->key) == 0)
465 /* Be liberal with failing matches => don't set `status'. */
466 cc_config_add_match (page, child);
467 else if (strcasecmp ("Header", child->key) == 0)
468 status = cc_config_append_string ("Header", &page->headers, child);
469 else if (strcasecmp ("Post", child->key) == 0)
470 status = cf_util_get_string (child, &page->post_body);
473 WARNING ("curl plugin: Option `%s' not allowed here.", child->key);
479 } /* for (i = 0; i < ci->children_num; i++) */
481 /* Additionial sanity checks and libCURL initialization. */
484 if (page->url == NULL)
486 WARNING ("curl plugin: `URL' missing in `Page' block.");
490 if (page->matches == NULL && !page->response_time && !page->response_code)
492 assert (page->instance != NULL);
493 WARNING ("curl plugin: No (valid) `Match' block "
494 "or MeasureResponseTime or MeasureResponseCode within "
495 "`Page' block `%s'.", page->instance);
500 status = cc_page_init_curl (page);
503 } /* while (status == 0) */
507 cc_web_page_free (page);
511 /* Add the new page to the linked list */
519 while ((prev != NULL) && (prev->next != NULL))
525 } /* }}} int cc_config_add_page */
527 static int cc_config (oconfig_item_t *ci) /* {{{ */
537 for (i = 0; i < ci->children_num; i++)
539 oconfig_item_t *child = ci->children + i;
541 if (strcasecmp ("Page", child->key) == 0)
543 status = cc_config_add_page (child);
551 WARNING ("curl plugin: Option `%s' not allowed here.", child->key);
556 if ((success == 0) && (errors > 0))
558 ERROR ("curl plugin: All statements failed.");
563 } /* }}} int cc_config */
565 static int cc_init (void) /* {{{ */
569 INFO ("curl plugin: No pages have been defined.");
572 curl_global_init (CURL_GLOBAL_SSL);
574 } /* }}} int cc_init */
576 static void cc_submit (const web_page_t *wp, const web_match_t *wm, /* {{{ */
577 const cu_match_value_t *mv)
580 value_list_t vl = VALUE_LIST_INIT;
582 values[0] = mv->value;
586 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
587 sstrncpy (vl.plugin, "curl", sizeof (vl.plugin));
588 sstrncpy (vl.plugin_instance, wp->instance, sizeof (vl.plugin_instance));
589 sstrncpy (vl.type, wm->type, sizeof (vl.type));
590 if (wm->instance != NULL)
591 sstrncpy (vl.type_instance, wm->instance, sizeof (vl.type_instance));
593 plugin_dispatch_values (&vl);
594 } /* }}} void cc_submit */
596 static void cc_submit_response_code (const web_page_t *wp, long code) /* {{{ */
599 value_list_t vl = VALUE_LIST_INIT;
601 values[0].gauge = code;
605 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
606 sstrncpy (vl.plugin, "curl", sizeof (vl.plugin));
607 sstrncpy (vl.plugin_instance, wp->instance, sizeof (vl.plugin_instance));
608 sstrncpy (vl.type, "response_code", sizeof (vl.type));
610 plugin_dispatch_values (&vl);
611 } /* }}} void cc_submit_response_code */
613 static void cc_submit_response_time (const web_page_t *wp, /* {{{ */
614 cdtime_t response_time)
617 value_list_t vl = VALUE_LIST_INIT;
619 values[0].gauge = CDTIME_T_TO_DOUBLE (response_time);
623 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
624 sstrncpy (vl.plugin, "curl", sizeof (vl.plugin));
625 sstrncpy (vl.plugin_instance, wp->instance, sizeof (vl.plugin_instance));
626 sstrncpy (vl.type, "response_time", sizeof (vl.type));
628 plugin_dispatch_values (&vl);
629 } /* }}} void cc_submit_response_time */
631 static int cc_read_page (web_page_t *wp) /* {{{ */
637 if (wp->response_time)
641 status = curl_easy_perform (wp->curl);
642 if (status != CURLE_OK)
644 ERROR ("curl plugin: curl_easy_perform failed with staus %i: %s",
645 status, wp->curl_errbuf);
649 if (wp->response_time)
650 cc_submit_response_time (wp, cdtime() - start);
652 if(wp->response_code)
654 long response_code = 0;
655 status = curl_easy_getinfo(wp->curl, CURLINFO_RESPONSE_CODE, &response_code);
656 if(status != CURLE_OK) {
657 ERROR ("curl plugin: Fetching response code failed with staus %i: %s",
658 status, wp->curl_errbuf);
660 cc_submit_response_code(wp, response_code);
664 for (wm = wp->matches; wm != NULL; wm = wm->next)
666 cu_match_value_t *mv;
668 status = match_apply (wm->match, wp->buffer);
671 WARNING ("curl plugin: match_apply failed.");
675 mv = match_get_user_data (wm->match);
678 WARNING ("curl plugin: match_get_user_data returned NULL.");
682 cc_submit (wp, wm, mv);
683 match_value_reset (mv);
684 } /* for (wm = wp->matches; wm != NULL; wm = wm->next) */
687 } /* }}} int cc_read_page */
689 static int cc_read (void) /* {{{ */
693 for (wp = pages_g; wp != NULL; wp = wp->next)
697 } /* }}} int cc_read */
699 static int cc_shutdown (void) /* {{{ */
701 cc_web_page_free (pages_g);
705 } /* }}} int cc_shutdown */
707 void module_register (void)
709 plugin_register_complex_config ("curl", cc_config);
710 plugin_register_init ("curl", cc_init);
711 plugin_register_read ("curl", cc_read);
712 plugin_register_shutdown ("curl", cc_shutdown);
713 } /* void module_register */
715 /* vim: set sw=2 sts=2 et fdm=marker : */