]> arthur.barton.de Git - netdata.git/blob - src/plugins_d.c
external plugins can now work for a specific host
[netdata.git] / 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     struct plugind *cd = (struct plugind *)arg;
89     cd->obsolete = 0;
90
91     char line[PLUGINSD_LINE_MAX + 1];
92
93 #ifdef DETACH_PLUGINS_FROM_NETDATA
94     usec_t usec = 0, susec = 0;
95     struct timeval last = {0, 0} , now = {0, 0};
96 #endif
97
98     char *words[MAX_WORDS] = { NULL };
99     uint32_t HOST_HASH = simple_hash("HOST");
100     uint32_t BEGIN_HASH = simple_hash("BEGIN");
101     uint32_t END_HASH = simple_hash("END");
102     uint32_t FLUSH_HASH = simple_hash("FLUSH");
103     uint32_t CHART_HASH = simple_hash("CHART");
104     uint32_t DIMENSION_HASH = simple_hash("DIMENSION");
105     uint32_t DISABLE_HASH = simple_hash("DISABLE");
106 #ifdef DETACH_PLUGINS_FROM_NETDATA
107     uint32_t MYPID_HASH = simple_hash("MYPID");
108     uint32_t STOPPING_WAKE_ME_UP_PLEASE_HASH = simple_hash("STOPPING_WAKE_ME_UP_PLEASE");
109 #endif
110
111     size_t count = 0;
112     RRDHOST *host = localhost;
113
114     for(;;) {
115         if(unlikely(netdata_exit)) break;
116
117         FILE *fp = mypopen(cd->cmd, &cd->pid);
118         if(unlikely(!fp)) {
119             error("Cannot popen(\"%s\", \"r\").", cd->cmd);
120             break;
121         }
122
123         info("PLUGINSD: '%s' running on pid %d", cd->fullfilename, cd->pid);
124
125         RRDSET *st = NULL;
126         uint32_t hash;
127
128         while(likely(fgets(line, PLUGINSD_LINE_MAX, fp) != NULL)) {
129             if(unlikely(netdata_exit)) break;
130
131             line[PLUGINSD_LINE_MAX] = '\0';
132
133             // debug(D_PLUGINSD, "PLUGINSD: %s: %s", cd->filename, line);
134
135             int w = pluginsd_split_words(line, words, MAX_WORDS);
136             char *s = words[0];
137             if(unlikely(!s || !*s || !w)) {
138                 // debug(D_PLUGINSD, "PLUGINSD: empty line");
139                 continue;
140             }
141
142             // 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]);
143
144             if(likely(!simple_hash_strcmp(s, "SET", &hash))) {
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(host, 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                     usec_t microseconds = 0;
189                     if(microseconds_txt && *microseconds_txt) microseconds = str2ull(microseconds_txt);
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 == HOST_HASH && !strcmp(s, "HOST"))) {
210                 char *guid = words[1];
211                 char *hostname = words[2];
212
213                 if(unlikely(!guid || !*guid)) {
214                     error("PLUGINSD: '%s' is requesting a HOST, without a guid. Disabling it.", cd->fullfilename);
215                     cd->enabled = 0;
216                     killpid(cd->pid, SIGTERM);
217                     break;
218                 }
219                 if(unlikely(!hostname || !*hostname)) {
220                     error("PLUGINSD: '%s' is requesting a HOST, without a hostname. Disabling it.", cd->fullfilename);
221                     cd->enabled = 0;
222                     killpid(cd->pid, SIGTERM);
223                     break;
224                 }
225
226                 host = rrdhost_find_or_create(hostname, guid);
227             }
228             else if(likely(hash == FLUSH_HASH && !strcmp(s, "FLUSH"))) {
229                 debug(D_PLUGINSD, "PLUGINSD: '%s' is requesting a FLUSH", cd->fullfilename);
230                 st = NULL;
231             }
232             else if(likely(hash == CHART_HASH && !strcmp(s, "CHART"))) {
233                 int noname = 0;
234                 st = NULL;
235
236                 if((words[1]) != NULL && (words[2]) != NULL && strcmp(words[1], words[2]) == 0)
237                     noname = 1;
238
239                 char *type = words[1];
240                 char *id = NULL;
241                 if(likely(type)) {
242                     id = strchr(type, '.');
243                     if(likely(id)) { *id = '\0'; id++; }
244                 }
245                 char *name = words[2];
246                 char *title = words[3];
247                 char *units = words[4];
248                 char *family = words[5];
249                 char *context = words[6];
250                 char *chart = words[7];
251                 char *priority_s = words[8];
252                 char *update_every_s = words[9];
253
254                 if(unlikely(!type || !*type || !id || !*id)) {
255                     error("PLUGINSD: '%s' is requesting a CHART, without a type.id. Disabling it.", cd->fullfilename);
256                     cd->enabled = 0;
257                     killpid(cd->pid, SIGTERM);
258                     break;
259                 }
260
261                 int priority = 1000;
262                 if(likely(priority_s)) priority = str2i(priority_s);
263
264                 int update_every = cd->update_every;
265                 if(likely(update_every_s)) update_every = str2i(update_every_s);
266                 if(unlikely(!update_every)) update_every = cd->update_every;
267
268                 RRDSET_TYPE chart_type = RRDSET_TYPE_LINE;
269                 if(unlikely(chart)) chart_type = rrdset_type_id(chart);
270
271                 if(unlikely(noname || !name || !*name || strcasecmp(name, "NULL") == 0 || strcasecmp(name, "(NULL)") == 0)) name = NULL;
272                 if(unlikely(!family || !*family)) family = NULL;
273                 if(unlikely(!context || !*context)) context = NULL;
274
275                 st = rrdset_find_bytype(host, type, id);
276                 if(unlikely(!st)) {
277                     debug(D_PLUGINSD, "PLUGINSD: Creating chart type='%s', id='%s', name='%s', family='%s', context='%s', chart='%s', priority=%d, update_every=%d"
278                         , type, id
279                         , name?name:""
280                         , family?family:""
281                         , context?context:""
282                         , rrdset_type_name(chart_type)
283                         , priority
284                         , update_every
285                         );
286
287                     st = rrdset_create(type, id, name, family, context, title, units, priority, update_every, chart_type);
288                     cd->update_every = update_every;
289                 }
290                 else debug(D_PLUGINSD, "PLUGINSD: Chart '%s' already exists. Not adding it again.", st->id);
291             }
292             else if(likely(hash == DIMENSION_HASH && !strcmp(s, "DIMENSION"))) {
293                 char *id = words[1];
294                 char *name = words[2];
295                 char *algorithm = words[3];
296                 char *multiplier_s = words[4];
297                 char *divisor_s = words[5];
298                 char *options = words[6];
299
300                 if(unlikely(!id || !*id)) {
301                     error("PLUGINSD: '%s' is requesting a DIMENSION, without an id. Disabling it.", cd->fullfilename);
302                     cd->enabled = 0;
303                     killpid(cd->pid, SIGTERM);
304                     break;
305                 }
306
307                 if(unlikely(!st)) {
308                     error("PLUGINSD: '%s' is requesting a DIMENSION, without a CHART. Disabling it.", cd->fullfilename);
309                     cd->enabled = 0;
310                     killpid(cd->pid, SIGTERM);
311                     break;
312                 }
313
314                 long multiplier = 1;
315                 if(multiplier_s && *multiplier_s) multiplier = strtol(multiplier_s, NULL, 0);
316                 if(unlikely(!multiplier)) multiplier = 1;
317
318                 long divisor = 1;
319                 if(likely(divisor_s && *divisor_s)) divisor = strtol(divisor_s, NULL, 0);
320                 if(unlikely(!divisor)) divisor = 1;
321
322                 if(unlikely(!algorithm || !*algorithm)) algorithm = "absolute";
323
324                 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'"
325                     , st->id
326                     , id
327                     , name?name:""
328                     , rrd_algorithm_name(rrd_algorithm_id(algorithm))
329                     , multiplier
330                     , divisor
331                     , options?options:""
332                     );
333
334                 RRDDIM *rd = rrddim_find(st, id);
335                 if(unlikely(!rd)) {
336                     rd = rrddim_add(st, id, name, multiplier, divisor, rrd_algorithm_id(algorithm));
337                     rd->flags = 0x00000000;
338                     if(options && *options) {
339                         if(strstr(options, "hidden") != NULL) rrddim_flag_set(rd, RRDDIM_FLAG_HIDDEN);
340                         if(strstr(options, "noreset") != NULL) rrddim_flag_set(rd, RRDDIM_FLAG_DONT_DETECT_RESETS_OR_OVERFLOWS);
341                         if(strstr(options, "nooverflow") != NULL) rrddim_flag_set(rd, RRDDIM_FLAG_DONT_DETECT_RESETS_OR_OVERFLOWS);
342                     }
343                 }
344                 else if(unlikely(st->debug)) debug(D_PLUGINSD, "PLUGINSD: dimension %s/%s already exists. Not adding it again.", st->id, id);
345             }
346             else if(unlikely(hash == DISABLE_HASH && !strcmp(s, "DISABLE"))) {
347                 info("PLUGINSD: '%s' called DISABLE. Disabling it.", cd->fullfilename);
348                 cd->enabled = 0;
349                 killpid(cd->pid, SIGTERM);
350                 break;
351             }
352 #ifdef DETACH_PLUGINS_FROM_NETDATA
353             else if(likely(hash == MYPID_HASH && !strcmp(s, "MYPID"))) {
354                 char *pid_s = words[1];
355                 pid_t pid = strtod(pid_s, NULL, 0);
356
357                 if(likely(pid)) cd->pid = pid;
358                 debug(D_PLUGINSD, "PLUGINSD: %s is on pid %d", cd->id, cd->pid);
359             }
360             else if(likely(hash == STOPPING_WAKE_ME_UP_PLEASE_HASH && !strcmp(s, "STOPPING_WAKE_ME_UP_PLEASE"))) {
361                 error("PLUGINSD: '%s' (pid %d) called STOPPING_WAKE_ME_UP_PLEASE.", cd->fullfilename, cd->pid);
362
363                 now_realtime_timeval(&now);
364                 if(unlikely(!usec && !susec)) {
365                     // our first run
366                     susec = cd->rrd_update_every * USEC_PER_SEC;
367                 }
368                 else {
369                     // second+ run
370                     usec = dt_usec(&now, &last) - susec;
371                     error("PLUGINSD: %s last loop took %llu usec (worked for %llu, sleeped for %llu).\n", cd->fullfilename, usec + susec, usec, susec);
372                     if(unlikely(usec < (rrd_update_every * USEC_PER_SEC / 2ULL))) susec = (rrd_update_every * USEC_PER_SEC) - usec;
373                     else susec = rrd_update_every * USEC_PER_SEC / 2ULL;
374                 }
375
376                 error("PLUGINSD: %s sleeping for %llu. Will kill with SIGCONT pid %d to wake it up.\n", cd->fullfilename, susec, cd->pid);
377                 usleep(susec);
378                 killpid(cd->pid, SIGCONT);
379                 memmove(&last, &now, sizeof(struct timeval));
380                 break;
381             }
382 #endif
383             else {
384                 error("PLUGINSD: '%s' is sending command '%s' which is not known by netdata. Disabling it.", cd->fullfilename, s);
385                 cd->enabled = 0;
386                 killpid(cd->pid, SIGTERM);
387                 break;
388             }
389         }
390         if(likely(count)) {
391             cd->successful_collections += count;
392             cd->serial_failures = 0;
393         }
394         else
395             cd->serial_failures++;
396
397         info("PLUGINSD: '%s' on pid %d stopped after %zu successful data collections (ENDs).", cd->fullfilename, cd->pid, count);
398
399         // get the return code
400         int code = mypclose(fp, cd->pid);
401         
402         if(unlikely(netdata_exit)) break;
403         else if(code != 0) {
404             // the plugin reports failure
405
406             if(likely(!cd->successful_collections)) {
407                 // nothing collected - disable it
408                 error("PLUGINSD: '%s' exited with error code %d. Disabling it.", cd->fullfilename, code);
409                 cd->enabled = 0;
410             }
411             else {
412                 // we have collected something
413
414                 if(likely(cd->serial_failures <= 10)) {
415                     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.");
416                     sleep((unsigned int) (cd->update_every * 10));
417                 }
418                 else {
419                     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);
420                     cd->enabled = 0;
421                 }
422             }
423         }
424         else {
425             // the plugin reports success
426
427             if(unlikely(!cd->successful_collections)) {
428                 // we have collected nothing so far
429
430                 if(likely(cd->serial_failures <= 10)) {
431                     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.");
432                     sleep((unsigned int) (cd->update_every * 10));
433                 }
434                 else {
435                     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);
436                     cd->enabled = 0;
437                 }
438             }
439             else
440                 sleep((unsigned int) cd->update_every);
441         }
442         cd->pid = 0;
443
444         if(unlikely(!cd->enabled)) break;
445     }
446
447     info("PLUGINSD: '%s' thread exiting", cd->fullfilename);
448
449     cd->obsolete = 1;
450     pthread_exit(NULL);
451     return NULL;
452 }
453
454 void *pluginsd_main(void *ptr) {
455     struct netdata_static_thread *static_thread = (struct netdata_static_thread *)ptr;
456
457     info("PLUGINS.D thread created with task id %d", gettid());
458
459     if(pthread_setcanceltype(PTHREAD_CANCEL_DEFERRED, NULL) != 0)
460         error("Cannot set pthread cancel type to DEFERRED.");
461
462     if(pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, NULL) != 0)
463         error("Cannot set pthread cancel state to ENABLE.");
464
465     int automatic_run = config_get_boolean("plugins", "enable running new plugins", 1);
466     int scan_frequency = (int) config_get_number("plugins", "check for new plugins every", 60);
467     DIR *dir = NULL;
468     struct dirent *file = NULL;
469     struct plugind *cd;
470
471     // enable the apps plugin by default
472     // config_get_boolean("plugins", "apps", 1);
473
474     if(scan_frequency < 1) scan_frequency = 1;
475
476     for(;;) {
477         if(unlikely(netdata_exit)) break;
478
479         dir = opendir(netdata_configured_plugins_dir);
480         if(unlikely(!dir)) {
481             error("Cannot open directory '%s'.", netdata_configured_plugins_dir);
482             goto cleanup;
483         }
484
485         while(likely((file = readdir(dir)))) {
486             if(unlikely(netdata_exit)) break;
487
488             debug(D_PLUGINSD, "PLUGINSD: Examining file '%s'", file->d_name);
489
490             if(unlikely(strcmp(file->d_name, ".") == 0 || strcmp(file->d_name, "..") == 0)) continue;
491
492             int len = (int) strlen(file->d_name);
493             if(unlikely(len <= (int)PLUGINSD_FILE_SUFFIX_LEN)) continue;
494             if(unlikely(strcmp(PLUGINSD_FILE_SUFFIX, &file->d_name[len - (int)PLUGINSD_FILE_SUFFIX_LEN]) != 0)) {
495                 debug(D_PLUGINSD, "PLUGINSD: File '%s' does not end in '%s'.", file->d_name, PLUGINSD_FILE_SUFFIX);
496                 continue;
497             }
498
499             char pluginname[CONFIG_MAX_NAME + 1];
500             snprintfz(pluginname, CONFIG_MAX_NAME, "%.*s", (int)(len - PLUGINSD_FILE_SUFFIX_LEN), file->d_name);
501             int enabled = config_get_boolean("plugins", pluginname, automatic_run);
502
503             if(unlikely(!enabled)) {
504                 debug(D_PLUGINSD, "PLUGINSD: plugin '%s' is not enabled", file->d_name);
505                 continue;
506             }
507
508             // check if it runs already
509             for(cd = pluginsd_root ; cd ; cd = cd->next)
510                 if(unlikely(strcmp(cd->filename, file->d_name) == 0)) break;
511
512             if(likely(cd && !cd->obsolete)) {
513                 debug(D_PLUGINSD, "PLUGINSD: plugin '%s' is already running", cd->filename);
514                 continue;
515             }
516
517             // it is not running
518             // allocate a new one, or use the obsolete one
519             if(unlikely(!cd)) {
520                 cd = callocz(sizeof(struct plugind), 1);
521
522                 snprintfz(cd->id, CONFIG_MAX_NAME, "plugin:%s", pluginname);
523
524                 strncpyz(cd->filename, file->d_name, FILENAME_MAX);
525                 snprintfz(cd->fullfilename, FILENAME_MAX, "%s/%s", netdata_configured_plugins_dir, cd->filename);
526
527                 cd->enabled = enabled;
528                 cd->update_every = (int) config_get_number(cd->id, "update every", rrd_update_every);
529                 cd->started_t = now_realtime_sec();
530
531                 char *def = "";
532                 snprintfz(cd->cmd, PLUGINSD_CMD_MAX, "exec %s %d %s", cd->fullfilename, cd->update_every, config_get(cd->id, "command options", def));
533
534                 // link it
535                 if(likely(pluginsd_root)) cd->next = pluginsd_root;
536                 pluginsd_root = cd;
537
538                 // it is not currently running
539                 cd->obsolete = 1;
540
541                 if(cd->enabled) {
542                     // spawn a new thread for it
543                     if(unlikely(pthread_create(&cd->thread, NULL, pluginsd_worker_thread, cd) != 0))
544                         error("PLUGINSD: failed to create new thread for plugin '%s'.", cd->filename);
545
546                     else if(unlikely(pthread_detach(cd->thread) != 0))
547                         error("PLUGINSD: Cannot request detach of newly created thread for plugin '%s'.", cd->filename);
548                 }
549             }
550         }
551
552         closedir(dir);
553         sleep((unsigned int) scan_frequency);
554     }
555
556 cleanup:
557     info("PLUGINS.D thread exiting");
558
559     static_thread->enabled = 0;
560     pthread_exit(NULL);
561     return NULL;
562 }