write_redis plugin: Use an "append" macro to fill the values buffer.
[collectd.git] / src / write_http.c
1 /**
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
6  *
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.
10  *
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.
15  *
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
19  *
20  * Authors:
21  *   Florian octo Forster <octo at verplant.org>
22  *   Doug MacEachern <dougm@hyperic.com>
23  *   Paul Sadauskas <psadauskas@gmail.com>
24  **/
25
26 #include "collectd.h"
27 #include "plugin.h"
28 #include "common.h"
29 #include "utils_cache.h"
30 #include "utils_parse_option.h"
31 #include "utils_format_json.h"
32
33 #if HAVE_PTHREAD_H
34 # include <pthread.h>
35 #endif
36
37 #include <curl/curl.h>
38
39 /*
40  * Private variables
41  */
42 struct wh_callback_s
43 {
44         char *location;
45
46         char *user;
47         char *pass;
48         char *credentials;
49         int   verify_peer;
50         int   verify_host;
51         char *cacert;
52         int   store_rates;
53
54 #define WH_FORMAT_COMMAND 0
55 #define WH_FORMAT_JSON    1
56         int format;
57
58         CURL *curl;
59         char curl_errbuf[CURL_ERROR_SIZE];
60
61         char   send_buffer[4096];
62         size_t send_buffer_free;
63         size_t send_buffer_fill;
64         time_t send_buffer_init_time;
65
66         pthread_mutex_t send_lock;
67 };
68 typedef struct wh_callback_s wh_callback_t;
69
70 static void wh_reset_buffer (wh_callback_t *cb)  /* {{{ */
71 {
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);
76
77         if (cb->format == WH_FORMAT_JSON)
78         {
79                 format_json_initialize (cb->send_buffer,
80                                 &cb->send_buffer_fill,
81                                 &cb->send_buffer_free);
82         }
83 } /* }}} wh_reset_buffer */
84
85 static int wh_send_buffer (wh_callback_t *cb) /* {{{ */
86 {
87         int status = 0;
88
89         curl_easy_setopt (cb->curl, CURLOPT_POSTFIELDS, cb->send_buffer);
90         status = curl_easy_perform (cb->curl);
91         if (status != 0)
92         {
93                 ERROR ("write_http plugin: curl_easy_perform failed with "
94                                 "status %i: %s",
95                                 status, cb->curl_errbuf);
96         }
97         return (status);
98 } /* }}} wh_send_buffer */
99
100 static int wh_callback_init (wh_callback_t *cb) /* {{{ */
101 {
102         struct curl_slist *headers;
103
104         if (cb->curl != NULL)
105                 return (0);
106
107         cb->curl = curl_easy_init ();
108         if (cb->curl == NULL)
109         {
110                 ERROR ("curl plugin: curl_easy_init failed.");
111                 return (-1);
112         }
113
114         curl_easy_setopt (cb->curl, CURLOPT_USERAGENT, PACKAGE_NAME"/"PACKAGE_VERSION);
115
116         headers = NULL;
117         headers = curl_slist_append (headers, "Accept:  */*");
118         if (cb->format == WH_FORMAT_JSON)
119                 headers = curl_slist_append (headers, "Content-Type: application/json");
120         else
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);
124
125         curl_easy_setopt (cb->curl, CURLOPT_ERRORBUFFER, cb->curl_errbuf);
126         curl_easy_setopt (cb->curl, CURLOPT_URL, cb->location);
127
128         if (cb->user != NULL)
129         {
130                 size_t credentials_size;
131
132                 credentials_size = strlen (cb->user) + 2;
133                 if (cb->pass != NULL)
134                         credentials_size += strlen (cb->pass);
135
136                 cb->credentials = (char *) malloc (credentials_size);
137                 if (cb->credentials == NULL)
138                 {
139                         ERROR ("curl plugin: malloc failed.");
140                         return (-1);
141                 }
142
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);
147         }
148
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);
154
155         wh_reset_buffer (cb);
156
157         return (0);
158 } /* }}} int wh_callback_init */
159
160 static int wh_flush_nolock (int timeout, wh_callback_t *cb) /* {{{ */
161 {
162         int status;
163
164         DEBUG ("write_http plugin: wh_flush_nolock: timeout = %i; "
165                         "send_buffer_fill = %zu;",
166                         timeout, cb->send_buffer_fill);
167
168         if (timeout > 0)
169         {
170                 time_t now;
171
172                 now = time (NULL);
173                 if ((cb->send_buffer_init_time + timeout) > now)
174                         return (0);
175         }
176
177         if (cb->format == WH_FORMAT_COMMAND)
178         {
179                 if (cb->send_buffer_fill <= 0)
180                 {
181                         cb->send_buffer_init_time = time (NULL);
182                         return (0);
183                 }
184
185                 status = wh_send_buffer (cb);
186                 wh_reset_buffer (cb);
187         }
188         else if (cb->format == WH_FORMAT_JSON)
189         {
190                 if (cb->send_buffer_fill <= 2)
191                 {
192                         cb->send_buffer_init_time = time (NULL);
193                         return (0);
194                 }
195
196                 status = format_json_finalize (cb->send_buffer,
197                                 &cb->send_buffer_fill,
198                                 &cb->send_buffer_free);
199                 if (status != 0)
200                 {
201                         ERROR ("write_http: wh_flush_nolock: "
202                                         "format_json_finalize failed.");
203                         wh_reset_buffer (cb);
204                         return (status);
205                 }
206
207                 status = wh_send_buffer (cb);
208                 wh_reset_buffer (cb);
209         }
210         else
211         {
212                 ERROR ("write_http: wh_flush_nolock: "
213                                 "Unknown format: %i",
214                                 cb->format);
215                 return (-1);
216         }
217
218         return (status);
219 } /* }}} wh_flush_nolock */
220
221 static int wh_flush (int timeout, /* {{{ */
222                 const char *identifier __attribute__((unused)),
223                 user_data_t *user_data)
224 {
225         wh_callback_t *cb;
226         int status;
227
228         if (user_data == NULL)
229                 return (-EINVAL);
230
231         cb = user_data->data;
232
233         pthread_mutex_lock (&cb->send_lock);
234
235         if (cb->curl == NULL)
236         {
237                 status = wh_callback_init (cb);
238                 if (status != 0)
239                 {
240                         ERROR ("write_http plugin: wh_callback_init failed.");
241                         pthread_mutex_unlock (&cb->send_lock);
242                         return (-1);
243                 }
244         }
245
246         status = wh_flush_nolock (timeout, cb);
247         pthread_mutex_unlock (&cb->send_lock);
248
249         return (status);
250 } /* }}} int wh_flush */
251
252 static void wh_callback_free (void *data) /* {{{ */
253 {
254         wh_callback_t *cb;
255
256         if (data == NULL)
257                 return;
258
259         cb = data;
260
261         wh_flush_nolock (/* timeout = */ -1, cb);
262
263         curl_easy_cleanup (cb->curl);
264         sfree (cb->location);
265         sfree (cb->user);
266         sfree (cb->pass);
267         sfree (cb->credentials);
268         sfree (cb->cacert);
269
270         sfree (cb);
271 } /* }}} void wh_callback_free */
272
273 static int wh_value_list_to_string (char *buffer, /* {{{ */
274                 size_t buffer_size,
275                 const data_set_t *ds, const value_list_t *vl,
276                 wh_callback_t *cb)
277 {
278         size_t offset = 0;
279         int status;
280         int i;
281         gauge_t *rates = NULL;
282
283         assert (0 == strcmp (ds->type, vl->type));
284
285         memset (buffer, 0, buffer_size);
286
287 #define BUFFER_ADD(...) do { \
288         status = ssnprintf (buffer + offset, buffer_size - offset, \
289                         __VA_ARGS__); \
290         if (status < 1) \
291         { \
292                 sfree (rates); \
293                 return (-1); \
294         } \
295         else if (((size_t) status) >= (buffer_size - offset)) \
296         { \
297                 sfree (rates); \
298                 return (-1); \
299         } \
300         else \
301                 offset += ((size_t) status); \
302 } while (0)
303
304         BUFFER_ADD ("%lu", (unsigned long) vl->time);
305
306         for (i = 0; i < ds->ds_num; i++)
307         {
308                 if (ds->ds[i].type == DS_TYPE_GAUGE)
309                         BUFFER_ADD (":%f", vl->values[i].gauge);
310                 else if (cb->store_rates)
311                 {
312                         if (rates == NULL)
313                                 rates = uc_get_rate (ds, vl);
314                         if (rates == NULL)
315                         {
316                                 WARNING ("write_http plugin: "
317                                                 "uc_get_rate failed.");
318                                 return (-1);
319                         }
320                         BUFFER_ADD (":%g", rates[i]);
321                 }
322                 else if (ds->ds[i].type == DS_TYPE_COUNTER)
323                         BUFFER_ADD (":%llu", vl->values[i].counter);
324                 else if (ds->ds[i].type == DS_TYPE_DERIVE)
325                         BUFFER_ADD (":%"PRIi64, vl->values[i].derive);
326                 else if (ds->ds[i].type == DS_TYPE_ABSOLUTE)
327                         BUFFER_ADD (":%"PRIu64, vl->values[i].absolute);
328                 else
329                 {
330                         ERROR ("write_http plugin: Unknown data source type: %i",
331                                         ds->ds[i].type);
332                         sfree (rates);
333                         return (-1);
334                 }
335         } /* for ds->ds_num */
336
337 #undef BUFFER_ADD
338
339         sfree (rates);
340         return (0);
341 } /* }}} int wh_value_list_to_string */
342
343 static int wh_write_command (const data_set_t *ds, const value_list_t *vl, /* {{{ */
344                 wh_callback_t *cb)
345 {
346         char key[10*DATA_MAX_NAME_LEN];
347         char values[512];
348         char command[1024];
349         size_t command_len;
350
351         int status;
352
353         if (0 != strcmp (ds->type, vl->type)) {
354                 ERROR ("write_http plugin: DS type does not match "
355                                 "value list type");
356                 return -1;
357         }
358
359         /* Copy the identifier to `key' and escape it. */
360         status = FORMAT_VL (key, sizeof (key), vl);
361         if (status != 0) {
362                 ERROR ("write_http plugin: error with format_name");
363                 return (status);
364         }
365         escape_string (key, sizeof (key));
366
367         /* Convert the values to an ASCII representation and put that into
368          * `values'. */
369         status = wh_value_list_to_string (values, sizeof (values), ds, vl, cb);
370         if (status != 0) {
371                 ERROR ("write_http plugin: error with "
372                                 "wh_value_list_to_string");
373                 return (status);
374         }
375
376         command_len = (size_t) ssnprintf (command, sizeof (command),
377                         "PUTVAL %s interval=%i %s\r\n",
378                         key, vl->interval, values);
379         if (command_len >= sizeof (command)) {
380                 ERROR ("write_http plugin: Command buffer too small: "
381                                 "Need %zu bytes.", command_len + 1);
382                 return (-1);
383         }
384
385         pthread_mutex_lock (&cb->send_lock);
386
387         if (cb->curl == NULL)
388         {
389                 status = wh_callback_init (cb);
390                 if (status != 0)
391                 {
392                         ERROR ("write_http plugin: wh_callback_init failed.");
393                         pthread_mutex_unlock (&cb->send_lock);
394                         return (-1);
395                 }
396         }
397
398         if (command_len >= cb->send_buffer_free)
399         {
400                 status = wh_flush_nolock (/* timeout = */ -1, cb);
401                 if (status != 0)
402                 {
403                         pthread_mutex_unlock (&cb->send_lock);
404                         return (status);
405                 }
406         }
407         assert (command_len < cb->send_buffer_free);
408
409         /* `command_len + 1' because `command_len' does not include the
410          * trailing null byte. Neither does `send_buffer_fill'. */
411         memcpy (cb->send_buffer + cb->send_buffer_fill,
412                         command, command_len + 1);
413         cb->send_buffer_fill += command_len;
414         cb->send_buffer_free -= command_len;
415
416         DEBUG ("write_http plugin: <%s> buffer %zu/%zu (%g%%) \"%s\"",
417                         cb->location,
418                         cb->send_buffer_fill, sizeof (cb->send_buffer),
419                         100.0 * ((double) cb->send_buffer_fill) / ((double) sizeof (cb->send_buffer)),
420                         command);
421
422         /* Check if we have enough space for this command. */
423         pthread_mutex_unlock (&cb->send_lock);
424
425         return (0);
426 } /* }}} int wh_write_command */
427
428 static int wh_write_json (const data_set_t *ds, const value_list_t *vl, /* {{{ */
429                 wh_callback_t *cb)
430 {
431         int status;
432
433         pthread_mutex_lock (&cb->send_lock);
434
435         if (cb->curl == NULL)
436         {
437                 status = wh_callback_init (cb);
438                 if (status != 0)
439                 {
440                         ERROR ("write_http plugin: wh_callback_init failed.");
441                         pthread_mutex_unlock (&cb->send_lock);
442                         return (-1);
443                 }
444         }
445
446         status = format_json_value_list (cb->send_buffer,
447                         &cb->send_buffer_fill,
448                         &cb->send_buffer_free,
449                         ds, vl, cb->store_rates);
450         if (status == (-ENOMEM))
451         {
452                 status = wh_flush_nolock (/* timeout = */ -1, cb);
453                 if (status != 0)
454                 {
455                         wh_reset_buffer (cb);
456                         pthread_mutex_unlock (&cb->send_lock);
457                         return (status);
458                 }
459
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         }
465         if (status != 0)
466         {
467                 pthread_mutex_unlock (&cb->send_lock);
468                 return (status);
469         }
470
471         DEBUG ("write_http plugin: <%s> buffer %zu/%zu (%g%%)",
472                         cb->location,
473                         cb->send_buffer_fill, sizeof (cb->send_buffer),
474                         100.0 * ((double) cb->send_buffer_fill) / ((double) sizeof (cb->send_buffer)));
475
476         /* Check if we have enough space for this command. */
477         pthread_mutex_unlock (&cb->send_lock);
478
479         return (0);
480 } /* }}} int wh_write_json */
481
482 static int wh_write (const data_set_t *ds, const value_list_t *vl, /* {{{ */
483                 user_data_t *user_data)
484 {
485         wh_callback_t *cb;
486         int status;
487
488         if (user_data == NULL)
489                 return (-EINVAL);
490
491         cb = user_data->data;
492
493         if (cb->format == WH_FORMAT_JSON)
494                 status = wh_write_json (ds, vl, cb);
495         else
496                 status = wh_write_command (ds, vl, cb);
497
498         return (status);
499 } /* }}} int wh_write */
500
501 static int config_set_string (char **ret_string, /* {{{ */
502                 oconfig_item_t *ci)
503 {
504         char *string;
505
506         if ((ci->values_num != 1)
507                         || (ci->values[0].type != OCONFIG_TYPE_STRING))
508         {
509                 WARNING ("write_http plugin: The `%s' config option "
510                                 "needs exactly one string argument.", ci->key);
511                 return (-1);
512         }
513
514         string = strdup (ci->values[0].value.string);
515         if (string == NULL)
516         {
517                 ERROR ("write_http plugin: strdup failed.");
518                 return (-1);
519         }
520
521         if (*ret_string != NULL)
522                 free (*ret_string);
523         *ret_string = string;
524
525         return (0);
526 } /* }}} int config_set_string */
527
528 static int config_set_boolean (int *dest, oconfig_item_t *ci) /* {{{ */
529 {
530         if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_BOOLEAN))
531         {
532                 WARNING ("write_http plugin: The `%s' config option "
533                                 "needs exactly one boolean argument.", ci->key);
534                 return (-1);
535         }
536
537         *dest = ci->values[0].value.boolean ? 1 : 0;
538
539         return (0);
540 } /* }}} int config_set_boolean */
541
542 static int config_set_format (wh_callback_t *cb, /* {{{ */
543                 oconfig_item_t *ci)
544 {
545         char *string;
546
547         if ((ci->values_num != 1)
548                         || (ci->values[0].type != OCONFIG_TYPE_STRING))
549         {
550                 WARNING ("write_http plugin: The `%s' config option "
551                                 "needs exactly one string argument.", ci->key);
552                 return (-1);
553         }
554
555         string = ci->values[0].value.string;
556         if (strcasecmp ("Command", string) == 0)
557                 cb->format = WH_FORMAT_COMMAND;
558         else if (strcasecmp ("JSON", string) == 0)
559                 cb->format = WH_FORMAT_JSON;
560         else
561         {
562                 ERROR ("write_http plugin: Invalid format string: %s",
563                                 string);
564                 return (-1);
565         }
566
567         return (0);
568 } /* }}} int config_set_string */
569
570 static int wh_config_url (oconfig_item_t *ci) /* {{{ */
571 {
572         wh_callback_t *cb;
573         user_data_t user_data;
574         int i;
575
576         cb = malloc (sizeof (*cb));
577         if (cb == NULL)
578         {
579                 ERROR ("write_http plugin: malloc failed.");
580                 return (-1);
581         }
582         memset (cb, 0, sizeof (*cb));
583         cb->location = NULL;
584         cb->user = NULL;
585         cb->pass = NULL;
586         cb->credentials = NULL;
587         cb->verify_peer = 1;
588         cb->verify_host = 1;
589         cb->cacert = NULL;
590         cb->format = WH_FORMAT_COMMAND;
591         cb->curl = NULL;
592
593         pthread_mutex_init (&cb->send_lock, /* attr = */ NULL);
594
595         config_set_string (&cb->location, ci);
596         if (cb->location == NULL)
597                 return (-1);
598
599         for (i = 0; i < ci->children_num; i++)
600         {
601                 oconfig_item_t *child = ci->children + i;
602
603                 if (strcasecmp ("User", child->key) == 0)
604                         config_set_string (&cb->user, child);
605                 else if (strcasecmp ("Password", child->key) == 0)
606                         config_set_string (&cb->pass, child);
607                 else if (strcasecmp ("VerifyPeer", child->key) == 0)
608                         config_set_boolean (&cb->verify_peer, child);
609                 else if (strcasecmp ("VerifyHost", child->key) == 0)
610                         config_set_boolean (&cb->verify_host, child);
611                 else if (strcasecmp ("CACert", child->key) == 0)
612                         config_set_string (&cb->cacert, child);
613                 else if (strcasecmp ("Format", child->key) == 0)
614                         config_set_format (cb, child);
615                 else if (strcasecmp ("StoreRates", child->key) == 0)
616                         config_set_boolean (&cb->store_rates, child);
617                 else
618                 {
619                         ERROR ("write_http plugin: Invalid configuration "
620                                         "option: %s.", child->key);
621                 }
622         }
623
624         DEBUG ("write_http: Registering write callback with URL %s",
625                         cb->location);
626
627         memset (&user_data, 0, sizeof (user_data));
628         user_data.data = cb;
629         user_data.free_func = NULL;
630         plugin_register_flush ("write_http", wh_flush, &user_data);
631
632         user_data.free_func = wh_callback_free;
633         plugin_register_write ("write_http", wh_write, &user_data);
634
635         return (0);
636 } /* }}} int wh_config_url */
637
638 static int wh_config (oconfig_item_t *ci) /* {{{ */
639 {
640         int i;
641
642         for (i = 0; i < ci->children_num; i++)
643         {
644                 oconfig_item_t *child = ci->children + i;
645
646                 if (strcasecmp ("URL", child->key) == 0)
647                         wh_config_url (child);
648                 else
649                 {
650                         ERROR ("write_http plugin: Invalid configuration "
651                                         "option: %s.", child->key);
652                 }
653         }
654
655         return (0);
656 } /* }}} int wh_config */
657
658 void module_register (void) /* {{{ */
659 {
660         plugin_register_complex_config ("write_http", wh_config);
661 } /* }}} void module_register */
662
663 /* vim: set fdm=marker sw=8 ts=8 tw=78 et : */