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 "configfile.h"
29 #include "utils_curl_stats.h"
30 #include "utils_match.h"
31 #include "utils_time.h"
33 #include <curl/curl.h>
39 typedef struct web_match_s web_match_t;
40 struct web_match_s /* {{{ */
54 typedef struct web_page_s web_page_t;
55 struct web_page_s /* {{{ */
67 struct curl_slist *headers;
75 char curl_errbuf[CURL_ERROR_SIZE];
88 /* static CURLM *curl = NULL; */
89 static web_page_t *pages_g = NULL;
94 static size_t cc_curl_callback (void *buf, /* {{{ */
95 size_t size, size_t nmemb, void *user_data)
108 if ((wp->buffer_fill + len) >= wp->buffer_size)
113 temp_size = wp->buffer_fill + len + 1;
114 temp = realloc (wp->buffer, temp_size);
117 ERROR ("curl plugin: realloc failed.");
121 wp->buffer_size = temp_size;
124 memcpy (wp->buffer + wp->buffer_fill, (char *) buf, len);
125 wp->buffer_fill += len;
126 wp->buffer[wp->buffer_fill] = 0;
129 } /* }}} size_t cc_curl_callback */
131 static void cc_web_match_free (web_match_t *wm) /* {{{ */
138 sfree (wm->instance);
139 match_destroy (wm->match);
140 cc_web_match_free (wm->next);
142 } /* }}} void cc_web_match_free */
144 static void cc_web_page_free (web_page_t *wp) /* {{{ */
149 if (wp->curl != NULL)
150 curl_easy_cleanup (wp->curl);
153 sfree (wp->instance);
158 sfree (wp->credentials);
160 sfree (wp->post_body);
161 curl_slist_free_all (wp->headers);
162 curl_stats_destroy (wp->stats);
166 cc_web_match_free (wp->matches);
167 cc_web_page_free (wp->next);
169 } /* }}} void cc_web_page_free */
171 static int cc_config_append_string (const char *name, struct curl_slist **dest, /* {{{ */
174 struct curl_slist *temp = NULL;
175 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
177 WARNING ("curl plugin: `%s' needs exactly one string argument.", name);
181 temp = curl_slist_append(*dest, ci->values[0].value.string);
188 } /* }}} int cc_config_append_string */
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, /* {{{ */
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 (int 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: match_create_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) /* {{{ */
437 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
439 WARNING ("curl plugin: `Page' blocks need exactly one string argument.");
443 page = calloc (1, sizeof (*page));
446 ERROR ("curl plugin: calloc failed.");
453 page->verify_peer = 1;
454 page->verify_host = 1;
455 page->response_time = 0;
456 page->response_code = 0;
460 page->instance = strdup (ci->values[0].value.string);
461 if (page->instance == NULL)
463 ERROR ("curl plugin: strdup failed.");
468 /* Process all children */
470 for (int i = 0; i < ci->children_num; i++)
472 oconfig_item_t *child = ci->children + i;
474 if (strcasecmp ("URL", child->key) == 0)
475 status = cf_util_get_string (child, &page->url);
476 else if (strcasecmp ("User", child->key) == 0)
477 status = cf_util_get_string (child, &page->user);
478 else if (strcasecmp ("Password", child->key) == 0)
479 status = cf_util_get_string (child, &page->pass);
480 else if (strcasecmp ("Digest", child->key) == 0)
481 status = cf_util_get_boolean (child, &page->digest);
482 else if (strcasecmp ("VerifyPeer", child->key) == 0)
483 status = cf_util_get_boolean (child, &page->verify_peer);
484 else if (strcasecmp ("VerifyHost", child->key) == 0)
485 status = cf_util_get_boolean (child, &page->verify_host);
486 else if (strcasecmp ("MeasureResponseTime", child->key) == 0)
487 status = cf_util_get_boolean (child, &page->response_time);
488 else if (strcasecmp ("MeasureResponseCode", child->key) == 0)
489 status = cf_util_get_boolean (child, &page->response_code);
490 else if (strcasecmp ("CACert", child->key) == 0)
491 status = cf_util_get_string (child, &page->cacert);
492 else if (strcasecmp ("Match", child->key) == 0)
493 /* Be liberal with failing matches => don't set `status'. */
494 cc_config_add_match (page, child);
495 else if (strcasecmp ("Header", child->key) == 0)
496 status = cc_config_append_string ("Header", &page->headers, child);
497 else if (strcasecmp ("Post", child->key) == 0)
498 status = cf_util_get_string (child, &page->post_body);
499 else if (strcasecmp ("Timeout", child->key) == 0)
500 status = cf_util_get_int (child, &page->timeout);
501 else if (strcasecmp ("Statistics", child->key) == 0) {
502 page->stats = curl_stats_from_config (child);
503 if (page->stats == NULL)
508 WARNING ("curl plugin: Option `%s' not allowed here.", child->key);
514 } /* for (i = 0; i < ci->children_num; i++) */
516 /* Additionial sanity checks and libCURL initialization. */
519 if (page->url == NULL)
521 WARNING ("curl plugin: `URL' missing in `Page' block.");
525 if (page->matches == NULL && page->stats == NULL
526 && !page->response_time && !page->response_code)
528 assert (page->instance != NULL);
529 WARNING ("curl plugin: No (valid) `Match' block "
530 "or Statistics or MeasureResponseTime or MeasureResponseCode "
531 "within `Page' block `%s'.", page->instance);
536 status = cc_page_init_curl (page);
539 } /* while (status == 0) */
543 cc_web_page_free (page);
547 /* Add the new page to the linked list */
555 while (prev->next != NULL)
561 } /* }}} int cc_config_add_page */
563 static int cc_config (oconfig_item_t *ci) /* {{{ */
572 for (int i = 0; i < ci->children_num; i++)
574 oconfig_item_t *child = ci->children + i;
576 if (strcasecmp ("Page", child->key) == 0)
578 status = cc_config_add_page (child);
586 WARNING ("curl plugin: Option `%s' not allowed here.", child->key);
591 if ((success == 0) && (errors > 0))
593 ERROR ("curl plugin: All statements failed.");
598 } /* }}} int cc_config */
600 static int cc_init (void) /* {{{ */
604 INFO ("curl plugin: No pages have been defined.");
607 curl_global_init (CURL_GLOBAL_SSL);
609 } /* }}} int cc_init */
611 static void cc_submit (const web_page_t *wp, const web_match_t *wm, /* {{{ */
612 const cu_match_value_t *mv)
615 value_list_t vl = VALUE_LIST_INIT;
617 values[0] = mv->value;
621 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
622 sstrncpy (vl.plugin, "curl", sizeof (vl.plugin));
623 sstrncpy (vl.plugin_instance, wp->instance, sizeof (vl.plugin_instance));
624 sstrncpy (vl.type, wm->type, sizeof (vl.type));
625 if (wm->instance != NULL)
626 sstrncpy (vl.type_instance, wm->instance, sizeof (vl.type_instance));
628 plugin_dispatch_values (&vl);
629 } /* }}} void cc_submit */
631 static void cc_submit_response_code (const web_page_t *wp, long code) /* {{{ */
634 value_list_t vl = VALUE_LIST_INIT;
636 values[0].gauge = code;
640 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
641 sstrncpy (vl.plugin, "curl", sizeof (vl.plugin));
642 sstrncpy (vl.plugin_instance, wp->instance, sizeof (vl.plugin_instance));
643 sstrncpy (vl.type, "response_code", sizeof (vl.type));
645 plugin_dispatch_values (&vl);
646 } /* }}} void cc_submit_response_code */
648 static void cc_submit_response_time (const web_page_t *wp, /* {{{ */
649 cdtime_t response_time)
652 value_list_t vl = VALUE_LIST_INIT;
654 values[0].gauge = CDTIME_T_TO_DOUBLE (response_time);
658 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
659 sstrncpy (vl.plugin, "curl", sizeof (vl.plugin));
660 sstrncpy (vl.plugin_instance, wp->instance, sizeof (vl.plugin_instance));
661 sstrncpy (vl.type, "response_time", sizeof (vl.type));
663 plugin_dispatch_values (&vl);
664 } /* }}} void cc_submit_response_time */
666 static int cc_read_page (web_page_t *wp) /* {{{ */
671 if (wp->response_time)
675 status = curl_easy_perform (wp->curl);
676 if (status != CURLE_OK)
678 ERROR ("curl plugin: curl_easy_perform failed with status %i: %s",
679 status, wp->curl_errbuf);
683 if (wp->response_time)
684 cc_submit_response_time (wp, cdtime() - start);
685 if (wp->stats != NULL)
686 curl_stats_dispatch (wp->stats, wp->curl, hostname_g, "curl", wp->instance);
688 if(wp->response_code)
690 long response_code = 0;
691 status = curl_easy_getinfo(wp->curl, CURLINFO_RESPONSE_CODE, &response_code);
692 if(status != CURLE_OK) {
693 ERROR ("curl plugin: Fetching response code failed with status %i: %s",
694 status, wp->curl_errbuf);
696 cc_submit_response_code(wp, response_code);
700 for (web_match_t *wm = wp->matches; wm != NULL; wm = wm->next)
702 cu_match_value_t *mv;
704 status = match_apply (wm->match, wp->buffer);
707 WARNING ("curl plugin: match_apply failed.");
711 mv = match_get_user_data (wm->match);
714 WARNING ("curl plugin: match_get_user_data returned NULL.");
718 cc_submit (wp, wm, mv);
719 match_value_reset (mv);
720 } /* for (wm = wp->matches; wm != NULL; wm = wm->next) */
723 } /* }}} int cc_read_page */
725 static int cc_read (void) /* {{{ */
727 for (web_page_t *wp = pages_g; wp != NULL; wp = wp->next)
731 } /* }}} int cc_read */
733 static int cc_shutdown (void) /* {{{ */
735 cc_web_page_free (pages_g);
739 } /* }}} int cc_shutdown */
741 void module_register (void)
743 plugin_register_complex_config ("curl", cc_config);
744 plugin_register_init ("curl", cc_init);
745 plugin_register_read ("curl", cc_read);
746 plugin_register_shutdown ("curl", cc_shutdown);
747 } /* void module_register */
749 /* vim: set sw=2 sts=2 et fdm=marker : */