src/plugins_d.c

   1 #include "common.h"
   2
   3 struct plugind *pluginsd_root = NULL;
   4
   5 #define MAX_WORDS 20
   6
   7 static inline int pluginsd_space(char c) {
   8     switch(c) {
   9     case ' ':
  10     case '\t':
  11     case '\r':
  12     case '\n':
  13     case '=':
  14         return 1;
  15
  16     default:
  17         return 0;
  18     }
  19 }
  20
  21 static int pluginsd_split_words(char *str, char **words, int max_words) {
  22     char *s = str, quote = 0;
  23     int i = 0, j;
  24
  25     // skip all white space
  26     while(unlikely(pluginsd_space(*s))) s++;
  27
  28     // check for quote
  29     if(unlikely(*s == '\'' || *s == '"')) {
  30         quote = *s; // remember the quote
  31         s++;        // skip the quote
  32     }
  33
  34     // store the first word
  35     words[i++] = s;
  36
  37     // while we have something
  38     while(likely(*s)) {
  39         // if it is escape
  40         if(unlikely(*s == '\\' && s[1])) {
  41             s += 2;
  42             continue;
  43         }
  44
  45         // if it is quote
  46         else if(unlikely(*s == quote)) {
  47             quote = 0;
  48             *s = ' ';
  49             continue;
  50         }
  51
  52         // if it is a space
  53         else if(unlikely(quote == 0 && pluginsd_space(*s))) {
  54
  55             // terminate the word
  56             *s++ = '\0';
  57
  58             // skip all white space
  59             while(likely(pluginsd_space(*s))) s++;
  60
  61             // check for quote
  62             if(unlikely(*s == '\'' || *s == '"')) {
  63                 quote = *s; // remember the quote
  64                 s++;        // skip the quote
  65             }
  66
  67             // if we reached the end, stop
  68             if(unlikely(!*s)) break;
  69
  70             // store the next word
  71             if(likely(i < max_words)) words[i++] = s;
  72             else break;
  73         }
  74
  75         // anything else
  76         else s++;
  77     }
  78
  79     // terminate the words
  80     j = i;
  81     while(likely(j < max_words)) words[j++] = NULL;
  82
  83     return i;
  84 }
  85
  86
  87 void *pluginsd_worker_thread(void *arg)
  88 {
  89     struct plugind *cd = (struct plugind *)arg;
  90     char line[PLUGINSD_LINE_MAX + 1];
  91
  92 #ifdef DETACH_PLUGINS_FROM_NETDATA
  93     unsigned long long usec = 0, susec = 0;
  94     struct timeval last = {0, 0} , now = {0, 0};
  95 #endif
  96
  97     char *words[MAX_WORDS] = { NULL };
  98     uint32_t SET_HASH = simple_hash("SET");
  99     uint32_t BEGIN_HASH = simple_hash("BEGIN");
 100     uint32_t END_HASH = simple_hash("END");
 101     uint32_t FLUSH_HASH = simple_hash("FLUSH");
 102     uint32_t CHART_HASH = simple_hash("CHART");
 103     uint32_t DIMENSION_HASH = simple_hash("DIMENSION");
 104     uint32_t DISABLE_HASH = simple_hash("DISABLE");
 105 #ifdef DETACH_PLUGINS_FROM_NETDATA
 106     uint32_t MYPID_HASH = simple_hash("MYPID");
 107     uint32_t STOPPING_WAKE_ME_UP_PLEASE_HASH = simple_hash("STOPPING_WAKE_ME_UP_PLEASE");
 108 #endif
 109
 110     size_t count = 0;
 111
 112     for(;;) {
 113         if(unlikely(netdata_exit)) break;
 114
 115         FILE *fp = mypopen(cd->cmd, &cd->pid);
 116         if(unlikely(!fp)) {
 117             error("Cannot popen(\"%s\", \"r\").", cd->cmd);
 118             break;
 119         }
 120
 121         info("PLUGINSD: '%s' running on pid %d", cd->fullfilename, cd->pid);
 122
 123         RRDSET *st = NULL;
 124         uint32_t hash;
 125
 126         while(likely(fgets(line, PLUGINSD_LINE_MAX, fp) != NULL)) {
 127             if(unlikely(netdata_exit)) break;
 128
 129             line[PLUGINSD_LINE_MAX] = '\0';
 130
 131             // debug(D_PLUGINSD, "PLUGINSD: %s: %s", cd->filename, line);
 132
 133             int w = pluginsd_split_words(line, words, MAX_WORDS);
 134             char *s = words[0];
 135             if(unlikely(!s || !*s || !w)) {
 136                 // debug(D_PLUGINSD, "PLUGINSD: empty line");
 137                 continue;
 138             }
 139
 140             // debug(D_PLUGINSD, "PLUGINSD: words 0='%s' 1='%s' 2='%s' 3='%s' 4='%s' 5='%s' 6='%s' 7='%s' 8='%s' 9='%s'", words[0], words[1], words[2], words[3], words[4], words[5], words[6], words[7], words[8], words[9]);
 141
 142             hash = simple_hash(s);
 143
 144             if(likely(hash == SET_HASH && !strcmp(s, "SET"))) {
 145                 char *dimension = words[1];
 146                 char *value = words[2];
 147
 148                 if(unlikely(!dimension || !*dimension)) {
 149                     error("PLUGINSD: '%s' is requesting a SET on chart '%s', without a dimension. Disabling it.", cd->fullfilename, st->id);
 150                     cd->enabled = 0;
 151                     killpid(cd->pid, SIGTERM);
 152                     break;
 153                 }
 154
 155                 if(unlikely(!value || !*value)) value = NULL;
 156
 157                 if(unlikely(!st)) {
 158                     error("PLUGINSD: '%s' is requesting a SET on dimension %s with value %s, without a BEGIN. Disabling it.", cd->fullfilename, dimension, value?value:"<nothing>");
 159                     cd->enabled = 0;
 160                     killpid(cd->pid, SIGTERM);
 161                     break;
 162                 }
 163
 164                 if(unlikely(st->debug)) debug(D_PLUGINSD, "PLUGINSD: '%s' is setting dimension %s/%s to %s", cd->fullfilename, st->id, dimension, value?value:"<nothing>");
 165
 166                 if(value) rrddim_set(st, dimension, strtoll(value, NULL, 0));
 167             }
 168             else if(likely(hash == BEGIN_HASH && !strcmp(s, "BEGIN"))) {
 169                 char *id = words[1];
 170                 char *microseconds_txt = words[2];
 171
 172                 if(unlikely(!id)) {
 173                     error("PLUGINSD: '%s' is requesting a BEGIN without a chart id. Disabling it.", cd->fullfilename);
 174                     cd->enabled = 0;
 175                     killpid(cd->pid, SIGTERM);
 176                     break;
 177                 }
 178
 179                 st = rrdset_find(id);
 180                 if(unlikely(!st)) {
 181                     error("PLUGINSD: '%s' is requesting a BEGIN on chart '%s', which does not exist. Disabling it.", cd->fullfilename, id);
 182                     cd->enabled = 0;
 183                     killpid(cd->pid, SIGTERM);
 184                     break;
 185                 }
 186
 187                 if(likely(st->counter_done)) {
 188                     unsigned long long microseconds = 0;
 189                     if(microseconds_txt && *microseconds_txt) microseconds = strtoull(microseconds_txt, NULL, 10);
 190                     if(microseconds) rrdset_next_usec(st, microseconds);
 191                     else rrdset_next(st);
 192                 }
 193             }
 194             else if(likely(hash == END_HASH && !strcmp(s, "END"))) {
 195                 if(unlikely(!st)) {
 196                     error("PLUGINSD: '%s' is requesting an END, without a BEGIN. Disabling it.", cd->fullfilename);
 197                     cd->enabled = 0;
 198                     killpid(cd->pid, SIGTERM);
 199                     break;
 200                 }
 201
 202                 if(unlikely(st->debug)) debug(D_PLUGINSD, "PLUGINSD: '%s' is requesting an END on chart %s", cd->fullfilename, st->id);
 203
 204                 rrdset_done(st);
 205                 st = NULL;
 206
 207                 count++;
 208             }
 209             else if(likely(hash == FLUSH_HASH && !strcmp(s, "FLUSH"))) {
 210                 debug(D_PLUGINSD, "PLUGINSD: '%s' is requesting a FLUSH", cd->fullfilename);
 211                 st = NULL;
 212             }
 213             else if(likely(hash == CHART_HASH && !strcmp(s, "CHART"))) {
 214                 int noname = 0;
 215                 st = NULL;
 216
 217                 if((words[1]) != NULL && (words[2]) != NULL && strcmp(words[1], words[2]) == 0)
 218                     noname = 1;
 219
 220                 char *type = words[1];
 221                 char *id = NULL;
 222                 if(likely(type)) {
 223                     id = strchr(type, '.');
 224                     if(likely(id)) { *id = '\0'; id++; }
 225                 }
 226                 char *name = words[2];
 227                 char *title = words[3];
 228                 char *units = words[4];
 229                 char *family = words[5];
 230                 char *context = words[6];
 231                 char *chart = words[7];
 232                 char *priority_s = words[8];
 233                 char *update_every_s = words[9];
 234
 235                 if(unlikely(!type || !*type || !id || !*id)) {
 236                     error("PLUGINSD: '%s' is requesting a CHART, without a type.id. Disabling it.", cd->fullfilename);
 237                     cd->enabled = 0;
 238                     killpid(cd->pid, SIGTERM);
 239                     break;
 240                 }
 241
 242                 int priority = 1000;
 243                 if(likely(priority_s)) priority = atoi(priority_s);
 244
 245                 int update_every = cd->update_every;
 246                 if(likely(update_every_s)) update_every = atoi(update_every_s);
 247                 if(unlikely(!update_every)) update_every = cd->update_every;
 248
 249                 int chart_type = RRDSET_TYPE_LINE;
 250                 if(unlikely(chart)) chart_type = rrdset_type_id(chart);
 251
 252                 if(unlikely(noname || !name || !*name || strcasecmp(name, "NULL") == 0 || strcasecmp(name, "(NULL)") == 0)) name = NULL;
 253                 if(unlikely(!family || !*family)) family = NULL;
 254                 if(unlikely(!context || !*context)) context = NULL;
 255
 256                 st = rrdset_find_bytype(type, id);
 257                 if(unlikely(!st)) {
 258                     debug(D_PLUGINSD, "PLUGINSD: Creating chart type='%s', id='%s', name='%s', family='%s', context='%s', chart='%s', priority=%d, update_every=%d"
 259                         , type, id
 260                         , name?name:""
 261                         , family?family:""
 262                         , context?context:""
 263                         , rrdset_type_name(chart_type)
 264                         , priority
 265                         , update_every
 266                         );
 267
 268                     st = rrdset_create(type, id, name, family, context, title, units, priority, update_every, chart_type);
 269                     cd->update_every = update_every;
 270                 }
 271                 else debug(D_PLUGINSD, "PLUGINSD: Chart '%s' already exists. Not adding it again.", st->id);
 272             }
 273             else if(likely(hash == DIMENSION_HASH && !strcmp(s, "DIMENSION"))) {
 274                 char *id = words[1];
 275                 char *name = words[2];
 276                 char *algorithm = words[3];
 277                 char *multiplier_s = words[4];
 278                 char *divisor_s = words[5];
 279                 char *options = words[6];
 280
 281                 if(unlikely(!id || !*id)) {
 282                     error("PLUGINSD: '%s' is requesting a DIMENSION, without an id. Disabling it.", cd->fullfilename);
 283                     cd->enabled = 0;
 284                     killpid(cd->pid, SIGTERM);
 285                     break;
 286                 }
 287
 288                 if(unlikely(!st)) {
 289                     error("PLUGINSD: '%s' is requesting a DIMENSION, without a CHART. Disabling it.", cd->fullfilename);
 290                     cd->enabled = 0;
 291                     killpid(cd->pid, SIGTERM);
 292                     break;
 293                 }
 294
 295                 long multiplier = 1;
 296                 if(multiplier_s && *multiplier_s) multiplier = strtol(multiplier_s, NULL, 0);
 297                 if(unlikely(!multiplier)) multiplier = 1;
 298
 299                 long divisor = 1;
 300                 if(likely(divisor_s && *divisor_s)) divisor = strtol(divisor_s, NULL, 0);
 301                 if(unlikely(!divisor)) divisor = 1;
 302
 303                 if(unlikely(!algorithm || !*algorithm)) algorithm = "absolute";
 304
 305                 if(unlikely(st->debug)) debug(D_PLUGINSD, "PLUGINSD: Creating dimension in chart %s, id='%s', name='%s', algorithm='%s', multiplier=%ld, divisor=%ld, hidden='%s'"
 306                     , st->id
 307                     , id
 308                     , name?name:""
 309                     , rrddim_algorithm_name(rrddim_algorithm_id(algorithm))
 310                     , multiplier
 311                     , divisor
 312                     , options?options:""
 313                     );
 314
 315                 RRDDIM *rd = rrddim_find(st, id);
 316                 if(unlikely(!rd)) {
 317                     rd = rrddim_add(st, id, name, multiplier, divisor, rrddim_algorithm_id(algorithm));
 318                     rd->flags = 0x00000000;
 319                     if(options && *options) {
 320                         if(strstr(options, "hidden") != NULL) rd->flags |= RRDDIM_FLAG_HIDDEN;
 321                         if(strstr(options, "noreset") != NULL) rd->flags |= RRDDIM_FLAG_DONT_DETECT_RESETS_OR_OVERFLOWS;
 322                         if(strstr(options, "nooverflow") != NULL) rd->flags |= RRDDIM_FLAG_DONT_DETECT_RESETS_OR_OVERFLOWS;
 323                     }
 324                 }
 325                 else if(unlikely(st->debug)) debug(D_PLUGINSD, "PLUGINSD: dimension %s/%s already exists. Not adding it again.", st->id, id);
 326             }
 327             else if(unlikely(hash == DISABLE_HASH && !strcmp(s, "DISABLE"))) {
 328                 error("PLUGINSD: '%s' called DISABLE. Disabling it.", cd->fullfilename);
 329                 cd->enabled = 0;
 330                 killpid(cd->pid, SIGTERM);
 331                 break;
 332             }
 333 #ifdef DETACH_PLUGINS_FROM_NETDATA
 334             else if(likely(hash == MYPID_HASH && !strcmp(s, "MYPID"))) {
 335                 char *pid_s = words[1];
 336                 pid_t pid = strtod(pid_s, NULL, 0);
 337
 338                 if(likely(pid)) cd->pid = pid;
 339                 debug(D_PLUGINSD, "PLUGINSD: %s is on pid %d", cd->id, cd->pid);
 340             }
 341             else if(likely(hash == STOPPING_WAKE_ME_UP_PLEASE_HASH && !strcmp(s, "STOPPING_WAKE_ME_UP_PLEASE"))) {
 342                 error("PLUGINSD: '%s' (pid %d) called STOPPING_WAKE_ME_UP_PLEASE.", cd->fullfilename, cd->pid);
 343
 344                 gettimeofday(&now, NULL);
 345                 if(unlikely(!usec && !susec)) {
 346                     // our first run
 347                     susec = cd->rrd_update_every * 1000000ULL;
 348                 }
 349                 else {
 350                     // second+ run
 351                     usec = usec_dt(&now, &last) - susec;
 352                     error("PLUGINSD: %s last loop took %llu usec (worked for %llu, sleeped for %llu).\n", cd->fullfilename, usec + susec, usec, susec);
 353                     if(unlikely(usec < (rrd_update_every * 1000000ULL / 2ULL))) susec = (rrd_update_every * 1000000ULL) - usec;
 354                     else susec = rrd_update_every * 1000000ULL / 2ULL;
 355                 }
 356
 357                 error("PLUGINSD: %s sleeping for %llu. Will kill with SIGCONT pid %d to wake it up.\n", cd->fullfilename, susec, cd->pid);
 358                 usleep(susec);
 359                 killpid(cd->pid, SIGCONT);
 360                 memmove(&last, &now, sizeof(struct timeval));
 361                 break;
 362             }
 363 #endif
 364             else {
 365                 error("PLUGINSD: '%s' is sending command '%s' which is not known by netdata. Disabling it.", cd->fullfilename, s);
 366                 cd->enabled = 0;
 367                 killpid(cd->pid, SIGTERM);
 368                 break;
 369             }
 370         }
 371         if(likely(count)) {
 372             cd->successful_collections += count;
 373             cd->serial_failures = 0;
 374         }
 375         else
 376             cd->serial_failures++;
 377
 378         info("PLUGINSD: '%s' on pid %d stopped after %zu successful data collections (ENDs).", cd->fullfilename, cd->pid, count);
 379
 380         // get the return code
 381         int code = mypclose(fp, cd->pid);
 382
 383         if(unlikely(netdata_exit)) break;
 384         else if(code != 0) {
 385             // the plugin reports failure
 386
 387             if(likely(!cd->successful_collections)) {
 388                 // nothing collected - disable it
 389                 error("PLUGINSD: '%s' exited with error code %d. Disabling it.", cd->fullfilename, code);
 390                 cd->enabled = 0;
 391             }
 392             else {
 393                 // we have collected something
 394
 395                 if(likely(cd->serial_failures <= 10)) {
 396                     error("PLUGINSD: '%s' exited with error code %d, but has given useful output in the past (%zu times). %s", cd->fullfilename, code, cd->successful_collections, cd->enabled?"Waiting a bit before starting it again.":"Will not start it again - it is disabled.");
 397                     sleep((unsigned int) (cd->update_every * 10));
 398                 }
 399                 else {
 400                     error("PLUGINSD: '%s' exited with error code %d, but has given useful output in the past (%zu times). We tried %zu times to restart it, but it failed to generate data. Disabling it.", cd->fullfilename, code, cd->successful_collections, cd->serial_failures);
 401                     cd->enabled = 0;
 402                 }
 403             }
 404         }
 405         else {
 406             // the plugin reports success
 407
 408             if(unlikely(!cd->successful_collections)) {
 409                 // we have collected nothing so far
 410
 411                 if(likely(cd->serial_failures <= 10)) {
 412                     error("PLUGINSD: '%s' (pid %d) does not generate useful output but it reports success (exits with 0). %s.", cd->fullfilename, cd->pid, cd->enabled?"Waiting a bit before starting it again.":"Will not start it again - it is disabled.");
 413                     sleep((unsigned int) (cd->update_every * 10));
 414                 }
 415                 else {
 416                     error("PLUGINSD: '%s' (pid %d) does not generate useful output, although it reports success (exits with 0), but we have tried %zu times to collect something. Disabling it.", cd->fullfilename, cd->pid, cd->serial_failures);
 417                     cd->enabled = 0;
 418                 }
 419             }
 420             else
 421                 sleep((unsigned int) cd->update_every);
 422         }
 423         cd->pid = 0;
 424
 425         if(unlikely(!cd->enabled)) break;
 426     }
 427
 428     info("PLUGINSD: '%s' thread exiting", cd->fullfilename);
 429
 430     cd->obsolete = 1;
 431     pthread_exit(NULL);
 432     return NULL;
 433 }
 434
 435 void *pluginsd_main(void *ptr) {
 436     (void)ptr;
 437
 438     info("PLUGINS.D thread created with task id %d", gettid());
 439
 440     if(pthread_setcanceltype(PTHREAD_CANCEL_DEFERRED, NULL) != 0)
 441         error("Cannot set pthread cancel type to DEFERRED.");
 442
 443     if(pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, NULL) != 0)
 444         error("Cannot set pthread cancel state to ENABLE.");
 445
 446     char *dir_name = config_get("plugins", "plugins directory", PLUGINS_DIR);
 447     int automatic_run = config_get_boolean("plugins", "enable running new plugins", 1);
 448     int scan_frequency = (int) config_get_number("plugins", "check for new plugins every", 60);
 449     DIR *dir = NULL;
 450     struct dirent *file = NULL;
 451     struct plugind *cd;
 452
 453     // enable the apps plugin by default
 454     // config_get_boolean("plugins", "apps", 1);
 455
 456     if(scan_frequency < 1) scan_frequency = 1;
 457
 458     for(;;) {
 459         if(unlikely(netdata_exit)) break;
 460
 461         dir = opendir(dir_name);
 462         if(unlikely(!dir)) {
 463             error("Cannot open directory '%s'.", dir_name);
 464             pthread_exit(NULL);
 465             return NULL;
 466         }
 467
 468         while(likely((file = readdir(dir)))) {
 469             if(unlikely(netdata_exit)) break;
 470
 471             debug(D_PLUGINSD, "PLUGINSD: Examining file '%s'", file->d_name);
 472
 473             if(unlikely(strcmp(file->d_name, ".") == 0 || strcmp(file->d_name, "..") == 0)) continue;
 474
 475             int len = (int) strlen(file->d_name);
 476             if(unlikely(len <= (int)PLUGINSD_FILE_SUFFIX_LEN)) continue;
 477             if(unlikely(strcmp(PLUGINSD_FILE_SUFFIX, &file->d_name[len - (int)PLUGINSD_FILE_SUFFIX_LEN]) != 0)) {
 478                 debug(D_PLUGINSD, "PLUGINSD: File '%s' does not end in '%s'.", file->d_name, PLUGINSD_FILE_SUFFIX);
 479                 continue;
 480             }
 481
 482             char pluginname[CONFIG_MAX_NAME + 1];
 483             snprintfz(pluginname, CONFIG_MAX_NAME, "%.*s", (int)(len - PLUGINSD_FILE_SUFFIX_LEN), file->d_name);
 484             int enabled = config_get_boolean("plugins", pluginname, automatic_run);
 485
 486             if(unlikely(!enabled)) {
 487                 debug(D_PLUGINSD, "PLUGINSD: plugin '%s' is not enabled", file->d_name);
 488                 continue;
 489             }
 490
 491             // check if it runs already
 492             for(cd = pluginsd_root ; likely(cd) ; cd = cd->next) {
 493                 if(unlikely(strcmp(cd->filename, file->d_name) == 0)) break;
 494             }
 495             if(likely(cd && !cd->obsolete)) {
 496                 debug(D_PLUGINSD, "PLUGINSD: plugin '%s' is already running", cd->filename);
 497                 continue;
 498             }
 499
 500             // it is not running
 501             // allocate a new one, or use the obsolete one
 502             if(unlikely(!cd)) {
 503                 cd = callocz(sizeof(struct plugind), 1);
 504
 505                 snprintfz(cd->id, CONFIG_MAX_NAME, "plugin:%s", pluginname);
 506
 507                 strncpyz(cd->filename, file->d_name, FILENAME_MAX);
 508                 snprintfz(cd->fullfilename, FILENAME_MAX, "%s/%s", dir_name, cd->filename);
 509
 510                 cd->enabled = enabled;
 511                 cd->update_every = (int) config_get_number(cd->id, "update every", rrd_update_every);
 512                 cd->started_t = time(NULL);
 513
 514                 char *def = "";
 515                 snprintfz(cd->cmd, PLUGINSD_CMD_MAX, "exec %s %d %s", cd->fullfilename, cd->update_every, config_get(cd->id, "command options", def));
 516
 517                 // link it
 518                 if(likely(pluginsd_root)) cd->next = pluginsd_root;
 519                 pluginsd_root = cd;
 520             }
 521             cd->obsolete = 0;
 522
 523             if(unlikely(!cd->enabled)) continue;
 524
 525             // spawn a new thread for it
 526             if(unlikely(pthread_create(&cd->thread, NULL, pluginsd_worker_thread, cd) != 0)) {
 527                 error("PLUGINSD: failed to create new thread for plugin '%s'.", cd->filename);
 528                 cd->obsolete = 1;
 529             }
 530             else if(unlikely(pthread_detach(cd->thread) != 0))
 531                 error("PLUGINSD: Cannot request detach of newly created thread for plugin '%s'.", cd->filename);
 532         }
 533
 534         closedir(dir);
 535         sleep((unsigned int) scan_frequency);
 536     }
 537
 538     info("PLUGINS.D thread exiting");
 539
 540     pthread_exit(NULL);
 541     return NULL;
 542 }