2 * collectd - src/write_http.c
3 * Copyright (C) 2009 Paul Sadauskas
4 * Copyright (C) 2009 Doug MacEachern
5 * Copyright (C) 2007-2014 Florian octo Forster
7 * This program is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation; only version 2 of the License is applicable.
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21 * Florian octo Forster <octo at collectd.org>
22 * Doug MacEachern <dougm@hyperic.com>
23 * Paul Sadauskas <psadauskas@gmail.com>
29 #include "utils_cache.h"
30 #include "utils_format_json.h"
36 #include <curl/curl.h>
38 #ifndef WRITE_HTTP_DEFAULT_BUFFER_SIZE
39 # define WRITE_HTTP_DEFAULT_BUFFER_SIZE 4096
64 time_t low_speed_time;
67 #define WH_FORMAT_COMMAND 0
68 #define WH_FORMAT_JSON 1
72 struct curl_slist *headers;
73 char curl_errbuf[CURL_ERROR_SIZE];
76 size_t send_buffer_size;
77 size_t send_buffer_free;
78 size_t send_buffer_fill;
79 cdtime_t send_buffer_init_time;
81 pthread_mutex_t send_lock;
83 typedef struct wh_callback_s wh_callback_t;
85 static void wh_log_http_error (wh_callback_t *cb)
87 if (!cb->log_http_error)
92 curl_easy_getinfo (cb->curl, CURLINFO_RESPONSE_CODE, &http_code);
95 INFO ("write_http plugin: HTTP Error code: %lu", http_code);
98 static void wh_reset_buffer (wh_callback_t *cb) /* {{{ */
100 memset (cb->send_buffer, 0, cb->send_buffer_size);
101 cb->send_buffer_free = cb->send_buffer_size;
102 cb->send_buffer_fill = 0;
103 cb->send_buffer_init_time = cdtime ();
105 if (cb->format == WH_FORMAT_JSON)
107 format_json_initialize (cb->send_buffer,
108 &cb->send_buffer_fill,
109 &cb->send_buffer_free);
111 } /* }}} wh_reset_buffer */
113 static int wh_send_buffer (wh_callback_t *cb) /* {{{ */
117 curl_easy_setopt (cb->curl, CURLOPT_POSTFIELDS, cb->send_buffer);
118 status = curl_easy_perform (cb->curl);
120 wh_log_http_error (cb);
122 if (status != CURLE_OK)
124 ERROR ("write_http plugin: curl_easy_perform failed with "
126 status, cb->curl_errbuf);
129 } /* }}} wh_send_buffer */
131 static int wh_callback_init (wh_callback_t *cb) /* {{{ */
133 if (cb->curl != NULL)
136 cb->curl = curl_easy_init ();
137 if (cb->curl == NULL)
139 ERROR ("curl plugin: curl_easy_init failed.");
143 if (cb->low_speed_limit > 0 && cb->low_speed_time > 0)
145 curl_easy_setopt (cb->curl, CURLOPT_LOW_SPEED_LIMIT,
146 (long) (cb->low_speed_limit * cb->low_speed_time));
147 curl_easy_setopt (cb->curl, CURLOPT_LOW_SPEED_TIME,
148 (long) cb->low_speed_time);
151 #ifdef HAVE_CURLOPT_TIMEOUT_MS
153 curl_easy_setopt (cb->curl, CURLOPT_TIMEOUT_MS, (long) cb->timeout);
156 curl_easy_setopt (cb->curl, CURLOPT_NOSIGNAL, 1L);
157 curl_easy_setopt (cb->curl, CURLOPT_USERAGENT, COLLECTD_USERAGENT);
160 cb->headers = curl_slist_append (cb->headers, "Accept: */*");
161 if (cb->format == WH_FORMAT_JSON)
162 cb->headers = curl_slist_append (cb->headers, "Content-Type: application/json");
164 cb->headers = curl_slist_append (cb->headers, "Content-Type: text/plain");
165 cb->headers = curl_slist_append (cb->headers, "Expect:");
166 curl_easy_setopt (cb->curl, CURLOPT_HTTPHEADER, cb->headers);
168 curl_easy_setopt (cb->curl, CURLOPT_ERRORBUFFER, cb->curl_errbuf);
169 curl_easy_setopt (cb->curl, CURLOPT_URL, cb->location);
170 curl_easy_setopt (cb->curl, CURLOPT_FOLLOWLOCATION, 1L);
171 curl_easy_setopt (cb->curl, CURLOPT_MAXREDIRS, 50L);
173 if (cb->user != NULL)
175 #ifdef HAVE_CURLOPT_USERNAME
176 curl_easy_setopt (cb->curl, CURLOPT_USERNAME, cb->user);
177 curl_easy_setopt (cb->curl, CURLOPT_PASSWORD,
178 (cb->pass == NULL) ? "" : cb->pass);
180 size_t credentials_size;
182 credentials_size = strlen (cb->user) + 2;
183 if (cb->pass != NULL)
184 credentials_size += strlen (cb->pass);
186 cb->credentials = (char *) malloc (credentials_size);
187 if (cb->credentials == NULL)
189 ERROR ("curl plugin: malloc failed.");
193 ssnprintf (cb->credentials, credentials_size, "%s:%s",
194 cb->user, (cb->pass == NULL) ? "" : cb->pass);
195 curl_easy_setopt (cb->curl, CURLOPT_USERPWD, cb->credentials);
197 curl_easy_setopt (cb->curl, CURLOPT_HTTPAUTH, CURLAUTH_ANY);
200 curl_easy_setopt (cb->curl, CURLOPT_SSL_VERIFYPEER, (long) cb->verify_peer);
201 curl_easy_setopt (cb->curl, CURLOPT_SSL_VERIFYHOST,
202 cb->verify_host ? 2L : 0L);
203 curl_easy_setopt (cb->curl, CURLOPT_SSLVERSION, cb->sslversion);
204 if (cb->cacert != NULL)
205 curl_easy_setopt (cb->curl, CURLOPT_CAINFO, cb->cacert);
206 if (cb->capath != NULL)
207 curl_easy_setopt (cb->curl, CURLOPT_CAPATH, cb->capath);
209 if (cb->clientkey != NULL && cb->clientcert != NULL)
211 curl_easy_setopt (cb->curl, CURLOPT_SSLKEY, cb->clientkey);
212 curl_easy_setopt (cb->curl, CURLOPT_SSLCERT, cb->clientcert);
214 if (cb->clientkeypass != NULL)
215 curl_easy_setopt (cb->curl, CURLOPT_SSLKEYPASSWD, cb->clientkeypass);
218 wh_reset_buffer (cb);
221 } /* }}} int wh_callback_init */
223 static int wh_flush_nolock (cdtime_t timeout, wh_callback_t *cb) /* {{{ */
227 DEBUG ("write_http plugin: wh_flush_nolock: timeout = %.3f; "
228 "send_buffer_fill = %zu;",
229 CDTIME_T_TO_DOUBLE (timeout),
230 cb->send_buffer_fill);
232 /* timeout == 0 => flush unconditionally */
238 if ((cb->send_buffer_init_time + timeout) > now)
242 if (cb->format == WH_FORMAT_COMMAND)
244 if (cb->send_buffer_fill <= 0)
246 cb->send_buffer_init_time = cdtime ();
250 status = wh_send_buffer (cb);
251 wh_reset_buffer (cb);
253 else if (cb->format == WH_FORMAT_JSON)
255 if (cb->send_buffer_fill <= 2)
257 cb->send_buffer_init_time = cdtime ();
261 status = format_json_finalize (cb->send_buffer,
262 &cb->send_buffer_fill,
263 &cb->send_buffer_free);
266 ERROR ("write_http: wh_flush_nolock: "
267 "format_json_finalize failed.");
268 wh_reset_buffer (cb);
272 status = wh_send_buffer (cb);
273 wh_reset_buffer (cb);
277 ERROR ("write_http: wh_flush_nolock: "
278 "Unknown format: %i",
284 } /* }}} wh_flush_nolock */
286 static int wh_flush (cdtime_t timeout, /* {{{ */
287 const char *identifier __attribute__((unused)),
288 user_data_t *user_data)
293 if (user_data == NULL)
296 cb = user_data->data;
298 pthread_mutex_lock (&cb->send_lock);
300 if (cb->curl == NULL)
302 status = wh_callback_init (cb);
305 ERROR ("write_http plugin: wh_callback_init failed.");
306 pthread_mutex_unlock (&cb->send_lock);
311 status = wh_flush_nolock (timeout, cb);
312 pthread_mutex_unlock (&cb->send_lock);
315 } /* }}} int wh_flush */
317 static void wh_callback_free (void *data) /* {{{ */
326 wh_flush_nolock (/* timeout = */ 0, cb);
328 if (cb->curl != NULL)
330 curl_easy_cleanup (cb->curl);
334 if (cb->headers != NULL)
336 curl_slist_free_all (cb->headers);
341 sfree (cb->location);
344 sfree (cb->credentials);
347 sfree (cb->clientkey);
348 sfree (cb->clientcert);
349 sfree (cb->clientkeypass);
350 sfree (cb->send_buffer);
353 } /* }}} void wh_callback_free */
355 static int wh_write_command (const data_set_t *ds, const value_list_t *vl, /* {{{ */
358 char key[10*DATA_MAX_NAME_LEN];
365 if (0 != strcmp (ds->type, vl->type)) {
366 ERROR ("write_http plugin: DS type does not match "
371 /* Copy the identifier to `key' and escape it. */
372 status = FORMAT_VL (key, sizeof (key), vl);
374 ERROR ("write_http plugin: error with format_name");
377 escape_string (key, sizeof (key));
379 /* Convert the values to an ASCII representation and put that into
381 status = format_values (values, sizeof (values), ds, vl, cb->store_rates);
383 ERROR ("write_http plugin: error with "
384 "wh_value_list_to_string");
388 command_len = (size_t) ssnprintf (command, sizeof (command),
389 "PUTVAL %s interval=%.3f %s\r\n",
391 CDTIME_T_TO_DOUBLE (vl->interval),
393 if (command_len >= sizeof (command)) {
394 ERROR ("write_http plugin: Command buffer too small: "
395 "Need %zu bytes.", command_len + 1);
399 pthread_mutex_lock (&cb->send_lock);
401 if (cb->curl == NULL)
403 status = wh_callback_init (cb);
406 ERROR ("write_http plugin: wh_callback_init failed.");
407 pthread_mutex_unlock (&cb->send_lock);
412 if (command_len >= cb->send_buffer_free)
414 status = wh_flush_nolock (/* timeout = */ 0, cb);
417 pthread_mutex_unlock (&cb->send_lock);
421 assert (command_len < cb->send_buffer_free);
423 /* `command_len + 1' because `command_len' does not include the
424 * trailing null byte. Neither does `send_buffer_fill'. */
425 memcpy (cb->send_buffer + cb->send_buffer_fill,
426 command, command_len + 1);
427 cb->send_buffer_fill += command_len;
428 cb->send_buffer_free -= command_len;
430 DEBUG ("write_http plugin: <%s> buffer %zu/%zu (%g%%) \"%s\"",
432 cb->send_buffer_fill, cb->send_buffer_size,
433 100.0 * ((double) cb->send_buffer_fill) / ((double) cb->send_buffer_size),
436 /* Check if we have enough space for this command. */
437 pthread_mutex_unlock (&cb->send_lock);
440 } /* }}} int wh_write_command */
442 static int wh_write_json (const data_set_t *ds, const value_list_t *vl, /* {{{ */
447 pthread_mutex_lock (&cb->send_lock);
449 if (cb->curl == NULL)
451 status = wh_callback_init (cb);
454 ERROR ("write_http plugin: wh_callback_init failed.");
455 pthread_mutex_unlock (&cb->send_lock);
460 status = format_json_value_list (cb->send_buffer,
461 &cb->send_buffer_fill,
462 &cb->send_buffer_free,
463 ds, vl, cb->store_rates);
464 if (status == (-ENOMEM))
466 status = wh_flush_nolock (/* timeout = */ 0, cb);
469 wh_reset_buffer (cb);
470 pthread_mutex_unlock (&cb->send_lock);
474 status = format_json_value_list (cb->send_buffer,
475 &cb->send_buffer_fill,
476 &cb->send_buffer_free,
477 ds, vl, cb->store_rates);
481 pthread_mutex_unlock (&cb->send_lock);
485 DEBUG ("write_http plugin: <%s> buffer %zu/%zu (%g%%)",
487 cb->send_buffer_fill, cb->send_buffer_size,
488 100.0 * ((double) cb->send_buffer_fill) / ((double) cb->send_buffer_size));
490 /* Check if we have enough space for this command. */
491 pthread_mutex_unlock (&cb->send_lock);
494 } /* }}} int wh_write_json */
496 static int wh_write (const data_set_t *ds, const value_list_t *vl, /* {{{ */
497 user_data_t *user_data)
502 if (user_data == NULL)
505 cb = user_data->data;
507 if (cb->format == WH_FORMAT_JSON)
508 status = wh_write_json (ds, vl, cb);
510 status = wh_write_command (ds, vl, cb);
513 } /* }}} int wh_write */
515 static int config_set_format (wh_callback_t *cb, /* {{{ */
520 if ((ci->values_num != 1)
521 || (ci->values[0].type != OCONFIG_TYPE_STRING))
523 WARNING ("write_http plugin: The `%s' config option "
524 "needs exactly one string argument.", ci->key);
528 string = ci->values[0].value.string;
529 if (strcasecmp ("Command", string) == 0)
530 cb->format = WH_FORMAT_COMMAND;
531 else if (strcasecmp ("JSON", string) == 0)
532 cb->format = WH_FORMAT_JSON;
535 ERROR ("write_http plugin: Invalid format string: %s",
541 } /* }}} int config_set_format */
543 static int wh_config_node (oconfig_item_t *ci) /* {{{ */
547 user_data_t user_data;
548 char callback_name[DATA_MAX_NAME_LEN];
552 cb = malloc (sizeof (*cb));
555 ERROR ("write_http plugin: malloc failed.");
558 memset (cb, 0, sizeof (*cb));
561 cb->format = WH_FORMAT_COMMAND;
562 cb->sslversion = CURL_SSLVERSION_DEFAULT;
563 cb->low_speed_limit = 0;
565 cb->log_http_error = 0;
569 pthread_mutex_init (&cb->send_lock, /* attr = */ NULL);
571 cf_util_get_string (ci, &cb->name);
573 /* FIXME: Remove this legacy mode in version 6. */
574 if (strcasecmp ("URL", ci->key) == 0)
575 cf_util_get_string (ci, &cb->location);
577 for (i = 0; i < ci->children_num; i++)
579 oconfig_item_t *child = ci->children + i;
581 if (strcasecmp ("URL", child->key) == 0)
582 status = cf_util_get_string (child, &cb->location);
583 else if (strcasecmp ("User", child->key) == 0)
584 status = cf_util_get_string (child, &cb->user);
585 else if (strcasecmp ("Password", child->key) == 0)
586 status = cf_util_get_string (child, &cb->pass);
587 else if (strcasecmp ("VerifyPeer", child->key) == 0)
588 status = cf_util_get_boolean (child, &cb->verify_peer);
589 else if (strcasecmp ("VerifyHost", child->key) == 0)
590 status = cf_util_get_boolean (child, &cb->verify_host);
591 else if (strcasecmp ("CACert", child->key) == 0)
592 status = cf_util_get_string (child, &cb->cacert);
593 else if (strcasecmp ("CAPath", child->key) == 0)
594 status = cf_util_get_string (child, &cb->capath);
595 else if (strcasecmp ("ClientKey", child->key) == 0)
596 status = cf_util_get_string (child, &cb->clientkey);
597 else if (strcasecmp ("ClientCert", child->key) == 0)
598 status = cf_util_get_string (child, &cb->clientcert);
599 else if (strcasecmp ("ClientKeyPass", child->key) == 0)
600 status = cf_util_get_string (child, &cb->clientkeypass);
601 else if (strcasecmp ("SSLVersion", child->key) == 0)
605 status = cf_util_get_string (child, &value);
609 if (value == NULL || strcasecmp ("default", value) == 0)
610 cb->sslversion = CURL_SSLVERSION_DEFAULT;
611 else if (strcasecmp ("SSLv2", value) == 0)
612 cb->sslversion = CURL_SSLVERSION_SSLv2;
613 else if (strcasecmp ("SSLv3", value) == 0)
614 cb->sslversion = CURL_SSLVERSION_SSLv3;
615 else if (strcasecmp ("TLSv1", value) == 0)
616 cb->sslversion = CURL_SSLVERSION_TLSv1;
617 #if (LIBCURL_VERSION_MAJOR > 7) || (LIBCURL_VERSION_MAJOR == 7 && LIBCURL_VERSION_MINOR >= 34)
618 else if (strcasecmp ("TLSv1_0", value) == 0)
619 cb->sslversion = CURL_SSLVERSION_TLSv1_0;
620 else if (strcasecmp ("TLSv1_1", value) == 0)
621 cb->sslversion = CURL_SSLVERSION_TLSv1_1;
622 else if (strcasecmp ("TLSv1_2", value) == 0)
623 cb->sslversion = CURL_SSLVERSION_TLSv1_2;
627 ERROR ("write_http plugin: Invalid SSLVersion "
628 "option: %s.", value);
634 else if (strcasecmp ("Format", child->key) == 0)
635 status = config_set_format (cb, child);
636 else if (strcasecmp ("StoreRates", child->key) == 0)
637 status = cf_util_get_boolean (child, &cb->store_rates);
638 else if (strcasecmp ("BufferSize", child->key) == 0)
639 status = cf_util_get_int (child, &buffer_size);
640 else if (strcasecmp ("LowSpeedLimit", child->key) == 0)
641 status = cf_util_get_int (child, &cb->low_speed_limit);
642 else if (strcasecmp ("Timeout", child->key) == 0)
643 status = cf_util_get_int (child, &cb->timeout);
644 else if (strcasecmp ("LogHttpError", child->key) == 0)
645 status = cf_util_get_boolean (child, &cb->log_http_error);
648 ERROR ("write_http plugin: Invalid configuration "
649 "option: %s.", child->key);
659 wh_callback_free (cb);
663 if (cb->location == NULL)
665 ERROR ("write_http plugin: no URL defined for instance '%s'",
667 wh_callback_free (cb);
671 if (cb->low_speed_limit > 0)
672 cb->low_speed_time = CDTIME_T_TO_TIME_T(plugin_get_interval());
674 /* Determine send_buffer_size. */
675 cb->send_buffer_size = WRITE_HTTP_DEFAULT_BUFFER_SIZE;
676 if (buffer_size >= 1024)
677 cb->send_buffer_size = (size_t) buffer_size;
678 else if (buffer_size != 0)
679 ERROR ("write_http plugin: Ignoring invalid BufferSize setting (%d).",
682 /* Allocate the buffer. */
683 cb->send_buffer = malloc (cb->send_buffer_size);
684 if (cb->send_buffer == NULL)
686 ERROR ("write_http plugin: malloc(%zu) failed.", cb->send_buffer_size);
687 wh_callback_free (cb);
690 /* Nulls the buffer and sets ..._free and ..._fill. */
691 wh_reset_buffer (cb);
693 ssnprintf (callback_name, sizeof (callback_name), "write_http/%s",
695 DEBUG ("write_http: Registering write callback '%s' with URL '%s'",
696 callback_name, cb->location);
698 memset (&user_data, 0, sizeof (user_data));
700 user_data.free_func = NULL;
701 plugin_register_flush (callback_name, wh_flush, &user_data);
703 user_data.free_func = wh_callback_free;
704 plugin_register_write (callback_name, wh_write, &user_data);
707 } /* }}} int wh_config_node */
709 static int wh_config (oconfig_item_t *ci) /* {{{ */
713 for (i = 0; i < ci->children_num; i++)
715 oconfig_item_t *child = ci->children + i;
717 if (strcasecmp ("Node", child->key) == 0)
718 wh_config_node (child);
719 /* FIXME: Remove this legacy mode in version 6. */
720 else if (strcasecmp ("URL", child->key) == 0) {
721 WARNING ("write_http plugin: Legacy <URL> block found. "
722 "Please use <Node> instead.");
723 wh_config_node (child);
727 ERROR ("write_http plugin: Invalid configuration "
728 "option: %s.", child->key);
733 } /* }}} int wh_config */
735 static int wh_init (void) /* {{{ */
737 /* Call this while collectd is still single-threaded to avoid
738 * initialization issues in libgcrypt. */
739 curl_global_init (CURL_GLOBAL_SSL);
741 } /* }}} int wh_init */
743 void module_register (void) /* {{{ */
745 plugin_register_complex_config ("write_http", wh_config);
746 plugin_register_init ("write_http", wh_init);
747 } /* }}} void module_register */
749 /* vim: set fdm=marker sw=8 ts=8 tw=78 et : */