src/plugins/timeseries/rrdtool.c

   1 /*
   2  * SysDB - src/plugins/timeseries/rrdtool.c
   3  * Copyright (C) 2014-2016 Sebastian 'tokkee' Harl <sh@tokkee.org>
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  16  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  17  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  18  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR
  19  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  20  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  21  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  22  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  23  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  24  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  25  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 #if HAVE_CONFIG_H
  29 #       include "config.h"
  30 #endif /* HAVE_CONFIG_H */
  31
  32 #include "sysdb.h"
  33 #include "core/plugin.h"
  34 #include "utils/error.h"
  35
  36 #include "liboconfig/utils.h"
  37
  38 #include <errno.h>
  39 #include <stdlib.h>
  40 #include <string.h>
  41 #include <strings.h>
  42 #include <rrd.h>
  43 #ifdef HAVE_RRD_CLIENT_H
  44 #       include <rrd_client.h>
  45 #endif
  46
  47 SDB_PLUGIN_MAGIC;
  48
  49 /* Current versions of RRDtool do not support multiple RRDCacheD client
  50  * connections. Use this to guard against multiple configured RRDCacheD
  51  * instances. */
  52 static bool rrdcached_in_use = 0;
  53
  54 static bool
  55 rrdcached_connect(char *addr)
  56 {
  57 #ifdef HAVE_RRD_CLIENT_H
  58         rrd_clear_error();
  59         if (! rrdc_is_connected(addr)) {
  60                 if (rrdc_connect(addr)) {
  61                         sdb_log(SDB_LOG_ERR, "timeseries::rrdtool: Failed to "
  62                                         "connectd to RRDCacheD at %s: %s",
  63                                         addr, rrd_get_error());
  64                         return 0;
  65                 }
  66         }
  67 #else
  68         sdb_log(SDB_LOG_ERR, "timeseries::rrdtool: Callback called with "
  69                         "RRDCacheD address but your build of SysDB does not support "
  70                         "that");
  71         return 0;
  72 #endif
  73         return 1;
  74 } /* rrdcached_connect */
  75
  76 /*
  77  * plugin API
  78  */
  79
  80 static sdb_timeseries_info_t *
  81 sdb_rrd_describe(const char *id, sdb_object_t *user_data)
  82 {
  83         rrd_info_t *info, *iter;
  84         char filename[strlen(id) + 1];
  85         sdb_timeseries_info_t *ts_info;
  86
  87         strncpy(filename, id, sizeof(filename));
  88
  89         if (user_data) {
  90                 /* -> use RRDCacheD */
  91                 char *addr = SDB_OBJ_WRAPPER(user_data)->data;
  92
  93                 if (! rrdcached_connect(addr))
  94                         return NULL;
  95
  96 #ifdef HAVE_RRD_CLIENT_H
  97                 /* TODO: detect and use rrdc_info if possible */
  98                 sdb_log(SDB_LOG_ERR, "timeseries::rrdtool: DESCRIBE not yet "
  99                                 "supported via RRDCacheD");
 100                 return NULL;
 101 #endif
 102         }
 103         else {
 104                 rrd_clear_error();
 105                 info = rrd_info_r(filename);
 106         }
 107         if (! info) {
 108                 sdb_log(SDB_LOG_ERR, "timeseries::rrdtool: Failed to extract "
 109                                 "header information from '%s': %s", filename,
 110                                 rrd_get_error());
 111                 return NULL;
 112         }
 113
 114         ts_info = calloc(1, sizeof(*ts_info));
 115         if (! ts_info) {
 116                 sdb_log(SDB_LOG_ERR, "timeseries::rrdtool: Failed to allocate memory");
 117                 rrd_info_free(info);
 118                 return NULL;
 119         }
 120
 121         for (iter = info; iter != NULL; iter = iter->next) {
 122                 size_t len, n, m;
 123                 char *ds_name;
 124                 char **tmp;
 125
 126                 /* Parse the DS name. The raw value is not exposed via the rrd_info
 127                  * interface. */
 128                 n = strlen("ds[");
 129                 if (strncmp(iter->key, "ds[", n))
 130                         continue;
 131
 132                 len = strlen(iter->key);
 133                 m = strlen("].index");
 134                 if ((len < m) || strcmp(iter->key + len - m, "].index"))
 135                         continue;
 136
 137                 ds_name = iter->key + n;
 138                 len -= n;
 139                 ds_name[len - m] = '\0';
 140
 141                 /* Append the new datum. */
 142                 tmp = realloc(ts_info->data_names,
 143                                 (ts_info->data_names_len + 1) * sizeof(*ts_info->data_names));
 144                 if (! tmp) {
 145                         sdb_log(SDB_LOG_ERR, "timeseries::rrdtool: Failed to allocate memory");
 146                         sdb_timeseries_info_destroy(ts_info);
 147                         rrd_info_free(info);
 148                         return NULL;
 149                 }
 150
 151                 ts_info->data_names = tmp;
 152                 ts_info->data_names[ts_info->data_names_len] = strdup(ds_name);
 153                 if (! ts_info->data_names[ts_info->data_names_len]) {
 154                         sdb_log(SDB_LOG_ERR, "timeseries::rrdtool: Failed to allocate memory");
 155                         sdb_timeseries_info_destroy(ts_info);
 156                         rrd_info_free(info);
 157                         return NULL;
 158                 }
 159                 ts_info->data_names_len++;
 160         }
 161         rrd_info_free(info);
 162
 163         return ts_info;
 164 } /* sdb_rrd_describe */
 165
 166 static sdb_timeseries_t *
 167 sdb_rrd_fetch(const char *id, sdb_timeseries_opts_t *opts,
 168                 sdb_object_t *user_data)
 169 {
 170         sdb_timeseries_t *ts;
 171
 172         time_t start = (time_t)SDB_TIME_TO_SECS(opts->start);
 173         time_t end = (time_t)SDB_TIME_TO_SECS(opts->end);
 174         time_t t;
 175
 176         unsigned long step = 0;
 177         unsigned long ds_cnt = 0;
 178         unsigned long val_cnt = 0;
 179         char **ds_namv = NULL;
 180         rrd_value_t *data = NULL, *data_ptr;
 181
 182         if (user_data) {
 183                 /* -> use RRDCacheD */
 184                 char *addr = SDB_OBJ_WRAPPER(user_data)->data;
 185
 186                 if (! rrdcached_connect(addr))
 187                         return NULL;
 188
 189 #ifdef HAVE_RRD_CLIENT_H
 190                 if (rrdc_flush(id)) {
 191                         sdb_log(SDB_LOG_ERR, "timeseries::rrdtool: Failed to flush "
 192                                         "'%s' through RRDCacheD: %s", id, rrd_get_error());
 193                         return NULL;
 194                 }
 195 #endif
 196         }
 197
 198 #define FREE_RRD_DATA() \
 199         do { \
 200                 size_t i; \
 201                 for (i = 0; i < ds_cnt; ++i) \
 202                         rrd_freemem(ds_namv[i]); \
 203                 rrd_freemem(ds_namv); \
 204                 rrd_freemem(data); \
 205         } while (0)
 206
 207         /* limit to about 1000 data-points for now
 208          * TODO: make this configurable */
 209         step = (end - start) / 1000;
 210
 211         if (rrd_fetch_r(id, "AVERAGE", &start, &end, &step,
 212                                 &ds_cnt, &ds_namv, &data)) {
 213                 char errbuf[1024];
 214                 sdb_strerror(errno, errbuf, sizeof(errbuf));
 215                 sdb_log(SDB_LOG_ERR, "rrdtool plugin: Failed to fetch data "
 216                                 "from %s: %s", id, errbuf);
 217                 return NULL;
 218         }
 219
 220         val_cnt = (unsigned long)(end - start) / step;
 221
 222         ts = sdb_timeseries_create(ds_cnt, (const char * const *)ds_namv, val_cnt);
 223         if (! ts) {
 224                 char errbuf[1024];
 225                 sdb_strerror(errno, errbuf, sizeof(errbuf));
 226                 sdb_log(SDB_LOG_ERR, "rrdtool plugin: Failed to allocate "
 227                                 "time-series object: %s", errbuf);
 228                 FREE_RRD_DATA();
 229                 return NULL;
 230         }
 231
 232         ts->start = SECS_TO_SDB_TIME(start + (time_t)step);
 233         ts->end = SECS_TO_SDB_TIME(end);
 234
 235         data_ptr = data;
 236         for (t = start + (time_t)step; t <= end; t += (time_t)step) {
 237                 unsigned long i, j;
 238
 239                 i = (unsigned long)(t - start) / step - 1;
 240
 241                 for (j = 0; j < ds_cnt; ++j) {
 242                         ts->data[j][i].timestamp = SECS_TO_SDB_TIME(t);
 243                         ts->data[j][i].value = *data_ptr;
 244                         ++data_ptr;
 245                 }
 246         }
 247
 248         FREE_RRD_DATA();
 249         return ts;
 250 } /* sdb_rrd_fetch */
 251
 252 static sdb_timeseries_fetcher_t fetcher_impl = {
 253         sdb_rrd_describe, sdb_rrd_fetch,
 254 };
 255
 256 static int
 257 sdb_rrdcached_shutdown(sdb_object_t __attribute__((unused)) *user_data)
 258 {
 259 #ifdef HAVE_RRD_CLIENT_H
 260         rrdc_disconnect();
 261 #endif
 262         return 0;
 263 } /* sdb_rrdcached_shutdown */
 264
 265 static int
 266 sdb_rrd_config_rrdcached(oconfig_item_t *ci)
 267 {
 268         sdb_object_t *ud;
 269         char *addr = NULL;
 270
 271         if (rrdcached_in_use) {
 272                 sdb_log(SDB_LOG_ERR, "timeseries::rrdtool: RRDCacheD does "
 273                                 "not support multiple connections");
 274                 return -1;
 275         }
 276
 277 #ifndef HAVE_RRD_CLIENT_H
 278         sdb_log(SDB_LOG_ERR, "timeseries::rrdtool: RRDCacheD client "
 279                         "support not available in your SysDB build");
 280         return -1;
 281 #else
 282         if (oconfig_get_string(ci, &addr)) {
 283                 sdb_log(SDB_LOG_ERR, "timeseries::unixsock: RRDCacheD requires "
 284                                 "a single string argument\n\tUsage <RRDCacheD ADDR>");
 285                 return -1;
 286         }
 287         if ((*addr != '/') && strncmp(addr, "unix:", strlen("unix:"))) {
 288                 /* XXX: add (optional) support for rrdc_fetch if available */
 289                 sdb_log(SDB_LOG_ERR, "timeseries::unixsock: RRDCacheD only "
 290                                 "supports local (UNIX socket) addresses");
 291                 return -1;
 292         }
 293
 294         addr = strdup(addr);
 295         if (! addr) {
 296                 char errbuf[1024];
 297                 sdb_log(SDB_LOG_ERR, "timeseries::unixsock: Failed to duplicate "
 298                                 "string: %s", sdb_strerror(errno, errbuf, sizeof(errbuf)));
 299                 return -1;
 300         }
 301         if (ci->children_num)
 302                 sdb_log(SDB_LOG_WARNING, "timeseries::unixsock: RRDCacheD does "
 303                                 "not support any child config options");
 304
 305         ud = sdb_object_create_wrapper("rrdcached-addr", addr, free);
 306         if (! ud) {
 307                 char errbuf[1024];
 308                 sdb_log(SDB_LOG_ERR, "timeseries::unixsock: Failed to create "
 309                                 "user-data object: %s",
 310                                 sdb_strerror(errno, errbuf, sizeof(errbuf)));
 311                 free(addr);
 312                 return -1;
 313         }
 314
 315         sdb_plugin_register_timeseries_fetcher("rrdcached", &fetcher_impl, ud);
 316         sdb_plugin_register_shutdown("rrdcached", sdb_rrdcached_shutdown, NULL);
 317         sdb_object_deref(ud);
 318         rrdcached_in_use = 1;
 319         return 0;
 320 #endif
 321 } /* sdb_rrd_config_rrdcached */
 322
 323 static int
 324 sdb_rrd_config(oconfig_item_t *ci)
 325 {
 326         int i;
 327
 328         if (! ci) { /* reconfigure */
 329                 rrdcached_in_use = 0;
 330                 return 0;
 331         }
 332
 333         for (i = 0; i < ci->children_num; ++i) {
 334                 oconfig_item_t *child = ci->children + i;
 335
 336                 if (! strcasecmp(child->key, "RRDCacheD"))
 337                         sdb_rrd_config_rrdcached(child);
 338                 else
 339                         sdb_log(SDB_LOG_WARNING, "timeseries::rrdtool: Ignoring "
 340                                         "unknown config option '%s'.", child->key);
 341         }
 342         return 0;
 343 } /* sdb_rrd_config */
 344
 345 int
 346 sdb_module_init(sdb_plugin_info_t *info)
 347 {
 348         sdb_plugin_set_info(info, SDB_PLUGIN_INFO_DESC,
 349                         "fetch time-series from RRD files");
 350         sdb_plugin_set_info(info, SDB_PLUGIN_INFO_COPYRIGHT,
 351                         "Copyright (C) 2014 Sebastian 'tokkee' Harl <sh@tokkee.org>");
 352         sdb_plugin_set_info(info, SDB_PLUGIN_INFO_LICENSE, "BSD");
 353         sdb_plugin_set_info(info, SDB_PLUGIN_INFO_VERSION, SDB_VERSION);
 354         sdb_plugin_set_info(info, SDB_PLUGIN_INFO_PLUGIN_VERSION, SDB_VERSION);
 355
 356         sdb_plugin_register_timeseries_fetcher("rrdtool", &fetcher_impl, NULL);
 357         sdb_plugin_register_config(sdb_rrd_config);
 358         return 0;
 359 } /* sdb_module_init */
 360
 361 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */
 362