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 collectd.org>
21 * Aman Gupta <aman at tmm1.net>
28 #include "utils_curl_stats.h"
29 #include "utils_match.h"
30 #include "utils_time.h"
32 #include <curl/curl.h>
38 typedef struct web_match_s web_match_t;
39 struct web_match_s /* {{{ */
53 typedef struct web_page_s web_page_t;
54 struct web_page_s /* {{{ */
66 struct curl_slist *headers;
74 char curl_errbuf[CURL_ERROR_SIZE];
87 /* static CURLM *curl = NULL; */
88 static web_page_t *pages_g = NULL;
93 static size_t cc_curl_callback (void *buf, /* {{{ */
94 size_t size, size_t nmemb, void *user_data)
107 if ((wp->buffer_fill + len) >= wp->buffer_size)
112 temp_size = wp->buffer_fill + len + 1;
113 temp = realloc (wp->buffer, temp_size);
116 ERROR ("curl plugin: realloc failed.");
120 wp->buffer_size = temp_size;
123 memcpy (wp->buffer + wp->buffer_fill, (char *) buf, len);
124 wp->buffer_fill += len;
125 wp->buffer[wp->buffer_fill] = 0;
128 } /* }}} size_t cc_curl_callback */
130 static void cc_web_match_free (web_match_t *wm) /* {{{ */
137 sfree (wm->instance);
138 match_destroy (wm->match);
139 cc_web_match_free (wm->next);
141 } /* }}} void cc_web_match_free */
143 static void cc_web_page_free (web_page_t *wp) /* {{{ */
148 if (wp->curl != NULL)
149 curl_easy_cleanup (wp->curl);
152 sfree (wp->instance);
157 sfree (wp->credentials);
159 sfree (wp->post_body);
160 curl_slist_free_all (wp->headers);
161 curl_stats_destroy (wp->stats);
165 cc_web_match_free (wp->matches);
166 cc_web_page_free (wp->next);
168 } /* }}} void cc_web_page_free */
170 static int cc_config_append_string (const char *name, struct curl_slist **dest, /* {{{ */
173 struct curl_slist *temp = NULL;
174 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
176 WARNING ("curl plugin: `%s' needs exactly one string argument.", name);
180 temp = curl_slist_append(*dest, ci->values[0].value.string);
187 } /* }}} int cc_config_append_string */
189 static int cc_config_add_match_dstype (int *dstype_ret, /* {{{ */
194 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
196 WARNING ("curl plugin: `DSType' needs exactly one string argument.");
200 if (strncasecmp ("Gauge", ci->values[0].value.string,
201 strlen ("Gauge")) == 0)
203 dstype = UTILS_MATCH_DS_TYPE_GAUGE;
204 if (strcasecmp ("GaugeAverage", ci->values[0].value.string) == 0)
205 dstype |= UTILS_MATCH_CF_GAUGE_AVERAGE;
206 else if (strcasecmp ("GaugeMin", ci->values[0].value.string) == 0)
207 dstype |= UTILS_MATCH_CF_GAUGE_MIN;
208 else if (strcasecmp ("GaugeMax", ci->values[0].value.string) == 0)
209 dstype |= UTILS_MATCH_CF_GAUGE_MAX;
210 else if (strcasecmp ("GaugeLast", ci->values[0].value.string) == 0)
211 dstype |= UTILS_MATCH_CF_GAUGE_LAST;
215 else if (strncasecmp ("Counter", ci->values[0].value.string,
216 strlen ("Counter")) == 0)
218 dstype = UTILS_MATCH_DS_TYPE_COUNTER;
219 if (strcasecmp ("CounterSet", ci->values[0].value.string) == 0)
220 dstype |= UTILS_MATCH_CF_COUNTER_SET;
221 else if (strcasecmp ("CounterAdd", ci->values[0].value.string) == 0)
222 dstype |= UTILS_MATCH_CF_COUNTER_ADD;
223 else if (strcasecmp ("CounterInc", ci->values[0].value.string) == 0)
224 dstype |= UTILS_MATCH_CF_COUNTER_INC;
228 else if (strncasecmp ("Derive", ci->values[0].value.string,
229 strlen ("Derive")) == 0)
231 dstype = UTILS_MATCH_DS_TYPE_DERIVE;
232 if (strcasecmp ("DeriveSet", ci->values[0].value.string) == 0)
233 dstype |= UTILS_MATCH_CF_DERIVE_SET;
234 else if (strcasecmp ("DeriveAdd", ci->values[0].value.string) == 0)
235 dstype |= UTILS_MATCH_CF_DERIVE_ADD;
236 else if (strcasecmp ("DeriveInc", ci->values[0].value.string) == 0)
237 dstype |= UTILS_MATCH_CF_DERIVE_INC;
241 else if (strncasecmp ("Absolute", ci->values[0].value.string,
242 strlen ("Absolute")) == 0)
244 dstype = UTILS_MATCH_DS_TYPE_ABSOLUTE;
245 if (strcasecmp ("AbsoluteSet", ci->values[0].value.string) == 0) /* Absolute DS is reset-on-read so no sense doin anything else but set */
246 dstype |= UTILS_MATCH_CF_ABSOLUTE_SET;
258 WARNING ("curl plugin: `%s' is not a valid argument to `DSType'.",
259 ci->values[0].value.string);
263 *dstype_ret = dstype;
265 } /* }}} int cc_config_add_match_dstype */
267 static int cc_config_add_match (web_page_t *page, /* {{{ */
273 if (ci->values_num != 0)
275 WARNING ("curl plugin: Ignoring arguments for the `Match' block.");
278 match = calloc (1, sizeof (*match));
281 ERROR ("curl plugin: calloc failed.");
286 for (int i = 0; i < ci->children_num; i++)
288 oconfig_item_t *child = ci->children + i;
290 if (strcasecmp ("Regex", child->key) == 0)
291 status = cf_util_get_string (child, &match->regex);
292 else if (strcasecmp ("ExcludeRegex", child->key) == 0)
293 status = cf_util_get_string (child, &match->exclude_regex);
294 else if (strcasecmp ("DSType", child->key) == 0)
295 status = cc_config_add_match_dstype (&match->dstype, child);
296 else if (strcasecmp ("Type", child->key) == 0)
297 status = cf_util_get_string (child, &match->type);
298 else if (strcasecmp ("Instance", child->key) == 0)
299 status = cf_util_get_string (child, &match->instance);
302 WARNING ("curl plugin: Option `%s' not allowed here.", child->key);
308 } /* for (i = 0; i < ci->children_num; i++) */
312 if (match->regex == NULL)
314 WARNING ("curl plugin: `Regex' missing in `Match' block.");
318 if (match->type == NULL)
320 WARNING ("curl plugin: `Type' missing in `Match' block.");
324 if (match->dstype == 0)
326 WARNING ("curl plugin: `DSType' missing in `Match' block.");
331 } /* while (status == 0) */
335 cc_web_match_free (match);
339 match->match = match_create_simple (match->regex, match->exclude_regex,
341 if (match->match == NULL)
343 ERROR ("curl plugin: match_create_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, 1L);
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, COLLECTD_USERAGENT);
377 curl_easy_setopt (wp->curl, CURLOPT_ERRORBUFFER, wp->curl_errbuf);
378 curl_easy_setopt (wp->curl, CURLOPT_URL, wp->url);
379 curl_easy_setopt (wp->curl, CURLOPT_FOLLOWLOCATION, 1L);
380 curl_easy_setopt (wp->curl, CURLOPT_MAXREDIRS, 50L);
382 if (wp->user != NULL)
384 #ifdef HAVE_CURLOPT_USERNAME
385 curl_easy_setopt (wp->curl, CURLOPT_USERNAME, wp->user);
386 curl_easy_setopt (wp->curl, CURLOPT_PASSWORD,
387 (wp->pass == NULL) ? "" : wp->pass);
389 size_t credentials_size;
391 credentials_size = strlen (wp->user) + 2;
392 if (wp->pass != NULL)
393 credentials_size += strlen (wp->pass);
395 wp->credentials = malloc (credentials_size);
396 if (wp->credentials == NULL)
398 ERROR ("curl plugin: malloc failed.");
402 ssnprintf (wp->credentials, credentials_size, "%s:%s",
403 wp->user, (wp->pass == NULL) ? "" : wp->pass);
404 curl_easy_setopt (wp->curl, CURLOPT_USERPWD, wp->credentials);
408 curl_easy_setopt (wp->curl, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST);
411 curl_easy_setopt (wp->curl, CURLOPT_SSL_VERIFYPEER, (long) wp->verify_peer);
412 curl_easy_setopt (wp->curl, CURLOPT_SSL_VERIFYHOST,
413 wp->verify_host ? 2L : 0L);
414 if (wp->cacert != NULL)
415 curl_easy_setopt (wp->curl, CURLOPT_CAINFO, wp->cacert);
416 if (wp->headers != NULL)
417 curl_easy_setopt (wp->curl, CURLOPT_HTTPHEADER, wp->headers);
418 if (wp->post_body != NULL)
419 curl_easy_setopt (wp->curl, CURLOPT_POSTFIELDS, wp->post_body);
421 #ifdef HAVE_CURLOPT_TIMEOUT_MS
422 if (wp->timeout >= 0)
423 curl_easy_setopt (wp->curl, CURLOPT_TIMEOUT_MS, (long) wp->timeout);
425 curl_easy_setopt (wp->curl, CURLOPT_TIMEOUT_MS, (long) CDTIME_T_TO_MS(plugin_get_interval()));
429 } /* }}} int cc_page_init_curl */
431 static int cc_config_add_page (oconfig_item_t *ci) /* {{{ */
436 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
438 WARNING ("curl plugin: `Page' blocks need exactly one string argument.");
442 page = calloc (1, sizeof (*page));
445 ERROR ("curl plugin: calloc failed.");
452 page->verify_peer = 1;
453 page->verify_host = 1;
454 page->response_time = 0;
455 page->response_code = 0;
459 page->instance = strdup (ci->values[0].value.string);
460 if (page->instance == NULL)
462 ERROR ("curl plugin: strdup failed.");
467 /* Process all children */
469 for (int i = 0; i < ci->children_num; i++)
471 oconfig_item_t *child = ci->children + i;
473 if (strcasecmp ("URL", child->key) == 0)
474 status = cf_util_get_string (child, &page->url);
475 else if (strcasecmp ("User", child->key) == 0)
476 status = cf_util_get_string (child, &page->user);
477 else if (strcasecmp ("Password", child->key) == 0)
478 status = cf_util_get_string (child, &page->pass);
479 else if (strcasecmp ("Digest", child->key) == 0)
480 status = cf_util_get_boolean (child, &page->digest);
481 else if (strcasecmp ("VerifyPeer", child->key) == 0)
482 status = cf_util_get_boolean (child, &page->verify_peer);
483 else if (strcasecmp ("VerifyHost", child->key) == 0)
484 status = cf_util_get_boolean (child, &page->verify_host);
485 else if (strcasecmp ("MeasureResponseTime", child->key) == 0)
486 status = cf_util_get_boolean (child, &page->response_time);
487 else if (strcasecmp ("MeasureResponseCode", child->key) == 0)
488 status = cf_util_get_boolean (child, &page->response_code);
489 else if (strcasecmp ("CACert", child->key) == 0)
490 status = cf_util_get_string (child, &page->cacert);
491 else if (strcasecmp ("Match", child->key) == 0)
492 /* Be liberal with failing matches => don't set `status'. */
493 cc_config_add_match (page, child);
494 else if (strcasecmp ("Header", child->key) == 0)
495 status = cc_config_append_string ("Header", &page->headers, child);
496 else if (strcasecmp ("Post", child->key) == 0)
497 status = cf_util_get_string (child, &page->post_body);
498 else if (strcasecmp ("Timeout", child->key) == 0)
499 status = cf_util_get_int (child, &page->timeout);
500 else if (strcasecmp ("Statistics", child->key) == 0) {
501 page->stats = curl_stats_from_config (child);
502 if (page->stats == NULL)
507 WARNING ("curl plugin: Option `%s' not allowed here.", child->key);
513 } /* for (i = 0; i < ci->children_num; i++) */
515 /* Additionial sanity checks and libCURL initialization. */
518 if (page->url == NULL)
520 WARNING ("curl plugin: `URL' missing in `Page' block.");
524 if (page->matches == NULL && page->stats == NULL
525 && !page->response_time && !page->response_code)
527 assert (page->instance != NULL);
528 WARNING ("curl plugin: No (valid) `Match' block "
529 "or Statistics or MeasureResponseTime or MeasureResponseCode "
530 "within `Page' block `%s'.", page->instance);
535 status = cc_page_init_curl (page);
538 } /* while (status == 0) */
542 cc_web_page_free (page);
546 /* Add the new page to the linked list */
554 while (prev->next != NULL)
560 } /* }}} int cc_config_add_page */
562 static int cc_config (oconfig_item_t *ci) /* {{{ */
571 for (int i = 0; i < ci->children_num; i++)
573 oconfig_item_t *child = ci->children + i;
575 if (strcasecmp ("Page", child->key) == 0)
577 status = cc_config_add_page (child);
585 WARNING ("curl plugin: Option `%s' not allowed here.", child->key);
590 if ((success == 0) && (errors > 0))
592 ERROR ("curl plugin: All statements failed.");
597 } /* }}} int cc_config */
599 static int cc_init (void) /* {{{ */
603 INFO ("curl plugin: No pages have been defined.");
606 curl_global_init (CURL_GLOBAL_SSL);
608 } /* }}} int cc_init */
610 static void cc_submit (const web_page_t *wp, const web_match_t *wm, /* {{{ */
613 value_list_t vl = VALUE_LIST_INIT;
617 sstrncpy (vl.plugin, "curl", sizeof (vl.plugin));
618 sstrncpy (vl.plugin_instance, wp->instance, sizeof (vl.plugin_instance));
619 sstrncpy (vl.type, wm->type, sizeof (vl.type));
620 if (wm->instance != NULL)
621 sstrncpy (vl.type_instance, wm->instance, sizeof (vl.type_instance));
623 plugin_dispatch_values (&vl);
624 } /* }}} void cc_submit */
626 static void cc_submit_response_code (const web_page_t *wp, long code) /* {{{ */
628 value_list_t vl = VALUE_LIST_INIT;
630 vl.values = &(value_t) { .gauge = (gauge_t) code };
632 sstrncpy (vl.plugin, "curl", sizeof (vl.plugin));
633 sstrncpy (vl.plugin_instance, wp->instance, sizeof (vl.plugin_instance));
634 sstrncpy (vl.type, "response_code", sizeof (vl.type));
636 plugin_dispatch_values (&vl);
637 } /* }}} void cc_submit_response_code */
639 static void cc_submit_response_time (const web_page_t *wp, /* {{{ */
640 gauge_t response_time)
642 value_list_t vl = VALUE_LIST_INIT;
644 vl.values = &(value_t) { .gauge = response_time };
646 sstrncpy (vl.plugin, "curl", sizeof (vl.plugin));
647 sstrncpy (vl.plugin_instance, wp->instance, sizeof (vl.plugin_instance));
648 sstrncpy (vl.type, "response_time", sizeof (vl.type));
650 plugin_dispatch_values (&vl);
651 } /* }}} void cc_submit_response_time */
653 static int cc_read_page (web_page_t *wp) /* {{{ */
658 if (wp->response_time)
662 status = curl_easy_perform (wp->curl);
663 if (status != CURLE_OK)
665 ERROR ("curl plugin: curl_easy_perform failed with status %i: %s",
666 status, wp->curl_errbuf);
670 if (wp->response_time)
671 cc_submit_response_time (wp, CDTIME_T_TO_DOUBLE (cdtime() - start));
672 if (wp->stats != NULL)
673 curl_stats_dispatch (wp->stats, wp->curl, hostname_g, "curl", wp->instance);
675 if(wp->response_code)
677 long response_code = 0;
678 status = curl_easy_getinfo(wp->curl, CURLINFO_RESPONSE_CODE, &response_code);
679 if(status != CURLE_OK) {
680 ERROR ("curl plugin: Fetching response code failed with status %i: %s",
681 status, wp->curl_errbuf);
683 cc_submit_response_code(wp, response_code);
687 for (web_match_t *wm = wp->matches; wm != NULL; wm = wm->next)
689 cu_match_value_t *mv;
691 status = match_apply (wm->match, wp->buffer);
694 WARNING ("curl plugin: match_apply failed.");
698 mv = match_get_user_data (wm->match);
701 WARNING ("curl plugin: match_get_user_data returned NULL.");
705 cc_submit (wp, wm, mv->value);
706 match_value_reset (mv);
707 } /* for (wm = wp->matches; wm != NULL; wm = wm->next) */
710 } /* }}} int cc_read_page */
712 static int cc_read (void) /* {{{ */
714 for (web_page_t *wp = pages_g; wp != NULL; wp = wp->next)
718 } /* }}} int cc_read */
720 static int cc_shutdown (void) /* {{{ */
722 cc_web_page_free (pages_g);
726 } /* }}} int cc_shutdown */
728 void module_register (void)
730 plugin_register_complex_config ("curl", cc_config);
731 plugin_register_init ("curl", cc_init);
732 plugin_register_read ("curl", cc_read);
733 plugin_register_shutdown ("curl", cc_shutdown);
734 } /* void module_register */
736 /* vim: set sw=2 sts=2 et fdm=marker : */