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) {
106 if ((wp->buffer_fill + len) >= wp->buffer_size) {
110 temp_size = wp->buffer_fill + len + 1;
111 temp = realloc(wp->buffer, temp_size);
113 ERROR("curl plugin: realloc failed.");
117 wp->buffer_size = temp_size;
120 memcpy(wp->buffer + wp->buffer_fill, (char *)buf, len);
121 wp->buffer_fill += len;
122 wp->buffer[wp->buffer_fill] = 0;
125 } /* }}} size_t cc_curl_callback */
127 static void cc_web_match_free(web_match_t *wm) /* {{{ */
135 match_destroy(wm->match);
136 cc_web_match_free(wm->next);
138 } /* }}} void cc_web_match_free */
140 static void cc_web_page_free(web_page_t *wp) /* {{{ */
145 if (wp->curl != NULL)
146 curl_easy_cleanup(wp->curl);
154 sfree(wp->credentials);
156 sfree(wp->post_body);
157 curl_slist_free_all(wp->headers);
158 curl_stats_destroy(wp->stats);
162 cc_web_match_free(wp->matches);
163 cc_web_page_free(wp->next);
165 } /* }}} void cc_web_page_free */
167 static int cc_config_append_string(const char *name,
168 struct curl_slist **dest, /* {{{ */
169 oconfig_item_t *ci) {
170 struct curl_slist *temp = NULL;
171 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING)) {
172 WARNING("curl plugin: `%s' needs exactly one string argument.", name);
176 temp = curl_slist_append(*dest, ci->values[0].value.string);
183 } /* }}} int cc_config_append_string */
185 static int cc_config_add_match_dstype(int *dstype_ret, /* {{{ */
186 oconfig_item_t *ci) {
189 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING)) {
190 WARNING("curl plugin: `DSType' needs exactly one string argument.");
194 if (strncasecmp("Gauge", ci->values[0].value.string, 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;
206 } else if (strncasecmp("Counter", ci->values[0].value.string,
207 strlen("Counter")) == 0) {
208 dstype = UTILS_MATCH_DS_TYPE_COUNTER;
209 if (strcasecmp("CounterSet", ci->values[0].value.string) == 0)
210 dstype |= UTILS_MATCH_CF_COUNTER_SET;
211 else if (strcasecmp("CounterAdd", ci->values[0].value.string) == 0)
212 dstype |= UTILS_MATCH_CF_COUNTER_ADD;
213 else if (strcasecmp("CounterInc", ci->values[0].value.string) == 0)
214 dstype |= UTILS_MATCH_CF_COUNTER_INC;
217 } else if (strncasecmp("Derive", ci->values[0].value.string,
218 strlen("Derive")) == 0) {
219 dstype = UTILS_MATCH_DS_TYPE_DERIVE;
220 if (strcasecmp("DeriveSet", ci->values[0].value.string) == 0)
221 dstype |= UTILS_MATCH_CF_DERIVE_SET;
222 else if (strcasecmp("DeriveAdd", ci->values[0].value.string) == 0)
223 dstype |= UTILS_MATCH_CF_DERIVE_ADD;
224 else if (strcasecmp("DeriveInc", ci->values[0].value.string) == 0)
225 dstype |= UTILS_MATCH_CF_DERIVE_INC;
228 } else if (strncasecmp("Absolute", ci->values[0].value.string,
229 strlen("Absolute")) == 0) {
230 dstype = UTILS_MATCH_DS_TYPE_ABSOLUTE;
231 if (strcasecmp("AbsoluteSet", ci->values[0].value.string) ==
232 0) /* Absolute DS is reset-on-read so no sense doin anything else but
234 dstype |= UTILS_MATCH_CF_ABSOLUTE_SET;
244 WARNING("curl plugin: `%s' is not a valid argument to `DSType'.",
245 ci->values[0].value.string);
249 *dstype_ret = dstype;
251 } /* }}} int cc_config_add_match_dstype */
253 static int cc_config_add_match(web_page_t *page, /* {{{ */
254 oconfig_item_t *ci) {
258 if (ci->values_num != 0) {
259 WARNING("curl plugin: Ignoring arguments for the `Match' block.");
262 match = calloc(1, sizeof(*match));
264 ERROR("curl plugin: calloc failed.");
269 for (int i = 0; i < ci->children_num; i++) {
270 oconfig_item_t *child = ci->children + i;
272 if (strcasecmp("Regex", child->key) == 0)
273 status = cf_util_get_string(child, &match->regex);
274 else if (strcasecmp("ExcludeRegex", child->key) == 0)
275 status = cf_util_get_string(child, &match->exclude_regex);
276 else if (strcasecmp("DSType", child->key) == 0)
277 status = cc_config_add_match_dstype(&match->dstype, child);
278 else if (strcasecmp("Type", child->key) == 0)
279 status = cf_util_get_string(child, &match->type);
280 else if (strcasecmp("Instance", child->key) == 0)
281 status = cf_util_get_string(child, &match->instance);
283 WARNING("curl plugin: Option `%s' not allowed here.", child->key);
289 } /* for (i = 0; i < ci->children_num; i++) */
291 while (status == 0) {
292 if (match->regex == NULL) {
293 WARNING("curl plugin: `Regex' missing in `Match' block.");
297 if (match->type == NULL) {
298 WARNING("curl plugin: `Type' missing in `Match' block.");
302 if (match->dstype == 0) {
303 WARNING("curl plugin: `DSType' missing in `Match' block.");
308 } /* while (status == 0) */
311 cc_web_match_free(match);
316 match_create_simple(match->regex, match->exclude_regex, match->dstype);
317 if (match->match == NULL) {
318 ERROR("curl plugin: match_create_simple failed.");
319 cc_web_match_free(match);
324 prev = page->matches;
325 while ((prev != NULL) && (prev->next != NULL))
329 page->matches = match;
335 } /* }}} int cc_config_add_match */
337 static int cc_page_init_curl(web_page_t *wp) /* {{{ */
339 wp->curl = curl_easy_init();
340 if (wp->curl == NULL) {
341 ERROR("curl plugin: curl_easy_init failed.");
345 curl_easy_setopt(wp->curl, CURLOPT_NOSIGNAL, 1L);
346 curl_easy_setopt(wp->curl, CURLOPT_WRITEFUNCTION, cc_curl_callback);
347 curl_easy_setopt(wp->curl, CURLOPT_WRITEDATA, wp);
348 curl_easy_setopt(wp->curl, CURLOPT_USERAGENT, COLLECTD_USERAGENT);
349 curl_easy_setopt(wp->curl, CURLOPT_ERRORBUFFER, wp->curl_errbuf);
350 curl_easy_setopt(wp->curl, CURLOPT_FOLLOWLOCATION, 1L);
351 curl_easy_setopt(wp->curl, CURLOPT_MAXREDIRS, 50L);
353 if (wp->user != NULL) {
354 #ifdef HAVE_CURLOPT_USERNAME
355 curl_easy_setopt(wp->curl, CURLOPT_USERNAME, wp->user);
356 curl_easy_setopt(wp->curl, CURLOPT_PASSWORD,
357 (wp->pass == NULL) ? "" : wp->pass);
359 size_t credentials_size;
361 credentials_size = strlen(wp->user) + 2;
362 if (wp->pass != NULL)
363 credentials_size += strlen(wp->pass);
365 wp->credentials = malloc(credentials_size);
366 if (wp->credentials == NULL) {
367 ERROR("curl plugin: malloc failed.");
371 snprintf(wp->credentials, credentials_size, "%s:%s", wp->user,
372 (wp->pass == NULL) ? "" : wp->pass);
373 curl_easy_setopt(wp->curl, CURLOPT_USERPWD, wp->credentials);
377 curl_easy_setopt(wp->curl, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST);
380 curl_easy_setopt(wp->curl, CURLOPT_SSL_VERIFYPEER, (long)wp->verify_peer);
381 curl_easy_setopt(wp->curl, CURLOPT_SSL_VERIFYHOST, wp->verify_host ? 2L : 0L);
382 if (wp->cacert != NULL)
383 curl_easy_setopt(wp->curl, CURLOPT_CAINFO, wp->cacert);
384 if (wp->headers != NULL)
385 curl_easy_setopt(wp->curl, CURLOPT_HTTPHEADER, wp->headers);
386 if (wp->post_body != NULL)
387 curl_easy_setopt(wp->curl, CURLOPT_POSTFIELDS, wp->post_body);
389 #ifdef HAVE_CURLOPT_TIMEOUT_MS
390 if (wp->timeout >= 0)
391 curl_easy_setopt(wp->curl, CURLOPT_TIMEOUT_MS, (long)wp->timeout);
393 curl_easy_setopt(wp->curl, CURLOPT_TIMEOUT_MS,
394 (long)CDTIME_T_TO_MS(plugin_get_interval()));
398 } /* }}} int cc_page_init_curl */
400 static int cc_config_add_page(oconfig_item_t *ci) /* {{{ */
405 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING)) {
406 WARNING("curl plugin: `Page' blocks need exactly one string argument.");
410 page = calloc(1, sizeof(*page));
412 ERROR("curl plugin: calloc failed.");
419 page->verify_peer = 1;
420 page->verify_host = 1;
421 page->response_time = 0;
422 page->response_code = 0;
426 page->instance = strdup(ci->values[0].value.string);
427 if (page->instance == NULL) {
428 ERROR("curl plugin: strdup failed.");
433 /* Process all children */
435 for (int i = 0; i < ci->children_num; i++) {
436 oconfig_item_t *child = ci->children + i;
438 if (strcasecmp("URL", child->key) == 0)
439 status = cf_util_get_string(child, &page->url);
440 else if (strcasecmp("User", child->key) == 0)
441 status = cf_util_get_string(child, &page->user);
442 else if (strcasecmp("Password", child->key) == 0)
443 status = cf_util_get_string(child, &page->pass);
444 else if (strcasecmp("Digest", child->key) == 0)
445 status = cf_util_get_boolean(child, &page->digest);
446 else if (strcasecmp("VerifyPeer", child->key) == 0)
447 status = cf_util_get_boolean(child, &page->verify_peer);
448 else if (strcasecmp("VerifyHost", child->key) == 0)
449 status = cf_util_get_boolean(child, &page->verify_host);
450 else if (strcasecmp("MeasureResponseTime", child->key) == 0)
451 status = cf_util_get_boolean(child, &page->response_time);
452 else if (strcasecmp("MeasureResponseCode", child->key) == 0)
453 status = cf_util_get_boolean(child, &page->response_code);
454 else if (strcasecmp("CACert", child->key) == 0)
455 status = cf_util_get_string(child, &page->cacert);
456 else if (strcasecmp("Match", child->key) == 0)
457 /* Be liberal with failing matches => don't set `status'. */
458 cc_config_add_match(page, child);
459 else if (strcasecmp("Header", child->key) == 0)
460 status = cc_config_append_string("Header", &page->headers, child);
461 else if (strcasecmp("Post", child->key) == 0)
462 status = cf_util_get_string(child, &page->post_body);
463 else if (strcasecmp("Timeout", child->key) == 0)
464 status = cf_util_get_int(child, &page->timeout);
465 else if (strcasecmp("Statistics", child->key) == 0) {
466 page->stats = curl_stats_from_config(child);
467 if (page->stats == NULL)
470 WARNING("curl plugin: Option `%s' not allowed here.", child->key);
476 } /* for (i = 0; i < ci->children_num; i++) */
478 /* Additionial sanity checks and libCURL initialization. */
479 while (status == 0) {
480 if (page->url == NULL) {
481 WARNING("curl plugin: `URL' missing in `Page' block.");
485 if (page->matches == NULL && page->stats == NULL && !page->response_time &&
486 !page->response_code) {
487 assert(page->instance != NULL);
488 WARNING("curl plugin: No (valid) `Match' block "
489 "or Statistics or MeasureResponseTime or MeasureResponseCode "
490 "within `Page' block `%s'.",
496 status = cc_page_init_curl(page);
499 } /* while (status == 0) */
502 cc_web_page_free(page);
506 /* Add the new page to the linked list */
513 while (prev->next != NULL)
519 } /* }}} int cc_config_add_page */
521 static int cc_config(oconfig_item_t *ci) /* {{{ */
530 for (int i = 0; i < ci->children_num; i++) {
531 oconfig_item_t *child = ci->children + i;
533 if (strcasecmp("Page", child->key) == 0) {
534 status = cc_config_add_page(child);
540 WARNING("curl plugin: Option `%s' not allowed here.", child->key);
545 if ((success == 0) && (errors > 0)) {
546 ERROR("curl plugin: All statements failed.");
551 } /* }}} int cc_config */
553 static int cc_init(void) /* {{{ */
555 if (pages_g == NULL) {
556 INFO("curl plugin: No pages have been defined.");
559 curl_global_init(CURL_GLOBAL_SSL);
561 } /* }}} int cc_init */
563 static void cc_submit(const web_page_t *wp, const web_match_t *wm, /* {{{ */
565 value_list_t vl = VALUE_LIST_INIT;
569 sstrncpy(vl.plugin, "curl", sizeof(vl.plugin));
570 sstrncpy(vl.plugin_instance, wp->instance, sizeof(vl.plugin_instance));
571 sstrncpy(vl.type, wm->type, sizeof(vl.type));
572 if (wm->instance != NULL)
573 sstrncpy(vl.type_instance, wm->instance, sizeof(vl.type_instance));
575 plugin_dispatch_values(&vl);
576 } /* }}} void cc_submit */
578 static void cc_submit_response_code(const web_page_t *wp, long code) /* {{{ */
580 value_list_t vl = VALUE_LIST_INIT;
582 vl.values = &(value_t){.gauge = (gauge_t)code};
584 sstrncpy(vl.plugin, "curl", sizeof(vl.plugin));
585 sstrncpy(vl.plugin_instance, wp->instance, sizeof(vl.plugin_instance));
586 sstrncpy(vl.type, "response_code", sizeof(vl.type));
588 plugin_dispatch_values(&vl);
589 } /* }}} void cc_submit_response_code */
591 static void cc_submit_response_time(const web_page_t *wp, /* {{{ */
592 gauge_t response_time) {
593 value_list_t vl = VALUE_LIST_INIT;
595 vl.values = &(value_t){.gauge = response_time};
597 sstrncpy(vl.plugin, "curl", sizeof(vl.plugin));
598 sstrncpy(vl.plugin_instance, wp->instance, sizeof(vl.plugin_instance));
599 sstrncpy(vl.type, "response_time", sizeof(vl.type));
601 plugin_dispatch_values(&vl);
602 } /* }}} void cc_submit_response_time */
604 static int cc_read_page(web_page_t *wp) /* {{{ */
609 if (wp->response_time)
614 curl_easy_setopt(wp->curl, CURLOPT_URL, wp->url);
616 status = curl_easy_perform(wp->curl);
617 if (status != CURLE_OK) {
618 ERROR("curl plugin: curl_easy_perform failed with status %i: %s", status,
623 if (wp->response_time)
624 cc_submit_response_time(wp, CDTIME_T_TO_DOUBLE(cdtime() - start));
625 if (wp->stats != NULL)
626 curl_stats_dispatch(wp->stats, wp->curl, hostname_g, "curl", wp->instance);
628 if (wp->response_code) {
629 long response_code = 0;
631 curl_easy_getinfo(wp->curl, CURLINFO_RESPONSE_CODE, &response_code);
632 if (status != CURLE_OK) {
633 ERROR("curl plugin: Fetching response code failed with status %i: %s",
634 status, wp->curl_errbuf);
636 cc_submit_response_code(wp, response_code);
640 for (web_match_t *wm = wp->matches; wm != NULL; wm = wm->next) {
641 cu_match_value_t *mv;
643 status = match_apply(wm->match, wp->buffer);
645 WARNING("curl plugin: match_apply failed.");
649 mv = match_get_user_data(wm->match);
651 WARNING("curl plugin: match_get_user_data returned NULL.");
655 cc_submit(wp, wm, mv->value);
656 match_value_reset(mv);
657 } /* for (wm = wp->matches; wm != NULL; wm = wm->next) */
660 } /* }}} int cc_read_page */
662 static int cc_read(void) /* {{{ */
664 for (web_page_t *wp = pages_g; wp != NULL; wp = wp->next)
668 } /* }}} int cc_read */
670 static int cc_shutdown(void) /* {{{ */
672 cc_web_page_free(pages_g);
676 } /* }}} int cc_shutdown */
678 void module_register(void) {
679 plugin_register_complex_config("curl", cc_config);
680 plugin_register_init("curl", cc_init);
681 plugin_register_read("curl", cc_read);
682 plugin_register_shutdown("curl", cc_shutdown);
683 } /* void module_register */