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>
27 #include "configfile.h"
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, /* {{{ */
274 if (ci->values_num != 0)
276 WARNING ("curl plugin: Ignoring arguments for the `Match' block.");
279 match = calloc (1, sizeof (*match));
282 ERROR ("curl plugin: calloc failed.");
287 for (i = 0; i < ci->children_num; i++)
289 oconfig_item_t *child = ci->children + i;
291 if (strcasecmp ("Regex", child->key) == 0)
292 status = cf_util_get_string (child, &match->regex);
293 else if (strcasecmp ("ExcludeRegex", child->key) == 0)
294 status = cf_util_get_string (child, &match->exclude_regex);
295 else if (strcasecmp ("DSType", child->key) == 0)
296 status = cc_config_add_match_dstype (&match->dstype, child);
297 else if (strcasecmp ("Type", child->key) == 0)
298 status = cf_util_get_string (child, &match->type);
299 else if (strcasecmp ("Instance", child->key) == 0)
300 status = cf_util_get_string (child, &match->instance);
303 WARNING ("curl plugin: Option `%s' not allowed here.", child->key);
309 } /* for (i = 0; i < ci->children_num; i++) */
313 if (match->regex == NULL)
315 WARNING ("curl plugin: `Regex' missing in `Match' block.");
319 if (match->type == NULL)
321 WARNING ("curl plugin: `Type' missing in `Match' block.");
325 if (match->dstype == 0)
327 WARNING ("curl plugin: `DSType' missing in `Match' block.");
332 } /* while (status == 0) */
336 cc_web_match_free (match);
340 match->match = match_create_simple (match->regex, match->exclude_regex,
342 if (match->match == NULL)
344 ERROR ("curl plugin: tail_match_add_match_simple failed.");
345 cc_web_match_free (match);
352 prev = page->matches;
353 while ((prev != NULL) && (prev->next != NULL))
357 page->matches = match;
363 } /* }}} int cc_config_add_match */
365 static int cc_page_init_curl (web_page_t *wp) /* {{{ */
367 wp->curl = curl_easy_init ();
368 if (wp->curl == NULL)
370 ERROR ("curl plugin: curl_easy_init failed.");
374 curl_easy_setopt (wp->curl, CURLOPT_NOSIGNAL, 1L);
375 curl_easy_setopt (wp->curl, CURLOPT_WRITEFUNCTION, cc_curl_callback);
376 curl_easy_setopt (wp->curl, CURLOPT_WRITEDATA, wp);
377 curl_easy_setopt (wp->curl, CURLOPT_USERAGENT, COLLECTD_USERAGENT);
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, 1L);
381 curl_easy_setopt (wp->curl, CURLOPT_MAXREDIRS, 50L);
383 if (wp->user != NULL)
385 #ifdef HAVE_CURLOPT_USERNAME
386 curl_easy_setopt (wp->curl, CURLOPT_USERNAME, wp->user);
387 curl_easy_setopt (wp->curl, CURLOPT_PASSWORD,
388 (wp->pass == NULL) ? "" : wp->pass);
390 size_t credentials_size;
392 credentials_size = strlen (wp->user) + 2;
393 if (wp->pass != NULL)
394 credentials_size += strlen (wp->pass);
396 wp->credentials = malloc (credentials_size);
397 if (wp->credentials == NULL)
399 ERROR ("curl plugin: malloc failed.");
403 ssnprintf (wp->credentials, credentials_size, "%s:%s",
404 wp->user, (wp->pass == NULL) ? "" : wp->pass);
405 curl_easy_setopt (wp->curl, CURLOPT_USERPWD, wp->credentials);
409 curl_easy_setopt (wp->curl, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST);
412 curl_easy_setopt (wp->curl, CURLOPT_SSL_VERIFYPEER, (long) wp->verify_peer);
413 curl_easy_setopt (wp->curl, CURLOPT_SSL_VERIFYHOST,
414 wp->verify_host ? 2L : 0L);
415 if (wp->cacert != NULL)
416 curl_easy_setopt (wp->curl, CURLOPT_CAINFO, wp->cacert);
417 if (wp->headers != NULL)
418 curl_easy_setopt (wp->curl, CURLOPT_HTTPHEADER, wp->headers);
419 if (wp->post_body != NULL)
420 curl_easy_setopt (wp->curl, CURLOPT_POSTFIELDS, wp->post_body);
422 #ifdef HAVE_CURLOPT_TIMEOUT_MS
423 if (wp->timeout >= 0)
424 curl_easy_setopt (wp->curl, CURLOPT_TIMEOUT_MS, (long) wp->timeout);
426 curl_easy_setopt (wp->curl, CURLOPT_TIMEOUT_MS, (long) CDTIME_T_TO_MS(plugin_get_interval()));
430 } /* }}} int cc_page_init_curl */
432 static int cc_config_add_page (oconfig_item_t *ci) /* {{{ */
438 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
440 WARNING ("curl plugin: `Page' blocks need exactly one string argument.");
444 page = calloc (1, sizeof (*page));
447 ERROR ("curl plugin: calloc failed.");
454 page->verify_peer = 1;
455 page->verify_host = 1;
456 page->response_time = 0;
457 page->response_code = 0;
461 page->instance = strdup (ci->values[0].value.string);
462 if (page->instance == NULL)
464 ERROR ("curl plugin: strdup failed.");
469 /* Process all children */
471 for (i = 0; i < ci->children_num; i++)
473 oconfig_item_t *child = ci->children + i;
475 if (strcasecmp ("URL", child->key) == 0)
476 status = cf_util_get_string (child, &page->url);
477 else if (strcasecmp ("User", child->key) == 0)
478 status = cf_util_get_string (child, &page->user);
479 else if (strcasecmp ("Password", child->key) == 0)
480 status = cf_util_get_string (child, &page->pass);
481 else if (strcasecmp ("Digest", child->key) == 0)
482 status = cf_util_get_boolean (child, &page->digest);
483 else if (strcasecmp ("VerifyPeer", child->key) == 0)
484 status = cf_util_get_boolean (child, &page->verify_peer);
485 else if (strcasecmp ("VerifyHost", child->key) == 0)
486 status = cf_util_get_boolean (child, &page->verify_host);
487 else if (strcasecmp ("MeasureResponseTime", child->key) == 0)
488 status = cf_util_get_boolean (child, &page->response_time);
489 else if (strcasecmp ("MeasureResponseCode", child->key) == 0)
490 status = cf_util_get_boolean (child, &page->response_code);
491 else if (strcasecmp ("CACert", child->key) == 0)
492 status = cf_util_get_string (child, &page->cacert);
493 else if (strcasecmp ("Match", child->key) == 0)
494 /* Be liberal with failing matches => don't set `status'. */
495 cc_config_add_match (page, child);
496 else if (strcasecmp ("Header", child->key) == 0)
497 status = cc_config_append_string ("Header", &page->headers, child);
498 else if (strcasecmp ("Post", child->key) == 0)
499 status = cf_util_get_string (child, &page->post_body);
500 else if (strcasecmp ("Timeout", child->key) == 0)
501 status = cf_util_get_int (child, &page->timeout);
502 else if (strcasecmp ("Statistics", child->key) == 0) {
503 page->stats = curl_stats_from_config (child);
504 if (page->stats == NULL)
509 WARNING ("curl plugin: Option `%s' not allowed here.", child->key);
515 } /* for (i = 0; i < ci->children_num; i++) */
517 /* Additionial sanity checks and libCURL initialization. */
520 if (page->url == NULL)
522 WARNING ("curl plugin: `URL' missing in `Page' block.");
526 if (page->matches == NULL && page->stats == NULL
527 && !page->response_time && !page->response_code)
529 assert (page->instance != NULL);
530 WARNING ("curl plugin: No (valid) `Match' block "
531 "or Statistics or MeasureResponseTime or MeasureResponseCode "
532 "within `Page' block `%s'.", page->instance);
537 status = cc_page_init_curl (page);
540 } /* while (status == 0) */
544 cc_web_page_free (page);
548 /* Add the new page to the linked list */
556 while (prev->next != NULL)
562 } /* }}} int cc_config_add_page */
564 static int cc_config (oconfig_item_t *ci) /* {{{ */
574 for (i = 0; i < ci->children_num; i++)
576 oconfig_item_t *child = ci->children + i;
578 if (strcasecmp ("Page", child->key) == 0)
580 status = cc_config_add_page (child);
588 WARNING ("curl plugin: Option `%s' not allowed here.", child->key);
593 if ((success == 0) && (errors > 0))
595 ERROR ("curl plugin: All statements failed.");
600 } /* }}} int cc_config */
602 static int cc_init (void) /* {{{ */
606 INFO ("curl plugin: No pages have been defined.");
609 curl_global_init (CURL_GLOBAL_SSL);
611 } /* }}} int cc_init */
613 static void cc_submit (const web_page_t *wp, const web_match_t *wm, /* {{{ */
614 const cu_match_value_t *mv)
617 value_list_t vl = VALUE_LIST_INIT;
619 values[0] = mv->value;
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, wm->type, sizeof (vl.type));
627 if (wm->instance != NULL)
628 sstrncpy (vl.type_instance, wm->instance, sizeof (vl.type_instance));
630 plugin_dispatch_values (&vl);
631 } /* }}} void cc_submit */
633 static void cc_submit_response_code (const web_page_t *wp, long code) /* {{{ */
636 value_list_t vl = VALUE_LIST_INIT;
638 values[0].gauge = code;
642 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
643 sstrncpy (vl.plugin, "curl", sizeof (vl.plugin));
644 sstrncpy (vl.plugin_instance, wp->instance, sizeof (vl.plugin_instance));
645 sstrncpy (vl.type, "response_code", sizeof (vl.type));
647 plugin_dispatch_values (&vl);
648 } /* }}} void cc_submit_response_code */
650 static void cc_submit_response_time (const web_page_t *wp, /* {{{ */
651 cdtime_t response_time)
654 value_list_t vl = VALUE_LIST_INIT;
656 values[0].gauge = CDTIME_T_TO_DOUBLE (response_time);
660 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
661 sstrncpy (vl.plugin, "curl", sizeof (vl.plugin));
662 sstrncpy (vl.plugin_instance, wp->instance, sizeof (vl.plugin_instance));
663 sstrncpy (vl.type, "response_time", sizeof (vl.type));
665 plugin_dispatch_values (&vl);
666 } /* }}} void cc_submit_response_time */
668 static int cc_read_page (web_page_t *wp) /* {{{ */
674 if (wp->response_time)
678 status = curl_easy_perform (wp->curl);
679 if (status != CURLE_OK)
681 ERROR ("curl plugin: curl_easy_perform failed with status %i: %s",
682 status, wp->curl_errbuf);
686 if (wp->response_time)
687 cc_submit_response_time (wp, cdtime() - start);
688 if (wp->stats != NULL)
689 curl_stats_dispatch (wp->stats, wp->curl, hostname_g, "curl", wp->instance);
691 if(wp->response_code)
693 long response_code = 0;
694 status = curl_easy_getinfo(wp->curl, CURLINFO_RESPONSE_CODE, &response_code);
695 if(status != CURLE_OK) {
696 ERROR ("curl plugin: Fetching response code failed with status %i: %s",
697 status, wp->curl_errbuf);
699 cc_submit_response_code(wp, response_code);
703 for (wm = wp->matches; wm != NULL; wm = wm->next)
705 cu_match_value_t *mv;
707 status = match_apply (wm->match, wp->buffer);
710 WARNING ("curl plugin: match_apply failed.");
714 mv = match_get_user_data (wm->match);
717 WARNING ("curl plugin: match_get_user_data returned NULL.");
721 cc_submit (wp, wm, mv);
722 match_value_reset (mv);
723 } /* for (wm = wp->matches; wm != NULL; wm = wm->next) */
726 } /* }}} int cc_read_page */
728 static int cc_read (void) /* {{{ */
732 for (wp = pages_g; wp != NULL; wp = wp->next)
736 } /* }}} int cc_read */
738 static int cc_shutdown (void) /* {{{ */
740 cc_web_page_free (pages_g);
744 } /* }}} int cc_shutdown */
746 void module_register (void)
748 plugin_register_complex_config ("curl", cc_config);
749 plugin_register_init ("curl", cc_init);
750 plugin_register_read ("curl", cc_read);
751 plugin_register_shutdown ("curl", cc_shutdown);
752 } /* void module_register */
754 /* vim: set sw=2 sts=2 et fdm=marker : */