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
63 time_t low_speed_time;
66 #define WH_FORMAT_COMMAND 0
67 #define WH_FORMAT_JSON 1
71 struct curl_slist *headers;
72 char curl_errbuf[CURL_ERROR_SIZE];
75 size_t send_buffer_size;
76 size_t send_buffer_free;
77 size_t send_buffer_fill;
78 cdtime_t send_buffer_init_time;
80 pthread_mutex_t send_lock;
82 typedef struct wh_callback_s wh_callback_t;
84 static void wh_reset_buffer (wh_callback_t *cb) /* {{{ */
86 memset (cb->send_buffer, 0, cb->send_buffer_size);
87 cb->send_buffer_free = cb->send_buffer_size;
88 cb->send_buffer_fill = 0;
89 cb->send_buffer_init_time = cdtime ();
91 if (cb->format == WH_FORMAT_JSON)
93 format_json_initialize (cb->send_buffer,
94 &cb->send_buffer_fill,
95 &cb->send_buffer_free);
97 } /* }}} wh_reset_buffer */
99 static int wh_send_buffer (wh_callback_t *cb) /* {{{ */
103 curl_easy_setopt (cb->curl, CURLOPT_POSTFIELDS, cb->send_buffer);
104 status = curl_easy_perform (cb->curl);
105 if (status != CURLE_OK)
107 ERROR ("write_http plugin: curl_easy_perform failed with "
109 status, cb->curl_errbuf);
112 } /* }}} wh_send_buffer */
114 static int wh_callback_init (wh_callback_t *cb) /* {{{ */
116 if (cb->curl != NULL)
119 cb->curl = curl_easy_init ();
120 if (cb->curl == NULL)
122 ERROR ("curl plugin: curl_easy_init failed.");
126 if (cb->low_speed_limit > 0 && cb->low_speed_time > 0)
128 curl_easy_setopt (cb->curl, CURLOPT_LOW_SPEED_LIMIT,
129 (long) (cb->low_speed_limit * cb->low_speed_time));
130 curl_easy_setopt (cb->curl, CURLOPT_LOW_SPEED_TIME,
131 (long) cb->low_speed_time);
134 #ifdef HAVE_CURLOPT_TIMEOUT_MS
136 curl_easy_setopt (cb->curl, CURLOPT_TIMEOUT_MS, (long) cb->timeout);
139 curl_easy_setopt (cb->curl, CURLOPT_NOSIGNAL, 1L);
140 curl_easy_setopt (cb->curl, CURLOPT_USERAGENT, COLLECTD_USERAGENT);
143 cb->headers = curl_slist_append (cb->headers, "Accept: */*");
144 if (cb->format == WH_FORMAT_JSON)
145 cb->headers = curl_slist_append (cb->headers, "Content-Type: application/json");
147 cb->headers = curl_slist_append (cb->headers, "Content-Type: text/plain");
148 cb->headers = curl_slist_append (cb->headers, "Expect:");
149 curl_easy_setopt (cb->curl, CURLOPT_HTTPHEADER, cb->headers);
151 curl_easy_setopt (cb->curl, CURLOPT_ERRORBUFFER, cb->curl_errbuf);
152 curl_easy_setopt (cb->curl, CURLOPT_URL, cb->location);
153 curl_easy_setopt (cb->curl, CURLOPT_FOLLOWLOCATION, 1L);
154 curl_easy_setopt (cb->curl, CURLOPT_MAXREDIRS, 50L);
156 if (cb->user != NULL)
158 #ifdef HAVE_CURLOPT_USERNAME
159 curl_easy_setopt (cb->curl, CURLOPT_USERNAME, cb->user);
160 curl_easy_setopt (cb->curl, CURLOPT_PASSWORD,
161 (cb->pass == NULL) ? "" : cb->pass);
163 size_t credentials_size;
165 credentials_size = strlen (cb->user) + 2;
166 if (cb->pass != NULL)
167 credentials_size += strlen (cb->pass);
169 cb->credentials = (char *) malloc (credentials_size);
170 if (cb->credentials == NULL)
172 ERROR ("curl plugin: malloc failed.");
176 ssnprintf (cb->credentials, credentials_size, "%s:%s",
177 cb->user, (cb->pass == NULL) ? "" : cb->pass);
178 curl_easy_setopt (cb->curl, CURLOPT_USERPWD, cb->credentials);
180 curl_easy_setopt (cb->curl, CURLOPT_HTTPAUTH, CURLAUTH_ANY);
183 curl_easy_setopt (cb->curl, CURLOPT_SSL_VERIFYPEER, (long) cb->verify_peer);
184 curl_easy_setopt (cb->curl, CURLOPT_SSL_VERIFYHOST,
185 cb->verify_host ? 2L : 0L);
186 curl_easy_setopt (cb->curl, CURLOPT_SSLVERSION, cb->sslversion);
187 if (cb->cacert != NULL)
188 curl_easy_setopt (cb->curl, CURLOPT_CAINFO, cb->cacert);
189 if (cb->capath != NULL)
190 curl_easy_setopt (cb->curl, CURLOPT_CAPATH, cb->capath);
192 if (cb->clientkey != NULL && cb->clientcert != NULL)
194 curl_easy_setopt (cb->curl, CURLOPT_SSLKEY, cb->clientkey);
195 curl_easy_setopt (cb->curl, CURLOPT_SSLCERT, cb->clientcert);
197 if (cb->clientkeypass != NULL)
198 curl_easy_setopt (cb->curl, CURLOPT_SSLKEYPASSWD, cb->clientkeypass);
201 wh_reset_buffer (cb);
204 } /* }}} int wh_callback_init */
206 static int wh_flush_nolock (cdtime_t timeout, wh_callback_t *cb) /* {{{ */
210 DEBUG ("write_http plugin: wh_flush_nolock: timeout = %.3f; "
211 "send_buffer_fill = %zu;",
212 CDTIME_T_TO_DOUBLE (timeout),
213 cb->send_buffer_fill);
215 /* timeout == 0 => flush unconditionally */
221 if ((cb->send_buffer_init_time + timeout) > now)
225 if (cb->format == WH_FORMAT_COMMAND)
227 if (cb->send_buffer_fill <= 0)
229 cb->send_buffer_init_time = cdtime ();
233 status = wh_send_buffer (cb);
234 wh_reset_buffer (cb);
236 else if (cb->format == WH_FORMAT_JSON)
238 if (cb->send_buffer_fill <= 2)
240 cb->send_buffer_init_time = cdtime ();
244 status = format_json_finalize (cb->send_buffer,
245 &cb->send_buffer_fill,
246 &cb->send_buffer_free);
249 ERROR ("write_http: wh_flush_nolock: "
250 "format_json_finalize failed.");
251 wh_reset_buffer (cb);
255 status = wh_send_buffer (cb);
256 wh_reset_buffer (cb);
260 ERROR ("write_http: wh_flush_nolock: "
261 "Unknown format: %i",
267 } /* }}} wh_flush_nolock */
269 static int wh_flush (cdtime_t timeout, /* {{{ */
270 const char *identifier __attribute__((unused)),
271 user_data_t *user_data)
276 if (user_data == NULL)
279 cb = user_data->data;
281 pthread_mutex_lock (&cb->send_lock);
283 if (cb->curl == NULL)
285 status = wh_callback_init (cb);
288 ERROR ("write_http plugin: wh_callback_init failed.");
289 pthread_mutex_unlock (&cb->send_lock);
294 status = wh_flush_nolock (timeout, cb);
295 pthread_mutex_unlock (&cb->send_lock);
298 } /* }}} int wh_flush */
300 static void wh_callback_free (void *data) /* {{{ */
309 wh_flush_nolock (/* timeout = */ 0, cb);
311 if (cb->curl != NULL)
313 curl_easy_cleanup (cb->curl);
317 if (cb->headers != NULL)
319 curl_slist_free_all (cb->headers);
324 sfree (cb->location);
327 sfree (cb->credentials);
330 sfree (cb->clientkey);
331 sfree (cb->clientcert);
332 sfree (cb->clientkeypass);
333 sfree (cb->send_buffer);
336 } /* }}} void wh_callback_free */
338 static int wh_write_command (const data_set_t *ds, const value_list_t *vl, /* {{{ */
341 char key[10*DATA_MAX_NAME_LEN];
348 if (0 != strcmp (ds->type, vl->type)) {
349 ERROR ("write_http plugin: DS type does not match "
354 /* Copy the identifier to `key' and escape it. */
355 status = FORMAT_VL (key, sizeof (key), vl);
357 ERROR ("write_http plugin: error with format_name");
360 escape_string (key, sizeof (key));
362 /* Convert the values to an ASCII representation and put that into
364 status = format_values (values, sizeof (values), ds, vl, cb->store_rates);
366 ERROR ("write_http plugin: error with "
367 "wh_value_list_to_string");
371 command_len = (size_t) ssnprintf (command, sizeof (command),
372 "PUTVAL %s interval=%.3f %s\r\n",
374 CDTIME_T_TO_DOUBLE (vl->interval),
376 if (command_len >= sizeof (command)) {
377 ERROR ("write_http plugin: Command buffer too small: "
378 "Need %zu bytes.", command_len + 1);
382 pthread_mutex_lock (&cb->send_lock);
384 if (cb->curl == NULL)
386 status = wh_callback_init (cb);
389 ERROR ("write_http plugin: wh_callback_init failed.");
390 pthread_mutex_unlock (&cb->send_lock);
395 if (command_len >= cb->send_buffer_free)
397 status = wh_flush_nolock (/* timeout = */ 0, cb);
400 pthread_mutex_unlock (&cb->send_lock);
404 assert (command_len < cb->send_buffer_free);
406 /* `command_len + 1' because `command_len' does not include the
407 * trailing null byte. Neither does `send_buffer_fill'. */
408 memcpy (cb->send_buffer + cb->send_buffer_fill,
409 command, command_len + 1);
410 cb->send_buffer_fill += command_len;
411 cb->send_buffer_free -= command_len;
413 DEBUG ("write_http plugin: <%s> buffer %zu/%zu (%g%%) \"%s\"",
415 cb->send_buffer_fill, cb->send_buffer_size,
416 100.0 * ((double) cb->send_buffer_fill) / ((double) cb->send_buffer_size),
419 /* Check if we have enough space for this command. */
420 pthread_mutex_unlock (&cb->send_lock);
423 } /* }}} int wh_write_command */
425 static int wh_write_json (const data_set_t *ds, const value_list_t *vl, /* {{{ */
430 pthread_mutex_lock (&cb->send_lock);
432 if (cb->curl == NULL)
434 status = wh_callback_init (cb);
437 ERROR ("write_http plugin: wh_callback_init failed.");
438 pthread_mutex_unlock (&cb->send_lock);
443 status = format_json_value_list (cb->send_buffer,
444 &cb->send_buffer_fill,
445 &cb->send_buffer_free,
446 ds, vl, cb->store_rates);
447 if (status == (-ENOMEM))
449 status = wh_flush_nolock (/* timeout = */ 0, cb);
452 wh_reset_buffer (cb);
453 pthread_mutex_unlock (&cb->send_lock);
457 status = format_json_value_list (cb->send_buffer,
458 &cb->send_buffer_fill,
459 &cb->send_buffer_free,
460 ds, vl, cb->store_rates);
464 pthread_mutex_unlock (&cb->send_lock);
468 DEBUG ("write_http plugin: <%s> buffer %zu/%zu (%g%%)",
470 cb->send_buffer_fill, cb->send_buffer_size,
471 100.0 * ((double) cb->send_buffer_fill) / ((double) cb->send_buffer_size));
473 /* Check if we have enough space for this command. */
474 pthread_mutex_unlock (&cb->send_lock);
477 } /* }}} int wh_write_json */
479 static int wh_write (const data_set_t *ds, const value_list_t *vl, /* {{{ */
480 user_data_t *user_data)
485 if (user_data == NULL)
488 cb = user_data->data;
490 if (cb->format == WH_FORMAT_JSON)
491 status = wh_write_json (ds, vl, cb);
493 status = wh_write_command (ds, vl, cb);
496 } /* }}} int wh_write */
498 static int config_set_format (wh_callback_t *cb, /* {{{ */
503 if ((ci->values_num != 1)
504 || (ci->values[0].type != OCONFIG_TYPE_STRING))
506 WARNING ("write_http plugin: The `%s' config option "
507 "needs exactly one string argument.", ci->key);
511 string = ci->values[0].value.string;
512 if (strcasecmp ("Command", string) == 0)
513 cb->format = WH_FORMAT_COMMAND;
514 else if (strcasecmp ("JSON", string) == 0)
515 cb->format = WH_FORMAT_JSON;
518 ERROR ("write_http plugin: Invalid format string: %s",
524 } /* }}} int config_set_format */
526 static int wh_config_node (oconfig_item_t *ci) /* {{{ */
530 user_data_t user_data;
531 char callback_name[DATA_MAX_NAME_LEN];
534 cb = malloc (sizeof (*cb));
537 ERROR ("write_http plugin: malloc failed.");
540 memset (cb, 0, sizeof (*cb));
543 cb->format = WH_FORMAT_COMMAND;
544 cb->sslversion = CURL_SSLVERSION_DEFAULT;
545 cb->low_speed_limit = 0;
549 pthread_mutex_init (&cb->send_lock, /* attr = */ NULL);
551 cf_util_get_string (ci, &cb->name);
553 /* FIXME: Remove this legacy mode in version 6. */
554 if (strcasecmp ("URL", ci->key) == 0)
555 cf_util_get_string (ci, &cb->location);
557 for (i = 0; i < ci->children_num; i++)
559 oconfig_item_t *child = ci->children + i;
561 if (strcasecmp ("URL", child->key) == 0)
562 cf_util_get_string (child, &cb->location);
563 else if (strcasecmp ("User", child->key) == 0)
564 cf_util_get_string (child, &cb->user);
565 else if (strcasecmp ("Password", child->key) == 0)
566 cf_util_get_string (child, &cb->pass);
567 else if (strcasecmp ("VerifyPeer", child->key) == 0)
568 cf_util_get_boolean (child, &cb->verify_peer);
569 else if (strcasecmp ("VerifyHost", child->key) == 0)
570 cf_util_get_boolean (child, &cb->verify_host);
571 else if (strcasecmp ("CACert", child->key) == 0)
572 cf_util_get_string (child, &cb->cacert);
573 else if (strcasecmp ("CAPath", child->key) == 0)
574 cf_util_get_string (child, &cb->capath);
575 else if (strcasecmp ("ClientKey", child->key) == 0)
576 cf_util_get_string (child, &cb->clientkey);
577 else if (strcasecmp ("ClientCert", child->key) == 0)
578 cf_util_get_string (child, &cb->clientcert);
579 else if (strcasecmp ("ClientKeyPass", child->key) == 0)
580 cf_util_get_string (child, &cb->clientkeypass);
581 else if (strcasecmp ("SSLVersion", child->key) == 0)
585 cf_util_get_string (child, &value);
587 if (value == NULL || strcasecmp ("default", value) == 0)
588 cb->sslversion = CURL_SSLVERSION_DEFAULT;
589 else if (strcasecmp ("SSLv2", value) == 0)
590 cb->sslversion = CURL_SSLVERSION_SSLv2;
591 else if (strcasecmp ("SSLv3", value) == 0)
592 cb->sslversion = CURL_SSLVERSION_SSLv3;
593 else if (strcasecmp ("TLSv1", value) == 0)
594 cb->sslversion = CURL_SSLVERSION_TLSv1;
595 #if (LIBCURL_VERSION_MAJOR > 7) || (LIBCURL_VERSION_MAJOR == 7 && LIBCURL_VERSION_MINOR >= 34)
596 else if (strcasecmp ("TLSv1_0", value) == 0)
597 cb->sslversion = CURL_SSLVERSION_TLSv1_0;
598 else if (strcasecmp ("TLSv1_1", value) == 0)
599 cb->sslversion = CURL_SSLVERSION_TLSv1_1;
600 else if (strcasecmp ("TLSv1_2", value) == 0)
601 cb->sslversion = CURL_SSLVERSION_TLSv1_2;
604 ERROR ("write_http plugin: Invalid SSLVersion "
605 "option: %s.", value);
609 else if (strcasecmp ("Format", child->key) == 0)
610 config_set_format (cb, child);
611 else if (strcasecmp ("StoreRates", child->key) == 0)
612 cf_util_get_boolean (child, &cb->store_rates);
613 else if (strcasecmp ("BufferSize", child->key) == 0)
614 cf_util_get_int (child, &buffer_size);
615 else if (strcasecmp ("LowSpeedLimit", child->key) == 0)
616 cf_util_get_int (child, &cb->low_speed_limit);
617 else if (strcasecmp ("Timeout", child->key) == 0)
618 cf_util_get_int (child, &cb->timeout);
621 ERROR ("write_http plugin: Invalid configuration "
622 "option: %s.", child->key);
626 if (cb->location == NULL)
628 ERROR ("write_http plugin: no URL defined for instance '%s'",
630 wh_callback_free (cb);
634 if (cb->low_speed_limit > 0)
635 cb->low_speed_time = CDTIME_T_TO_TIME_T(plugin_get_interval());
637 /* Determine send_buffer_size. */
638 cb->send_buffer_size = WRITE_HTTP_DEFAULT_BUFFER_SIZE;
639 if (buffer_size >= 1024)
640 cb->send_buffer_size = (size_t) buffer_size;
641 else if (buffer_size != 0)
642 ERROR ("write_http plugin: Ignoring invalid BufferSize setting (%d).",
645 /* Allocate the buffer. */
646 cb->send_buffer = malloc (cb->send_buffer_size);
647 if (cb->send_buffer == NULL)
649 ERROR ("write_http plugin: malloc(%zu) failed.", cb->send_buffer_size);
650 wh_callback_free (cb);
653 /* Nulls the buffer and sets ..._free and ..._fill. */
654 wh_reset_buffer (cb);
656 ssnprintf (callback_name, sizeof (callback_name), "write_http/%s",
658 DEBUG ("write_http: Registering write callback '%s' with URL '%s'",
659 callback_name, cb->location);
661 memset (&user_data, 0, sizeof (user_data));
663 user_data.free_func = NULL;
664 plugin_register_flush (callback_name, wh_flush, &user_data);
666 user_data.free_func = wh_callback_free;
667 plugin_register_write (callback_name, wh_write, &user_data);
670 } /* }}} int wh_config_node */
672 static int wh_config (oconfig_item_t *ci) /* {{{ */
676 for (i = 0; i < ci->children_num; i++)
678 oconfig_item_t *child = ci->children + i;
680 if (strcasecmp ("Node", child->key) == 0)
681 wh_config_node (child);
682 /* FIXME: Remove this legacy mode in version 6. */
683 else if (strcasecmp ("URL", child->key) == 0) {
684 WARNING ("write_http plugin: Legacy <URL> block found. "
685 "Please use <Node> instead.");
686 wh_config_node (child);
690 ERROR ("write_http plugin: Invalid configuration "
691 "option: %s.", child->key);
696 } /* }}} int wh_config */
698 static int wh_init (void) /* {{{ */
700 /* Call this while collectd is still single-threaded to avoid
701 * initialization issues in libgcrypt. */
702 curl_global_init (CURL_GLOBAL_SSL);
704 } /* }}} int wh_init */
706 void module_register (void) /* {{{ */
708 plugin_register_complex_config ("write_http", wh_config);
709 plugin_register_init ("write_http", wh_init);
710 } /* }}} void module_register */
712 /* vim: set fdm=marker sw=8 ts=8 tw=78 et : */