src/collectdctl.c

   1 /**
   2  * collectd - src/collectdctl.c
   3  * Copyright (C) 2010 Håkon J Dugstad Johnsen
   4  * Copyright (C) 2010 Sebastian Harl
   5  *
   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.
   9  *
  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.
  14  *
  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
  18  *
  19  * Authors:
  20  *   Håkon J Dugstad Johnsen <hakon-dugstad.johnsen at telenor.com>
  21  *   Sebastian "tokkee" Harl <sh@tokkee.org>
  22  **/
  23
  24 #if HAVE_CONFIG_H
  25 #include "config.h"
  26 #endif
  27
  28 #include <stdarg.h>
  29 #include <stdio.h>
  30 #include <stdlib.h>
  31 #include <string.h>
  32 #include <strings.h>
  33 #include <unistd.h>
  34
  35 #include <assert.h>
  36 #include <errno.h>
  37
  38 #if NAN_STATIC_DEFAULT
  39 #include <math.h>
  40 /* #endif NAN_STATIC_DEFAULT*/
  41 #elif NAN_STATIC_ISOC
  42 #ifndef __USE_ISOC99
  43 #define DISABLE_ISOC99 1
  44 #define __USE_ISOC99 1
  45 #endif /* !defined(__USE_ISOC99) */
  46 #include <math.h>
  47 #if DISABLE_ISOC99
  48 #undef DISABLE_ISOC99
  49 #undef __USE_ISOC99
  50 #endif /* DISABLE_ISOC99 */
  51 /* #endif NAN_STATIC_ISOC */
  52 #elif NAN_ZERO_ZERO
  53 #include <math.h>
  54 #ifdef NAN
  55 #undef NAN
  56 #endif
  57 #define NAN (0.0 / 0.0)
  58 #ifndef isnan
  59 #define isnan(f) ((f) != (f))
  60 #endif /* !defined(isnan) */
  61 #ifndef isfinite
  62 #define isfinite(f) (((f) - (f)) == 0.0)
  63 #endif
  64 #ifndef isinf
  65 #define isinf(f) (!isfinite(f) && !isnan(f))
  66 #endif
  67 #endif /* NAN_ZERO_ZERO */
  68
  69 #include "collectd/client.h"
  70
  71 #ifndef PREFIX
  72 #define PREFIX "/opt/" PACKAGE_NAME
  73 #endif
  74
  75 #ifndef LOCALSTATEDIR
  76 #define LOCALSTATEDIR PREFIX "/var"
  77 #endif
  78
  79 #define DEFAULT_SOCK LOCALSTATEDIR "/run/" PACKAGE_NAME "-unixsock"
  80
  81 extern char *optarg;
  82 extern int optind;
  83
  84 /* ssnprintf returns zero on success, one if truncation occurred
  85    and a negative integer onerror. */
  86 static int _ssnprintf(char *str, size_t sz, const char *format, ...) {
  87   va_list ap;
  88   va_start(ap, format);
  89
  90   int ret = vsnprintf(str, sz, format, ap);
  91
  92   va_end(ap);
  93
  94   if (ret < 0) {
  95     return ret;
  96   }
  97   return (size_t)ret >= sz;
  98 } /* int _ssnprintf */
  99
 100 __attribute__((noreturn)) static void exit_usage(const char *name, int status) {
 101   fprintf(
 102       (status == 0) ? stdout : stderr,
 103       "Usage: %s [options] <command> [cmd options]\n\n"
 104
 105       "Available options:\n"
 106       "  -s       Path to collectd's UNIX socket.\n"
 107       "           Default: " DEFAULT_SOCK "\n"
 108
 109       "\n  -h       Display this help and exit.\n"
 110
 111       "\nAvailable commands:\n\n"
 112
 113       " * getval <identifier>\n"
 114       " * flush [timeout=<seconds>] [plugin=<name>] [identifier=<id>]\n"
 115       " * listval\n"
 116       " * putval <identifier> [interval=<seconds>] <value-list(s)>\n"
 117
 118       "\nIdentifiers:\n\n"
 119
 120       "An identifier has the following format:\n\n"
 121
 122       "  [<hostname>/]<plugin>[-<plugin_instance>]/<type>[-<type_instance>]\n\n"
 123
 124       "Hostname defaults to the local hostname if omitted (e.g., "
 125       "uptime/uptime).\n"
 126       "No error is returned if the specified identifier does not exist.\n"
 127
 128       "\n" PACKAGE_NAME " " PACKAGE_VERSION ", http://collectd.org/\n"
 129       "by Florian octo Forster <octo@collectd.org>\n"
 130       "for contributions see `AUTHORS'\n",
 131       name);
 132   exit(status);
 133 }
 134
 135 /* Count the number of occurrences of the character 'chr'
 136  * in the specified string. */
 137 static int count_chars(const char *str, char chr) {
 138   int count = 0;
 139
 140   while (*str != '\0') {
 141     if (*str == chr) {
 142       count++;
 143     }
 144     str++;
 145   }
 146
 147   return count;
 148 } /* count_chars */
 149
 150 static int array_grow(void **array, size_t *array_len, size_t elem_size) {
 151   void *tmp;
 152
 153   assert((array != NULL) && (array_len != NULL));
 154
 155   tmp = realloc(*array, (*array_len + 1) * elem_size);
 156   if (tmp == NULL) {
 157     fprintf(stderr, "ERROR: Failed to allocate memory.\n");
 158     return -1;
 159   }
 160
 161   *array = tmp;
 162   ++(*array_len);
 163   return 0;
 164 } /* array_grow */
 165
 166 static int parse_identifier(lcc_connection_t *c, const char *value,
 167                             lcc_identifier_t *ident) {
 168   char hostname[1024];
 169   char ident_str[1024] = "";
 170   int n_slashes;
 171
 172   int status;
 173
 174   n_slashes = count_chars(value, '/');
 175   if (n_slashes == 1) {
 176     /* The user has omitted the hostname part of the identifier
 177      * (there is only one '/' in the identifier)
 178      * Let's add the local hostname */
 179     if (gethostname(hostname, sizeof(hostname)) != 0) {
 180       fprintf(stderr, "ERROR: Failed to get local hostname: %s",
 181               strerror(errno));
 182       return -1;
 183     }
 184     hostname[sizeof(hostname) - 1] = '\0';
 185
 186     _ssnprintf(ident_str, sizeof(ident_str), "%s/%s", hostname, value);
 187     ident_str[sizeof(ident_str) - 1] = '\0';
 188   } else {
 189     strncpy(ident_str, value, sizeof(ident_str));
 190     ident_str[sizeof(ident_str) - 1] = '\0';
 191   }
 192
 193   status = lcc_string_to_identifier(c, ident, ident_str);
 194   if (status != 0) {
 195     fprintf(stderr, "ERROR: Failed to parse identifier ``%s'': %s.\n",
 196             ident_str, lcc_strerror(c));
 197     return -1;
 198   }
 199   return 0;
 200 } /* parse_identifier */
 201
 202 static int getval(lcc_connection_t *c, int argc, char **argv) {
 203   lcc_identifier_t ident;
 204
 205   size_t ret_values_num = 0;
 206   gauge_t *ret_values = NULL;
 207   char **ret_values_names = NULL;
 208
 209   int status;
 210
 211   assert(strcasecmp(argv[0], "getval") == 0);
 212
 213   if (argc != 2) {
 214     fprintf(stderr, "ERROR: getval: Missing identifier.\n");
 215     return -1;
 216   }
 217
 218   status = parse_identifier(c, argv[1], &ident);
 219   if (status != 0)
 220     return status;
 221
 222 #define BAIL_OUT(s)                                                            \
 223   do {                                                                         \
 224     if (ret_values != NULL)                                                    \
 225       free(ret_values);                                                        \
 226     if (ret_values_names != NULL) {                                            \
 227       for (size_t i = 0; i < ret_values_num; ++i)                              \
 228         free(ret_values_names[i]);                                             \
 229       free(ret_values_names);                                                  \
 230     }                                                                          \
 231     ret_values_num = 0;                                                        \
 232     return s;                                                                  \
 233   } while (0)
 234
 235   status =
 236       lcc_getval(c, &ident, &ret_values_num, &ret_values, &ret_values_names);
 237   if (status != 0) {
 238     fprintf(stderr, "ERROR: %s\n", lcc_strerror(c));
 239     BAIL_OUT(-1);
 240   }
 241
 242   for (size_t i = 0; i < ret_values_num; ++i)
 243     printf("%s=%e\n", ret_values_names[i], ret_values[i]);
 244   BAIL_OUT(0);
 245 #undef BAIL_OUT
 246 } /* getval */
 247
 248 static int flush(lcc_connection_t *c, int argc, char **argv) {
 249   int timeout = -1;
 250
 251   lcc_identifier_t *identifiers = NULL;
 252   size_t identifiers_num = 0;
 253
 254   char **plugins = NULL;
 255   size_t plugins_num = 0;
 256
 257   int status;
 258
 259   assert(strcasecmp(argv[0], "flush") == 0);
 260
 261 #define BAIL_OUT(s)                                                            \
 262   do {                                                                         \
 263     if (identifiers != NULL)                                                   \
 264       free(identifiers);                                                       \
 265     identifiers_num = 0;                                                       \
 266     if (plugins != NULL)                                                       \
 267       free(plugins);                                                           \
 268     plugins_num = 0;                                                           \
 269     return s;                                                                  \
 270   } while (0)
 271
 272   for (int i = 1; i < argc; ++i) {
 273     char *key, *value;
 274
 275     key = argv[i];
 276     value = strchr(argv[i], (int)'=');
 277
 278     if (!value) {
 279       fprintf(stderr, "ERROR: flush: Invalid option ``%s''.\n", argv[i]);
 280       BAIL_OUT(-1);
 281     }
 282
 283     *value = '\0';
 284     ++value;
 285
 286     if (strcasecmp(key, "timeout") == 0) {
 287       char *endptr = NULL;
 288
 289       timeout = (int)strtol(value, &endptr, 0);
 290
 291       if (endptr == value) {
 292         fprintf(stderr, "ERROR: Failed to parse timeout as number: %s.\n",
 293                 value);
 294         BAIL_OUT(-1);
 295       } else if ((endptr != NULL) && (*endptr != '\0')) {
 296         fprintf(stderr, "WARNING: Ignoring trailing garbage after timeout: "
 297                         "%s.\n",
 298                 endptr);
 299       }
 300     } else if (strcasecmp(key, "plugin") == 0) {
 301       status = array_grow((void *)&plugins, &plugins_num, sizeof(*plugins));
 302       if (status != 0)
 303         BAIL_OUT(status);
 304
 305       plugins[plugins_num - 1] = value;
 306     } else if (strcasecmp(key, "identifier") == 0) {
 307       status = array_grow((void *)&identifiers, &identifiers_num,
 308                           sizeof(*identifiers));
 309       if (status != 0)
 310         BAIL_OUT(status);
 311
 312       memset(identifiers + (identifiers_num - 1), 0, sizeof(*identifiers));
 313       status = parse_identifier(c, value, identifiers + (identifiers_num - 1));
 314       if (status != 0)
 315         BAIL_OUT(status);
 316     } else {
 317       fprintf(stderr, "ERROR: flush: Unknown option `%s'.\n", key);
 318       BAIL_OUT(-1);
 319     }
 320   }
 321
 322   if (plugins_num == 0) {
 323     status = array_grow((void *)&plugins, &plugins_num, sizeof(*plugins));
 324     if (status != 0)
 325       BAIL_OUT(status);
 326
 327     assert(plugins_num == 1);
 328     plugins[0] = NULL;
 329   }
 330
 331   for (size_t i = 0; i < plugins_num; ++i) {
 332     if (identifiers_num == 0) {
 333       status = lcc_flush(c, plugins[i], NULL, timeout);
 334       if (status != 0)
 335         fprintf(stderr, "ERROR: Failed to flush plugin `%s': %s.\n",
 336                 (plugins[i] == NULL) ? "(all)" : plugins[i], lcc_strerror(c));
 337     } else {
 338       for (size_t j = 0; j < identifiers_num; ++j) {
 339         status = lcc_flush(c, plugins[i], identifiers + j, timeout);
 340         if (status != 0) {
 341           char id[1024];
 342
 343           lcc_identifier_to_string(c, id, sizeof(id), identifiers + j);
 344           fprintf(stderr, "ERROR: Failed to flush plugin `%s', "
 345                           "identifier `%s': %s.\n",
 346                   (plugins[i] == NULL) ? "(all)" : plugins[i], id,
 347                   lcc_strerror(c));
 348         }
 349       }
 350     }
 351   }
 352
 353   BAIL_OUT(0);
 354 #undef BAIL_OUT
 355 } /* flush */
 356
 357 static int listval(lcc_connection_t *c, int argc, char **argv) {
 358   lcc_identifier_t *ret_ident = NULL;
 359   size_t ret_ident_num = 0;
 360
 361   int status;
 362
 363   assert(strcasecmp(argv[0], "listval") == 0);
 364
 365   if (argc != 1) {
 366     fprintf(stderr, "ERROR: listval: Does not accept any arguments.\n");
 367     return -1;
 368   }
 369
 370 #define BAIL_OUT(s)                                                            \
 371   do {                                                                         \
 372     if (ret_ident != NULL)                                                     \
 373       free(ret_ident);                                                         \
 374     ret_ident_num = 0;                                                         \
 375     return s;                                                                  \
 376   } while (0)
 377
 378   status = lcc_listval(c, &ret_ident, &ret_ident_num);
 379   if (status != 0) {
 380     fprintf(stderr, "ERROR: %s\n", lcc_strerror(c));
 381     BAIL_OUT(status);
 382   }
 383
 384   for (size_t i = 0; i < ret_ident_num; ++i) {
 385     char id[1024];
 386
 387     status = lcc_identifier_to_string(c, id, sizeof(id), ret_ident + i);
 388     if (status != 0) {
 389       fprintf(stderr, "ERROR: listval: Failed to convert returned "
 390                       "identifier to a string: %s\n",
 391               lcc_strerror(c));
 392       continue;
 393     }
 394
 395     printf("%s\n", id);
 396   }
 397   BAIL_OUT(0);
 398 #undef BAIL_OUT
 399 } /* listval */
 400
 401 static int putval(lcc_connection_t *c, int argc, char **argv) {
 402   lcc_value_list_t vl = LCC_VALUE_LIST_INIT;
 403
 404   /* 64 ought to be enough for anybody ;-) */
 405   value_t values[64];
 406   int values_types[64];
 407   size_t values_len = 0;
 408
 409   int status;
 410
 411   assert(strcasecmp(argv[0], "putval") == 0);
 412
 413   if (argc < 3) {
 414     fprintf(stderr, "ERROR: putval: Missing identifier "
 415                     "and/or value list.\n");
 416     return -1;
 417   }
 418
 419   vl.values = values;
 420   vl.values_types = values_types;
 421
 422   status = parse_identifier(c, argv[1], &vl.identifier);
 423   if (status != 0)
 424     return status;
 425
 426   for (int i = 2; i < argc; ++i) {
 427     char *tmp;
 428
 429     tmp = strchr(argv[i], (int)'=');
 430
 431     if (tmp != NULL) { /* option */
 432       char *key = argv[i];
 433       char *value = tmp;
 434
 435       *value = '\0';
 436       ++value;
 437
 438       if (strcasecmp(key, "interval") == 0) {
 439         char *endptr;
 440
 441         vl.interval = strtol(value, &endptr, 0);
 442
 443         if (endptr == value) {
 444           fprintf(stderr, "ERROR: Failed to parse interval as number: %s.\n",
 445                   value);
 446           return -1;
 447         } else if ((endptr != NULL) && (*endptr != '\0')) {
 448           fprintf(stderr, "WARNING: Ignoring trailing garbage after "
 449                           "interval: %s.\n",
 450                   endptr);
 451         }
 452       } else {
 453         fprintf(stderr, "ERROR: putval: Unknown option `%s'.\n", key);
 454         return -1;
 455       }
 456     } else { /* value list */
 457       char *value;
 458
 459       tmp = strchr(argv[i], (int)':');
 460
 461       if (tmp == NULL) {
 462         fprintf(stderr, "ERROR: putval: Invalid value list: %s.\n", argv[i]);
 463         return -1;
 464       }
 465
 466       *tmp = '\0';
 467       ++tmp;
 468
 469       if (strcasecmp(argv[i], "N") == 0) {
 470         vl.time = 0;
 471       } else {
 472         char *endptr;
 473
 474         vl.time = strtol(argv[i], &endptr, 0);
 475
 476         if (endptr == argv[i]) {
 477           fprintf(stderr, "ERROR: Failed to parse time as number: %s.\n",
 478                   argv[i]);
 479           return -1;
 480         } else if ((endptr != NULL) && (*endptr != '\0')) {
 481           fprintf(stderr, "ERROR: Garbage after time: %s.\n", endptr);
 482           return -1;
 483         }
 484       }
 485
 486       values_len = 0;
 487       value = tmp;
 488       while (value != NULL) {
 489         char *dot, *endptr;
 490
 491         tmp = strchr(value, (int)':');
 492
 493         if (tmp != NULL) {
 494           *tmp = '\0';
 495           ++tmp;
 496         }
 497
 498         /* This is a bit of a hack, but parsing types.db just does not make
 499          * much sense imho -- the server might have different types defined
 500          * anyway. Also, lcc uses the type information for formatting the
 501          * number only, so the real meaning does not matter. -tokkee */
 502         dot = strchr(value, (int)'.');
 503         endptr = NULL;
 504         if (strcasecmp(value, "U") == 0) {
 505           values[values_len].gauge = NAN;
 506           values_types[values_len] = LCC_TYPE_GAUGE;
 507         } else if (dot) { /* floating point value */
 508           values[values_len].gauge = strtod(value, &endptr);
 509           values_types[values_len] = LCC_TYPE_GAUGE;
 510         } else { /* integer */
 511           values[values_len].counter = (counter_t)strtoull(value, &endptr, 0);
 512           values_types[values_len] = LCC_TYPE_COUNTER;
 513         }
 514         ++values_len;
 515
 516         if (endptr == value) {
 517           fprintf(stderr, "ERROR: Failed to parse value as number: %s.\n",
 518                   argv[i]);
 519           return -1;
 520         } else if ((endptr != NULL) && (*endptr != '\0')) {
 521           fprintf(stderr, "ERROR: Garbage after value: %s.\n", endptr);
 522           return -1;
 523         }
 524
 525         value = tmp;
 526       }
 527
 528       assert(values_len >= 1);
 529       vl.values_len = values_len;
 530
 531       status = lcc_putval(c, &vl);
 532       if (status != 0) {
 533         fprintf(stderr, "ERROR: %s\n", lcc_strerror(c));
 534         return -1;
 535       }
 536     }
 537   }
 538
 539   if (values_len == 0) {
 540     fprintf(stderr, "ERROR: putval: Missing value list(s).\n");
 541     return -1;
 542   }
 543   return 0;
 544 } /* putval */
 545
 546 int main(int argc, char **argv) {
 547   char address[1024] = "unix:" DEFAULT_SOCK;
 548
 549   lcc_connection_t *c;
 550
 551   int status;
 552
 553   while (42) {
 554     int opt;
 555
 556     opt = getopt(argc, argv, "s:h");
 557
 558     if (opt == -1)
 559       break;
 560
 561     switch (opt) {
 562     case 's':
 563       _ssnprintf(address, sizeof(address), "unix:%s", optarg);
 564       address[sizeof(address) - 1] = '\0';
 565       break;
 566     case 'h':
 567       exit_usage(argv[0], 0);
 568     default:
 569       exit_usage(argv[0], 1);
 570     }
 571   }
 572
 573   if (optind >= argc) {
 574     fprintf(stderr, "%s: missing command\n", argv[0]);
 575     exit_usage(argv[0], 1);
 576   }
 577
 578   c = NULL;
 579   status = lcc_connect(address, &c);
 580   if (status != 0) {
 581     fprintf(stderr, "ERROR: Failed to connect to daemon at %s: %s.\n", address,
 582             strerror(errno));
 583     return 1;
 584   }
 585
 586   if (strcasecmp(argv[optind], "getval") == 0)
 587     status = getval(c, argc - optind, argv + optind);
 588   else if (strcasecmp(argv[optind], "flush") == 0)
 589     status = flush(c, argc - optind, argv + optind);
 590   else if (strcasecmp(argv[optind], "listval") == 0)
 591     status = listval(c, argc - optind, argv + optind);
 592   else if (strcasecmp(argv[optind], "putval") == 0)
 593     status = putval(c, argc - optind, argv + optind);
 594   else {
 595     fprintf(stderr, "%s: invalid command: %s\n", argv[0], argv[optind]);
 596     return 1;
 597   }
 598
 599   LCC_DESTROY(c);
 600
 601   if (status != 0)
 602     return status;
 603   return 0;
 604 } /* main */