2 * collectd - src/curl_json.c
3 * Copyright (C) 2009 Doug MacEachern
4 * Copyright (C) 2006-2013 Florian octo Forster
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 * Doug MacEachern <dougm at hyperic.com>
21 * Florian octo Forster <octo at collectd.org>
27 #include "configfile.h"
28 #include "utils_avltree.h"
29 #include "utils_complain.h"
31 #include <sys/socket.h>
32 #include <sys/types.h>
35 #include <curl/curl.h>
37 #include <yajl/yajl_parse.h>
38 #if HAVE_YAJL_YAJL_VERSION_H
39 # include <yajl/yajl_version.h>
42 #if defined(YAJL_MAJOR) && (YAJL_MAJOR > 1)
43 # define HAVE_YAJL_V2 1
46 #define CJ_DEFAULT_HOST "localhost"
47 #define CJ_KEY_MAGIC 0x43484b59UL /* CHKY */
48 #define CJ_IS_KEY(key) ((key)->magic == CJ_KEY_MAGIC)
50 #define COUCH_MIN(x,y) ((x) < (y) ? (x) : (y))
53 typedef struct cj_key_s cj_key_t;
54 struct cj_key_s /* {{{ */
78 struct curl_slist *headers;
83 char curl_errbuf[CURL_ERROR_SIZE];
96 char name[DATA_MAX_NAME_LEN];
97 } state[YAJL_MAX_DEPTH];
99 typedef struct cj_s cj_t; /* }}} */
102 typedef size_t yajl_len_t;
104 typedef unsigned int yajl_len_t;
107 static int cj_read (user_data_t *ud);
108 static void cj_submit (cj_t *db, cj_key_t *key, value_t *value);
110 static size_t cj_curl_callback (void *buf, /* {{{ */
111 size_t size, size_t nmemb, void *user_data)
126 status = yajl_parse(db->yajl, (unsigned char *)buf, len);
127 if (status == yajl_status_ok)
130 else if (status == yajl_status_insufficient_data)
134 if (status != yajl_status_ok)
137 yajl_get_error(db->yajl, /* verbose = */ 1,
138 /* jsonText = */ (unsigned char *) buf, (unsigned int) len);
139 ERROR ("curl_json plugin: yajl_parse failed: %s", msg);
140 yajl_free_error(db->yajl, msg);
141 return (0); /* abort write callback */
145 } /* }}} size_t cj_curl_callback */
147 static int cj_get_type (cj_key_t *key)
149 const data_set_t *ds;
151 ds = plugin_get_ds (key->type);
154 static char type[DATA_MAX_NAME_LEN] = "!!!invalid!!!";
156 assert (key->type != NULL);
157 if (strcmp (type, key->type) != 0)
159 ERROR ("curl_json plugin: Unable to look up DS type \"%s\".",
161 sstrncpy (type, key->type, sizeof (type));
166 else if (ds->ds_num > 1)
168 static c_complain_t complaint = C_COMPLAIN_INIT_STATIC;
170 c_complain_once (LOG_WARNING, &complaint,
171 "curl_json plugin: The type \"%s\" has more than one data source. "
172 "This is currently not supported. I will return the type of the "
173 "first data source, but this will likely lead to problems later on.",
177 return ds->ds[0].type;
180 static int cj_cb_map_key (void *ctx, const unsigned char *val,
183 static void cj_cb_inc_array_index (void *ctx, _Bool update_key)
185 cj_t *db = (cj_t *)ctx;
187 if (!db->state[db->depth].in_array)
190 db->state[db->depth].index++;
194 char name[DATA_MAX_NAME_LEN];
196 ssnprintf (name, sizeof (name), "%d", db->state[db->depth].index - 1);
198 cj_cb_map_key (ctx, (unsigned char *)name, (yajl_len_t) strlen (name));
203 #define CJ_CB_ABORT 0
204 #define CJ_CB_CONTINUE 1
206 static int cj_cb_boolean (void * ctx, int boolVal)
208 cj_cb_inc_array_index (ctx, /* update_key = */ 0);
209 return (CJ_CB_CONTINUE);
212 static int cj_cb_null (void * ctx)
214 cj_cb_inc_array_index (ctx, /* update_key = */ 0);
215 return (CJ_CB_CONTINUE);
218 static int cj_cb_number (void *ctx,
219 const char *number, yajl_len_t number_len)
221 char buffer[number_len + 1];
223 cj_t *db = (cj_t *)ctx;
224 cj_key_t *key = db->state[db->depth].key;
229 /* Create a null-terminated version of the string. */
230 memcpy (buffer, number, number_len);
231 buffer[sizeof (buffer) - 1] = 0;
233 if ((key == NULL) || !CJ_IS_KEY (key)) {
234 if (key != NULL && !db->state[db->depth].in_array/*can be inhomogeneous*/)
235 NOTICE ("curl_json plugin: Found \"%s\", but the configuration expects"
237 cj_cb_inc_array_index (ctx, /* update_key = */ 1);
238 key = db->state[db->depth].key;
240 return (CJ_CB_CONTINUE);
245 cj_cb_inc_array_index (ctx, /* update_key = */ 1);
248 type = cj_get_type (key);
249 status = parse_value (buffer, &vt, type);
252 NOTICE ("curl_json plugin: Unable to parse number: \"%s\"", buffer);
253 return (CJ_CB_CONTINUE);
256 cj_submit (db, key, &vt);
257 return (CJ_CB_CONTINUE);
258 } /* int cj_cb_number */
260 /* Queries the key-tree of the parent context for "in_name" and, if found,
261 * updates the "key" field of the current context. Otherwise, "key" is set to
263 static int cj_cb_map_key (void *ctx,
264 unsigned char const *in_name, yajl_len_t in_name_len)
266 cj_t *db = (cj_t *)ctx;
269 tree = db->state[db->depth-1].tree;
273 cj_key_t *value = NULL;
277 /* Create a null-terminated version of the name. */
278 name = db->state[db->depth].name;
279 name_len = COUCH_MIN ((size_t) in_name_len,
280 sizeof (db->state[db->depth].name) - 1);
281 memcpy (name, in_name, name_len);
284 if (c_avl_get (tree, name, (void *) &value) == 0) {
285 if (CJ_IS_KEY((cj_key_t*)value)) {
286 db->state[db->depth].key = value;
289 db->state[db->depth].tree = (c_avl_tree_t*) value;
292 else if (c_avl_get (tree, CJ_ANY, (void *) &value) == 0)
293 if (CJ_IS_KEY((cj_key_t*)value)) {
294 db->state[db->depth].key = value;
297 db->state[db->depth].tree = (c_avl_tree_t*) value;
300 db->state[db->depth].key = NULL;
303 return (CJ_CB_CONTINUE);
306 static int cj_cb_string (void *ctx, const unsigned char *val,
309 /* Handle the string as if it was a number. */
310 return (cj_cb_number (ctx, (const char *) val, len));
311 } /* int cj_cb_string */
313 static int cj_cb_start (void *ctx)
315 cj_t *db = (cj_t *)ctx;
316 if (++db->depth >= YAJL_MAX_DEPTH)
318 ERROR ("curl_json plugin: %s depth exceeds max, aborting.",
319 db->url ? db->url : db->sock);
320 return (CJ_CB_ABORT);
322 return (CJ_CB_CONTINUE);
325 static int cj_cb_end (void *ctx)
327 cj_t *db = (cj_t *)ctx;
328 db->state[db->depth].tree = NULL;
330 return (CJ_CB_CONTINUE);
333 static int cj_cb_start_map (void *ctx)
335 cj_cb_inc_array_index (ctx, /* update_key = */ 1);
336 return cj_cb_start (ctx);
339 static int cj_cb_end_map (void *ctx)
341 return cj_cb_end (ctx);
344 static int cj_cb_start_array (void * ctx)
346 cj_t *db = (cj_t *)ctx;
347 cj_cb_inc_array_index (ctx, /* update_key = */ 1);
348 if (db->depth+1 < YAJL_MAX_DEPTH) {
349 db->state[db->depth+1].in_array = 1;
350 db->state[db->depth+1].index = 0;
352 return cj_cb_start (ctx);
355 static int cj_cb_end_array (void * ctx)
357 cj_t *db = (cj_t *)ctx;
358 db->state[db->depth].in_array = 0;
359 return cj_cb_end (ctx);
362 static yajl_callbacks ycallbacks = {
363 cj_cb_null, /* null */
364 cj_cb_boolean, /* boolean */
376 /* end yajl callbacks */
378 static void cj_key_free (cj_key_t *key) /* {{{ */
385 sfree (key->instance);
388 } /* }}} void cj_key_free */
390 static void cj_tree_free (c_avl_tree_t *tree) /* {{{ */
395 while (c_avl_pick (tree, (void *) &name, (void *) &value) == 0)
397 cj_key_t *key = (cj_key_t *)value;
402 cj_tree_free ((c_avl_tree_t *)value);
407 c_avl_destroy (tree);
408 } /* }}} void cj_tree_free */
410 static void cj_free (void *arg) /* {{{ */
414 DEBUG ("curl_json plugin: cj_free (arg = %p);", arg);
421 if (db->curl != NULL)
422 curl_easy_cleanup (db->curl);
425 if (db->tree != NULL)
426 cj_tree_free (db->tree);
429 sfree (db->instance);
437 sfree (db->credentials);
439 sfree (db->post_body);
440 curl_slist_free_all (db->headers);
443 } /* }}} void cj_free */
445 /* Configuration handling functions {{{ */
447 static c_avl_tree_t *cj_avl_create(void)
449 return c_avl_create ((int (*) (const void *, const void *)) strcmp);
452 static int cj_config_append_string (const char *name, struct curl_slist **dest, /* {{{ */
455 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
457 WARNING ("curl_json plugin: `%s' needs exactly one string argument.", name);
461 *dest = curl_slist_append(*dest, ci->values[0].value.string);
466 } /* }}} int cj_config_append_string */
468 static int cj_config_add_key (cj_t *db, /* {{{ */
475 if ((ci->values_num != 1)
476 || (ci->values[0].type != OCONFIG_TYPE_STRING))
478 WARNING ("curl_json plugin: The `Key' block "
479 "needs exactly one string argument.");
483 key = (cj_key_t *) malloc (sizeof (*key));
486 ERROR ("curl_json plugin: malloc failed.");
489 memset (key, 0, sizeof (*key));
490 key->magic = CJ_KEY_MAGIC;
492 if (strcasecmp ("Key", ci->key) == 0)
494 status = cf_util_get_string (ci, &key->path);
503 ERROR ("curl_json plugin: cj_config: "
504 "Invalid key: %s", ci->key);
509 for (i = 0; i < ci->children_num; i++)
511 oconfig_item_t *child = ci->children + i;
513 if (strcasecmp ("Type", child->key) == 0)
514 status = cf_util_get_string (child, &key->type);
515 else if (strcasecmp ("Instance", child->key) == 0)
516 status = cf_util_get_string (child, &key->instance);
519 WARNING ("curl_json plugin: Option `%s' not allowed here.", child->key);
525 } /* for (i = 0; i < ci->children_num; i++) */
529 if (key->type == NULL)
531 WARNING ("curl_json plugin: `Type' missing in `Key' block.");
536 } /* while (status == 0) */
538 /* store path in a tree that will match the json map structure, example:
539 * "httpd/requests/count",
540 * "httpd/requests/current" ->
541 * { "httpd": { "requests": { "count": $key, "current": $key } } }
550 if (db->tree == NULL)
551 db->tree = cj_avl_create();
570 len = COUCH_MIN(len, sizeof (ent)-1);
571 sstrncpy (ent, name, len+1);
573 if (c_avl_get (tree, ent, (void *) &value) != 0)
575 value = cj_avl_create ();
576 c_avl_insert (tree, strdup (ent), value);
585 c_avl_insert (tree, strdup(name), key);
588 ERROR ("curl_json plugin: invalid key: %s", key->path);
594 } /* }}} int cj_config_add_key */
596 static int cj_init_curl (cj_t *db) /* {{{ */
598 db->curl = curl_easy_init ();
599 if (db->curl == NULL)
601 ERROR ("curl_json plugin: curl_easy_init failed.");
605 curl_easy_setopt (db->curl, CURLOPT_NOSIGNAL, 1L);
606 curl_easy_setopt (db->curl, CURLOPT_WRITEFUNCTION, cj_curl_callback);
607 curl_easy_setopt (db->curl, CURLOPT_WRITEDATA, db);
608 curl_easy_setopt (db->curl, CURLOPT_USERAGENT, COLLECTD_USERAGENT);
609 curl_easy_setopt (db->curl, CURLOPT_ERRORBUFFER, db->curl_errbuf);
610 curl_easy_setopt (db->curl, CURLOPT_URL, db->url);
611 curl_easy_setopt (db->curl, CURLOPT_FOLLOWLOCATION, 1L);
612 curl_easy_setopt (db->curl, CURLOPT_MAXREDIRS, 50L);
614 if (db->user != NULL)
616 #ifdef HAVE_CURLOPT_USERNAME
617 curl_easy_setopt (db->curl, CURLOPT_USERNAME, db->user);
618 curl_easy_setopt (db->curl, CURLOPT_PASSWORD,
619 (db->pass == NULL) ? "" : db->pass);
621 size_t credentials_size;
623 credentials_size = strlen (db->user) + 2;
624 if (db->pass != NULL)
625 credentials_size += strlen (db->pass);
627 db->credentials = (char *) malloc (credentials_size);
628 if (db->credentials == NULL)
630 ERROR ("curl_json plugin: malloc failed.");
634 ssnprintf (db->credentials, credentials_size, "%s:%s",
635 db->user, (db->pass == NULL) ? "" : db->pass);
636 curl_easy_setopt (db->curl, CURLOPT_USERPWD, db->credentials);
640 curl_easy_setopt (db->curl, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST);
643 curl_easy_setopt (db->curl, CURLOPT_SSL_VERIFYPEER, (long) db->verify_peer);
644 curl_easy_setopt (db->curl, CURLOPT_SSL_VERIFYHOST,
645 db->verify_host ? 2L : 0L);
646 if (db->cacert != NULL)
647 curl_easy_setopt (db->curl, CURLOPT_CAINFO, db->cacert);
648 if (db->headers != NULL)
649 curl_easy_setopt (db->curl, CURLOPT_HTTPHEADER, db->headers);
650 if (db->post_body != NULL)
651 curl_easy_setopt (db->curl, CURLOPT_POSTFIELDS, db->post_body);
654 } /* }}} int cj_init_curl */
656 static int cj_config_add_url (oconfig_item_t *ci) /* {{{ */
662 if ((ci->values_num != 1)
663 || (ci->values[0].type != OCONFIG_TYPE_STRING))
665 WARNING ("curl_json plugin: The `URL' block "
666 "needs exactly one string argument.");
670 db = (cj_t *) malloc (sizeof (*db));
673 ERROR ("curl_json plugin: malloc failed.");
676 memset (db, 0, sizeof (*db));
678 if (strcasecmp ("URL", ci->key) == 0)
679 status = cf_util_get_string (ci, &db->url);
680 else if (strcasecmp ("Sock", ci->key) == 0)
681 status = cf_util_get_string (ci, &db->sock);
684 ERROR ("curl_json plugin: cj_config: "
685 "Invalid key: %s", ci->key);
694 /* Fill the `cj_t' structure.. */
695 for (i = 0; i < ci->children_num; i++)
697 oconfig_item_t *child = ci->children + i;
699 if (strcasecmp ("Instance", child->key) == 0)
700 status = cf_util_get_string (child, &db->instance);
701 else if (strcasecmp ("Host", child->key) == 0)
702 status = cf_util_get_string (child, &db->host);
703 else if (db->url && strcasecmp ("User", child->key) == 0)
704 status = cf_util_get_string (child, &db->user);
705 else if (db->url && strcasecmp ("Password", child->key) == 0)
706 status = cf_util_get_string (child, &db->pass);
707 else if (strcasecmp ("Digest", child->key) == 0)
708 status = cf_util_get_boolean (child, &db->digest);
709 else if (db->url && strcasecmp ("VerifyPeer", child->key) == 0)
710 status = cf_util_get_boolean (child, &db->verify_peer);
711 else if (db->url && strcasecmp ("VerifyHost", child->key) == 0)
712 status = cf_util_get_boolean (child, &db->verify_host);
713 else if (db->url && strcasecmp ("CACert", child->key) == 0)
714 status = cf_util_get_string (child, &db->cacert);
715 else if (db->url && strcasecmp ("Header", child->key) == 0)
716 status = cj_config_append_string ("Header", &db->headers, child);
717 else if (db->url && strcasecmp ("Post", child->key) == 0)
718 status = cf_util_get_string (child, &db->post_body);
719 else if (strcasecmp ("Key", child->key) == 0)
720 status = cj_config_add_key (db, child);
721 else if (strcasecmp ("Interval", child->key) == 0)
722 status = cf_util_get_cdtime(child, &db->interval);
725 WARNING ("curl_json plugin: Option `%s' not allowed here.", child->key);
735 if (db->tree == NULL)
737 WARNING ("curl_json plugin: No (valid) `Key' block within `%s' \"`%s'\".",
738 db->url ? "URL" : "Sock", db->url ? db->url : db->sock);
741 if (status == 0 && db->url)
742 status = cj_init_curl (db);
745 /* If all went well, register this database for reading */
750 struct timespec interval = { 0, 0 };
752 CDTIME_T_TO_TIMESPEC (db->interval, &interval);
754 if (db->instance == NULL)
755 db->instance = strdup("default");
757 DEBUG ("curl_json plugin: Registering new read callback: %s",
760 memset (&ud, 0, sizeof (ud));
761 ud.data = (void *) db;
762 ud.free_func = cj_free;
764 cb_name = ssnprintf_alloc ("curl_json-%s-%s",
765 db->instance, db->url ? db->url : db->sock);
767 plugin_register_complex_read (/* group = */ NULL, cb_name, cj_read,
768 /* interval = */ (db->interval > 0) ? &interval : NULL,
780 /* }}} int cj_config_add_database */
782 static int cj_config (oconfig_item_t *ci) /* {{{ */
792 for (i = 0; i < ci->children_num; i++)
794 oconfig_item_t *child = ci->children + i;
796 if (strcasecmp ("Sock", child->key) == 0
797 || strcasecmp ("URL", child->key) == 0)
799 status = cj_config_add_url (child);
807 WARNING ("curl_json plugin: Option `%s' not allowed here.", child->key);
812 if ((success == 0) && (errors > 0))
814 ERROR ("curl_json plugin: All statements failed.");
819 } /* }}} int cj_config */
821 /* }}} End of configuration handling functions */
823 static void cj_submit (cj_t *db, cj_key_t *key, value_t *value) /* {{{ */
825 value_list_t vl = VALUE_LIST_INIT;
831 if ((db->host == NULL)
832 || (strcmp ("", db->host) == 0)
833 || (strcmp (CJ_DEFAULT_HOST, db->host) == 0))
838 if (key->instance == NULL)
841 for (i = 0; i < db->depth; i++)
842 len += ssnprintf(vl.type_instance+len, sizeof(vl.type_instance)-len,
843 i ? "-%s" : "%s", db->state[i+1].name);
846 sstrncpy (vl.type_instance, key->instance, sizeof (vl.type_instance));
848 sstrncpy (vl.host, host, sizeof (vl.host));
849 sstrncpy (vl.plugin, "curl_json", sizeof (vl.plugin));
850 sstrncpy (vl.plugin_instance, db->instance, sizeof (vl.plugin_instance));
851 sstrncpy (vl.type, key->type, sizeof (vl.type));
853 if (db->interval > 0)
854 vl.interval = db->interval;
856 plugin_dispatch_values (&vl);
857 } /* }}} int cj_submit */
859 static int cj_sock_perform (cj_t *db) /* {{{ */
862 struct sockaddr_un sa_unix = {};
863 sa_unix.sun_family = AF_UNIX;
864 sstrncpy (sa_unix.sun_path, db->sock, sizeof (sa_unix.sun_path));
866 int fd = socket (AF_UNIX, SOCK_STREAM, 0);
869 if (connect (fd, (struct sockaddr *)&sa_unix, sizeof(sa_unix)) < 0)
871 ERROR ("curl_json plugin: connect(%s) failed: %s",
872 (db->sock != NULL) ? db->sock : "<null>",
873 sstrerror(errno, errbuf, sizeof (errbuf)));
880 unsigned char buffer[4096];
881 red = read (fd, buffer, sizeof(buffer));
883 ERROR ("curl_json plugin: read(%s) failed: %s",
884 (db->sock != NULL) ? db->sock : "<null>",
885 sstrerror(errno, errbuf, sizeof (errbuf)));
889 if (!cj_curl_callback (buffer, red, 1, db))
894 } /* }}} int cj_sock_perform */
897 static int cj_curl_perform(cj_t *db) /* {{{ */
904 status = curl_easy_perform (db->curl);
905 if (status != CURLE_OK)
907 ERROR ("curl_json plugin: curl_easy_perform failed with status %i: %s (%s)",
908 status, db->curl_errbuf, url);
912 curl_easy_getinfo(db->curl, CURLINFO_EFFECTIVE_URL, &url);
913 curl_easy_getinfo(db->curl, CURLINFO_RESPONSE_CODE, &rc);
915 /* The response code is zero if a non-HTTP transport was used. */
916 if ((rc != 0) && (rc != 200))
918 ERROR ("curl_json plugin: curl_easy_perform failed with "
919 "response code %ld (%s)", rc, url);
923 } /* }}} int cj_curl_perform */
925 static int cj_perform (cj_t *db) /* {{{ */
928 yajl_handle yprev = db->yajl;
930 db->yajl = yajl_alloc (&ycallbacks,
932 /* alloc funcs = */ NULL,
934 /* alloc funcs = */ NULL, NULL,
936 /* context = */ (void *)db);
937 if (db->yajl == NULL)
939 ERROR ("curl_json plugin: yajl_alloc failed.");
945 status = cj_curl_perform (db);
947 status = cj_sock_perform (db);
950 yajl_free (db->yajl);
956 status = yajl_complete_parse(db->yajl);
958 status = yajl_parse_complete(db->yajl);
960 if (status != yajl_status_ok)
962 unsigned char *errmsg;
964 errmsg = yajl_get_error (db->yajl, /* verbose = */ 0,
965 /* jsonText = */ NULL, /* jsonTextLen = */ 0);
966 ERROR ("curl_json plugin: yajl_parse_complete failed: %s",
968 yajl_free_error (db->yajl, errmsg);
969 yajl_free (db->yajl);
974 yajl_free (db->yajl);
977 } /* }}} int cj_perform */
979 static int cj_read (user_data_t *ud) /* {{{ */
983 if ((ud == NULL) || (ud->data == NULL))
985 ERROR ("curl_json plugin: cj_read: Invalid user data.");
989 db = (cj_t *) ud->data;
992 memset (&db->state, 0, sizeof(db->state));
993 db->state[db->depth].tree = db->tree;
996 return cj_perform (db);
997 } /* }}} int cj_read */
999 static int cj_init (void) /* {{{ */
1001 /* Call this while collectd is still single-threaded to avoid
1002 * initialization issues in libgcrypt. */
1003 curl_global_init (CURL_GLOBAL_SSL);
1005 } /* }}} int cj_init */
1007 void module_register (void)
1009 plugin_register_complex_config ("curl_json", cj_config);
1010 plugin_register_init ("curl_json", cj_init);
1011 } /* void module_register */
1013 /* vim: set sw=2 sts=2 et fdm=marker : */