2 * collectd - src/write_http.c
3 * Copyright (C) 2009 Paul Sadauskas
4 * Copyright (C) 2009 Doug MacEachern
5 * Copyright (C) 2007-2009 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 verplant.org>
22 * Doug MacEachern <dougm@hyperic.com>
23 * Paul Sadauskas <psadauskas@gmail.com>
29 #include "utils_cache.h"
30 #include "utils_parse_option.h"
31 #include "utils_format_json.h"
37 #include <curl/curl.h>
54 #define WH_FORMAT_COMMAND 0
55 #define WH_FORMAT_JSON 1
59 char curl_errbuf[CURL_ERROR_SIZE];
61 char send_buffer[4096];
62 size_t send_buffer_free;
63 size_t send_buffer_fill;
64 time_t send_buffer_init_time;
66 pthread_mutex_t send_lock;
68 typedef struct wh_callback_s wh_callback_t;
70 static void wh_reset_buffer (wh_callback_t *cb) /* {{{ */
72 memset (cb->send_buffer, 0, sizeof (cb->send_buffer));
73 cb->send_buffer_free = sizeof (cb->send_buffer);
74 cb->send_buffer_fill = 0;
75 cb->send_buffer_init_time = time (NULL);
77 if (cb->format == WH_FORMAT_JSON)
79 format_json_initialize (cb->send_buffer,
80 &cb->send_buffer_fill,
81 &cb->send_buffer_free);
83 } /* }}} wh_reset_buffer */
85 static int wh_send_buffer (wh_callback_t *cb) /* {{{ */
89 curl_easy_setopt (cb->curl, CURLOPT_POSTFIELDS, cb->send_buffer);
90 status = curl_easy_perform (cb->curl);
93 ERROR ("write_http plugin: curl_easy_perform failed with "
95 status, cb->curl_errbuf);
98 } /* }}} wh_send_buffer */
100 static int wh_callback_init (wh_callback_t *cb) /* {{{ */
102 struct curl_slist *headers;
104 if (cb->curl != NULL)
107 cb->curl = curl_easy_init ();
108 if (cb->curl == NULL)
110 ERROR ("curl plugin: curl_easy_init failed.");
114 curl_easy_setopt (cb->curl, CURLOPT_USERAGENT, PACKAGE_NAME"/"PACKAGE_VERSION);
117 headers = curl_slist_append (headers, "Accept: */*");
118 if (cb->format == WH_FORMAT_JSON)
119 headers = curl_slist_append (headers, "Content-Type: application/json");
121 headers = curl_slist_append (headers, "Content-Type: text/plain");
122 headers = curl_slist_append (headers, "Expect:");
123 curl_easy_setopt (cb->curl, CURLOPT_HTTPHEADER, headers);
125 curl_easy_setopt (cb->curl, CURLOPT_ERRORBUFFER, cb->curl_errbuf);
126 curl_easy_setopt (cb->curl, CURLOPT_URL, cb->location);
128 if (cb->user != NULL)
130 size_t credentials_size;
132 credentials_size = strlen (cb->user) + 2;
133 if (cb->pass != NULL)
134 credentials_size += strlen (cb->pass);
136 cb->credentials = (char *) malloc (credentials_size);
137 if (cb->credentials == NULL)
139 ERROR ("curl plugin: malloc failed.");
143 ssnprintf (cb->credentials, credentials_size, "%s:%s",
144 cb->user, (cb->pass == NULL) ? "" : cb->pass);
145 curl_easy_setopt (cb->curl, CURLOPT_USERPWD, cb->credentials);
146 curl_easy_setopt (cb->curl, CURLOPT_HTTPAUTH, CURLAUTH_ANY);
149 curl_easy_setopt (cb->curl, CURLOPT_SSL_VERIFYPEER, cb->verify_peer);
150 curl_easy_setopt (cb->curl, CURLOPT_SSL_VERIFYHOST,
151 cb->verify_host ? 2 : 0);
152 if (cb->cacert != NULL)
153 curl_easy_setopt (cb->curl, CURLOPT_CAINFO, cb->cacert);
155 wh_reset_buffer (cb);
158 } /* }}} int wh_callback_init */
160 static int wh_flush_nolock (int timeout, wh_callback_t *cb) /* {{{ */
164 DEBUG ("write_http plugin: wh_flush_nolock: timeout = %i; "
165 "send_buffer_fill = %zu;",
166 timeout, cb->send_buffer_fill);
173 if ((cb->send_buffer_init_time + timeout) > now)
177 if (cb->format == WH_FORMAT_COMMAND)
179 if (cb->send_buffer_fill <= 0)
181 cb->send_buffer_init_time = time (NULL);
185 status = wh_send_buffer (cb);
186 wh_reset_buffer (cb);
188 else if (cb->format == WH_FORMAT_JSON)
190 if (cb->send_buffer_fill <= 2)
192 cb->send_buffer_init_time = time (NULL);
196 status = format_json_finalize (cb->send_buffer,
197 &cb->send_buffer_fill,
198 &cb->send_buffer_free);
201 ERROR ("write_http: wh_flush_nolock: "
202 "format_json_finalize failed.");
203 wh_reset_buffer (cb);
207 status = wh_send_buffer (cb);
208 wh_reset_buffer (cb);
212 ERROR ("write_http: wh_flush_nolock: "
213 "Unknown format: %i",
219 } /* }}} wh_flush_nolock */
221 static int wh_flush (int timeout, /* {{{ */
222 const char *identifier __attribute__((unused)),
223 user_data_t *user_data)
228 if (user_data == NULL)
231 cb = user_data->data;
233 pthread_mutex_lock (&cb->send_lock);
235 if (cb->curl == NULL)
237 status = wh_callback_init (cb);
240 ERROR ("write_http plugin: wh_callback_init failed.");
241 pthread_mutex_unlock (&cb->send_lock);
246 status = wh_flush_nolock (timeout, cb);
247 pthread_mutex_unlock (&cb->send_lock);
250 } /* }}} int wh_flush */
252 static void wh_callback_free (void *data) /* {{{ */
261 wh_flush_nolock (/* timeout = */ -1, cb);
263 curl_easy_cleanup (cb->curl);
264 sfree (cb->location);
267 sfree (cb->credentials);
271 } /* }}} void wh_callback_free */
273 static int wh_value_list_to_string (char *buffer, /* {{{ */
275 const data_set_t *ds, const value_list_t *vl,
281 gauge_t *rates = NULL;
283 assert (0 == strcmp (ds->type, vl->type));
285 memset (buffer, 0, buffer_size);
287 #define BUFFER_ADD(...) do { \
288 status = ssnprintf (buffer + offset, buffer_size - offset, \
292 else if (((size_t) status) >= (buffer_size - offset)) \
295 offset += ((size_t) status); \
298 BUFFER_ADD ("%lu", (unsigned long) vl->time);
300 for (i = 0; i < ds->ds_num; i++)
302 if (ds->ds[i].type == DS_TYPE_GAUGE)
303 BUFFER_ADD (":%f", vl->values[i].gauge);
304 else if (ds->ds[i].type == DS_TYPE_COUNTER)
306 if (cb->store_rates != 0)
309 rates = uc_get_rate (ds, vl);
312 WARNING ("write_http plugin: "
313 "uc_get_rate failed.");
316 BUFFER_ADD (":%lf", rates[i]);
319 BUFFER_ADD (":%llu", vl->values[i].counter);
321 else if (ds->ds[i].type == DS_TYPE_DERIVE)
322 BUFFER_ADD (":%"PRIi64, vl->values[i].derive);
323 else if (ds->ds[i].type == DS_TYPE_ABSOLUTE)
324 BUFFER_ADD (":%"PRIu64, vl->values[i].absolute);
327 ERROR ("write_http plugin: Unknown data source type: %i",
331 } /* for ds->ds_num */
336 } /* }}} int wh_value_list_to_string */
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 = wh_value_list_to_string (values, sizeof (values), ds, vl, cb);
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=%i %s\r\n",
373 key, vl->interval, values);
374 if (command_len >= sizeof (command)) {
375 ERROR ("write_http plugin: Command buffer too small: "
376 "Need %zu bytes.", command_len + 1);
380 pthread_mutex_lock (&cb->send_lock);
382 if (cb->curl == NULL)
384 status = wh_callback_init (cb);
387 ERROR ("write_http plugin: wh_callback_init failed.");
388 pthread_mutex_unlock (&cb->send_lock);
393 if (command_len >= cb->send_buffer_free)
395 status = wh_flush_nolock (/* timeout = */ -1, cb);
398 pthread_mutex_unlock (&cb->send_lock);
402 assert (command_len < cb->send_buffer_free);
404 /* `command_len + 1' because `command_len' does not include the
405 * trailing null byte. Neither does `send_buffer_fill'. */
406 memcpy (cb->send_buffer + cb->send_buffer_fill,
407 command, command_len + 1);
408 cb->send_buffer_fill += command_len;
409 cb->send_buffer_free -= command_len;
411 DEBUG ("write_http plugin: <%s> buffer %zu/%zu (%g%%) \"%s\"",
413 cb->send_buffer_fill, sizeof (cb->send_buffer),
414 100.0 * ((double) cb->send_buffer_fill) / ((double) sizeof (cb->send_buffer)),
417 /* Check if we have enough space for this command. */
418 pthread_mutex_unlock (&cb->send_lock);
421 } /* }}} int wh_write_command */
423 static int wh_write_json (const data_set_t *ds, const value_list_t *vl, /* {{{ */
428 pthread_mutex_lock (&cb->send_lock);
430 if (cb->curl == NULL)
432 status = wh_callback_init (cb);
435 ERROR ("write_http plugin: wh_callback_init failed.");
436 pthread_mutex_unlock (&cb->send_lock);
441 status = format_json_value_list (cb->send_buffer,
442 &cb->send_buffer_fill,
443 &cb->send_buffer_free,
445 if (status == (-ENOMEM))
447 status = wh_flush_nolock (/* timeout = */ -1, cb);
450 wh_reset_buffer (cb);
451 pthread_mutex_unlock (&cb->send_lock);
455 status = format_json_value_list (cb->send_buffer,
456 &cb->send_buffer_fill,
457 &cb->send_buffer_free,
462 pthread_mutex_unlock (&cb->send_lock);
466 DEBUG ("write_http plugin: <%s> buffer %zu/%zu (%g%%)",
468 cb->send_buffer_fill, sizeof (cb->send_buffer),
469 100.0 * ((double) cb->send_buffer_fill) / ((double) sizeof (cb->send_buffer)));
471 /* Check if we have enough space for this command. */
472 pthread_mutex_unlock (&cb->send_lock);
475 } /* }}} int wh_write_json */
477 static int wh_write (const data_set_t *ds, const value_list_t *vl, /* {{{ */
478 user_data_t *user_data)
483 if (user_data == NULL)
486 cb = user_data->data;
488 if (cb->format == WH_FORMAT_JSON)
489 status = wh_write_json (ds, vl, cb);
491 status = wh_write_command (ds, vl, cb);
494 } /* }}} int wh_write */
496 static int config_set_string (char **ret_string, /* {{{ */
501 if ((ci->values_num != 1)
502 || (ci->values[0].type != OCONFIG_TYPE_STRING))
504 WARNING ("write_http plugin: The `%s' config option "
505 "needs exactly one string argument.", ci->key);
509 string = strdup (ci->values[0].value.string);
512 ERROR ("write_http plugin: strdup failed.");
516 if (*ret_string != NULL)
518 *ret_string = string;
521 } /* }}} int config_set_string */
523 static int config_set_boolean (int *dest, oconfig_item_t *ci) /* {{{ */
525 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_BOOLEAN))
527 WARNING ("write_http plugin: The `%s' config option "
528 "needs exactly one boolean argument.", ci->key);
532 *dest = ci->values[0].value.boolean ? 1 : 0;
535 } /* }}} int config_set_boolean */
537 static int config_set_format (wh_callback_t *cb, /* {{{ */
542 if ((ci->values_num != 1)
543 || (ci->values[0].type != OCONFIG_TYPE_STRING))
545 WARNING ("write_http plugin: The `%s' config option "
546 "needs exactly one string argument.", ci->key);
550 string = ci->values[0].value.string;
551 if (strcasecmp ("Command", string) == 0)
552 cb->format = WH_FORMAT_COMMAND;
553 else if (strcasecmp ("JSON", string) == 0)
554 cb->format = WH_FORMAT_JSON;
557 ERROR ("write_http plugin: Invalid format string: %s",
563 } /* }}} int config_set_string */
565 static int wh_config_url (oconfig_item_t *ci) /* {{{ */
568 user_data_t user_data;
571 cb = malloc (sizeof (*cb));
574 ERROR ("write_http plugin: malloc failed.");
577 memset (cb, 0, sizeof (*cb));
581 cb->credentials = NULL;
585 cb->format = WH_FORMAT_COMMAND;
588 pthread_mutex_init (&cb->send_lock, /* attr = */ NULL);
590 config_set_string (&cb->location, ci);
591 if (cb->location == NULL)
594 for (i = 0; i < ci->children_num; i++)
596 oconfig_item_t *child = ci->children + i;
598 if (strcasecmp ("User", child->key) == 0)
599 config_set_string (&cb->user, child);
600 else if (strcasecmp ("Password", child->key) == 0)
601 config_set_string (&cb->pass, child);
602 else if (strcasecmp ("VerifyPeer", child->key) == 0)
603 config_set_boolean (&cb->verify_peer, child);
604 else if (strcasecmp ("VerifyHost", child->key) == 0)
605 config_set_boolean (&cb->verify_host, child);
606 else if (strcasecmp ("CACert", child->key) == 0)
607 config_set_string (&cb->cacert, child);
608 else if (strcasecmp ("Format", child->key) == 0)
609 config_set_format (cb, child);
610 else if (strcasecmp ("StoreRates", child->key) == 0)
611 config_set_boolean (&cb->store_rates, child);
614 ERROR ("write_http plugin: Invalid configuration "
615 "option: %s.", child->key);
619 DEBUG ("write_http: Registering write callback with URL %s",
622 memset (&user_data, 0, sizeof (user_data));
624 user_data.free_func = NULL;
625 plugin_register_flush ("write_http", wh_flush, &user_data);
627 user_data.free_func = wh_callback_free;
628 plugin_register_write ("write_http", wh_write, &user_data);
631 } /* }}} int wh_config_url */
633 static int wh_config (oconfig_item_t *ci) /* {{{ */
637 for (i = 0; i < ci->children_num; i++)
639 oconfig_item_t *child = ci->children + i;
641 if (strcasecmp ("URL", child->key) == 0)
642 wh_config_url (child);
645 ERROR ("write_http plugin: Invalid configuration "
646 "option: %s.", child->key);
651 } /* }}} int wh_config */
653 void module_register (void) /* {{{ */
655 plugin_register_complex_config ("write_http", wh_config);
656 } /* }}} void module_register */
658 /* vim: set fdm=marker sw=8 ts=8 tw=78 et : */