14 #include "appconfig.h"
18 #include "plugins_d.h"
19 #include "../config.h"
21 struct plugind *pluginsd_root = NULL;
25 static inline int pluginsd_space(char c) {
39 static int pluginsd_split_words(char *str, char **words, int max_words) {
40 char *s = str, quote = 0;
43 // skip all white space
44 while(unlikely(pluginsd_space(*s))) s++;
47 if(unlikely(*s == '\'' || *s == '"')) {
48 quote = *s; // remember the quote
49 s++; // skip the quote
52 // store the first word
55 // while we have something
58 if(unlikely(*s == '\\' && s[1])) {
64 else if(unlikely(*s == quote)) {
71 else if(unlikely(quote == 0 && pluginsd_space(*s))) {
76 // skip all white space
77 while(likely(pluginsd_space(*s))) s++;
80 if(unlikely(*s == '\'' || *s == '"')) {
81 quote = *s; // remember the quote
82 s++; // skip the quote
85 // if we reached the end, stop
86 if(unlikely(!*s)) break;
88 // store the next word
89 if(likely(i < max_words)) words[i++] = s;
97 // terminate the words
99 while(likely(j < max_words)) words[j++] = NULL;
105 void *pluginsd_worker_thread(void *arg)
107 struct plugind *cd = (struct plugind *)arg;
108 char line[PLUGINSD_LINE_MAX + 1];
110 #ifdef DETACH_PLUGINS_FROM_NETDATA
111 unsigned long long usec = 0, susec = 0;
112 struct timeval last = {0, 0} , now = {0, 0};
115 char *words[MAX_WORDS] = { NULL };
116 uint32_t SET_HASH = simple_hash("SET");
117 uint32_t BEGIN_HASH = simple_hash("BEGIN");
118 uint32_t END_HASH = simple_hash("END");
119 uint32_t FLUSH_HASH = simple_hash("FLUSH");
120 uint32_t CHART_HASH = simple_hash("CHART");
121 uint32_t DIMENSION_HASH = simple_hash("DIMENSION");
122 uint32_t DISABLE_HASH = simple_hash("DISABLE");
123 #ifdef DETACH_PLUGINS_FROM_NETDATA
124 uint32_t MYPID_HASH = simple_hash("MYPID");
125 uint32_t STOPPING_WAKE_ME_UP_PLEASE_HASH = simple_hash("STOPPING_WAKE_ME_UP_PLEASE");
131 if(unlikely(netdata_exit)) break;
133 FILE *fp = mypopen(cd->cmd, &cd->pid);
135 error("Cannot popen(\"%s\", \"r\").", cd->cmd);
139 info("PLUGINSD: '%s' running on pid %d", cd->fullfilename, cd->pid);
145 while(likely(fgets(line, PLUGINSD_LINE_MAX, fp) != NULL)) {
146 if(unlikely(netdata_exit)) break;
148 line[PLUGINSD_LINE_MAX] = '\0';
150 // debug(D_PLUGINSD, "PLUGINSD: %s: %s", cd->filename, line);
152 int w = pluginsd_split_words(line, words, MAX_WORDS);
154 if(unlikely(!s || !*s || !w)) {
155 // debug(D_PLUGINSD, "PLUGINSD: empty line");
159 // 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]);
161 hash = simple_hash(s);
163 if(likely(hash == SET_HASH && !strcmp(s, "SET"))) {
164 char *dimension = words[1];
165 char *value = words[2];
167 if(unlikely(!dimension || !*dimension)) {
168 error("PLUGINSD: '%s' is requesting a SET on chart '%s', without a dimension. Disabling it.", cd->fullfilename, st->id);
170 killpid(cd->pid, SIGTERM);
174 if(unlikely(!value || !*value)) value = NULL;
177 error("PLUGINSD: '%s' is requesting a SET on dimension %s with value %s, without a BEGIN. Disabling it.", cd->fullfilename, dimension, value?value:"<nothing>");
179 killpid(cd->pid, SIGTERM);
183 if(unlikely(st->debug)) debug(D_PLUGINSD, "PLUGINSD: '%s' is setting dimension %s/%s to %s", cd->fullfilename, st->id, dimension, value?value:"<nothing>");
185 if(value) rrddim_set(st, dimension, strtoll(value, NULL, 0));
187 else if(likely(hash == BEGIN_HASH && !strcmp(s, "BEGIN"))) {
189 char *microseconds_txt = words[2];
192 error("PLUGINSD: '%s' is requesting a BEGIN without a chart id. Disabling it.", cd->fullfilename);
194 killpid(cd->pid, SIGTERM);
198 st = rrdset_find(id);
200 error("PLUGINSD: '%s' is requesting a BEGIN on chart '%s', which does not exist. Disabling it.", cd->fullfilename, id);
202 killpid(cd->pid, SIGTERM);
206 if(likely(st->counter_done)) {
207 unsigned long long microseconds = 0;
208 if(microseconds_txt && *microseconds_txt) microseconds = strtoull(microseconds_txt, NULL, 10);
209 if(microseconds) rrdset_next_usec(st, microseconds);
210 else rrdset_next_plugins(st);
213 else if(likely(hash == END_HASH && !strcmp(s, "END"))) {
215 error("PLUGINSD: '%s' is requesting an END, without a BEGIN. Disabling it.", cd->fullfilename);
217 killpid(cd->pid, SIGTERM);
221 if(unlikely(st->debug)) debug(D_PLUGINSD, "PLUGINSD: '%s' is requesting an END on chart %s", cd->fullfilename, st->id);
228 else if(likely(hash == FLUSH_HASH && !strcmp(s, "FLUSH"))) {
229 debug(D_PLUGINSD, "PLUGINSD: '%s' is requesting a FLUSH", cd->fullfilename);
232 else if(likely(hash == CHART_HASH && !strcmp(s, "CHART"))) {
236 if((words[1]) != NULL && (words[2]) != NULL && strcmp(words[1], words[2]) == 0)
239 char *type = words[1];
242 id = strchr(type, '.');
243 if(likely(id)) { *id = '\0'; id++; }
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];
254 if(unlikely(!type || !*type || !id || !*id)) {
255 error("PLUGINSD: '%s' is requesting a CHART, without a type.id. Disabling it.", cd->fullfilename);
257 killpid(cd->pid, SIGTERM);
262 if(likely(priority_s)) priority = atoi(priority_s);
264 int update_every = cd->update_every;
265 if(likely(update_every_s)) update_every = atoi(update_every_s);
266 if(unlikely(!update_every)) update_every = cd->update_every;
268 int chart_type = RRDSET_TYPE_LINE;
269 if(unlikely(chart)) chart_type = rrdset_type_id(chart);
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;
275 st = rrdset_find_bytype(type, id);
277 debug(D_PLUGINSD, "PLUGINSD: Creating chart type='%s', id='%s', name='%s', family='%s', context='%s', chart='%s', priority=%d, update_every=%d"
282 , rrdset_type_name(chart_type)
287 st = rrdset_create(type, id, name, family, context, title, units, priority, update_every, chart_type);
288 cd->update_every = update_every;
290 else debug(D_PLUGINSD, "PLUGINSD: Chart '%s' already exists. Not adding it again.", st->id);
292 else if(likely(hash == DIMENSION_HASH && !strcmp(s, "DIMENSION"))) {
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];
300 if(unlikely(!id || !*id)) {
301 error("PLUGINSD: '%s' is requesting a DIMENSION, without an id. Disabling it.", cd->fullfilename);
303 killpid(cd->pid, SIGTERM);
308 error("PLUGINSD: '%s' is requesting a DIMENSION, without a CHART. Disabling it.", cd->fullfilename);
310 killpid(cd->pid, SIGTERM);
315 if(multiplier_s && *multiplier_s) multiplier = strtol(multiplier_s, NULL, 0);
316 if(unlikely(!multiplier)) multiplier = 1;
319 if(likely(divisor_s && *divisor_s)) divisor = strtol(divisor_s, NULL, 0);
320 if(unlikely(!divisor)) divisor = 1;
322 if(unlikely(!algorithm || !*algorithm)) algorithm = "absolute";
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'"
328 , rrddim_algorithm_name(rrddim_algorithm_id(algorithm))
334 RRDDIM *rd = rrddim_find(st, id);
336 rd = rrddim_add(st, id, name, multiplier, divisor, rrddim_algorithm_id(algorithm));
337 rd->flags = 0x00000000;
338 if(options && *options) {
339 if(strstr(options, "hidden") != NULL) rd->flags |= RRDDIM_FLAG_HIDDEN;
340 if(strstr(options, "noreset") != NULL) rd->flags |= RRDDIM_FLAG_DONT_DETECT_RESETS_OR_OVERFLOWS;
341 if(strstr(options, "nooverflow") != NULL) rd->flags |= RRDDIM_FLAG_DONT_DETECT_RESETS_OR_OVERFLOWS;
344 else if(unlikely(st->debug)) debug(D_PLUGINSD, "PLUGINSD: dimension %s/%s already exists. Not adding it again.", st->id, id);
346 else if(unlikely(hash == DISABLE_HASH && !strcmp(s, "DISABLE"))) {
347 error("PLUGINSD: '%s' called DISABLE. Disabling it.", cd->fullfilename);
349 killpid(cd->pid, SIGTERM);
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);
357 if(likely(pid)) cd->pid = pid;
358 debug(D_PLUGINSD, "PLUGINSD: %s is on pid %d", cd->id, cd->pid);
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);
363 gettimeofday(&now, NULL);
364 if(unlikely(!usec && !susec)) {
366 susec = cd->rrd_update_every * 1000000ULL;
370 usec = usecdiff(&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 * 1000000ULL / 2ULL))) susec = (rrd_update_every * 1000000ULL) - usec;
373 else susec = rrd_update_every * 1000000ULL / 2ULL;
376 error("PLUGINSD: %s sleeping for %llu. Will kill with SIGCONT pid %d to wake it up.\n", cd->fullfilename, susec, cd->pid);
378 killpid(cd->pid, SIGCONT);
379 bcopy(&now, &last, sizeof(struct timeval));
384 error("PLUGINSD: '%s' is sending command '%s' which is not known by netdata. Disabling it.", cd->fullfilename, s);
386 killpid(cd->pid, SIGTERM);
391 cd->successful_collections += count;
392 cd->serial_failures = 0;
395 cd->serial_failures++;
397 info("PLUGINSD: '%s' on pid %d stopped after %zu successful data collections (ENDs).", cd->fullfilename, cd->pid, count);
399 // get the return code
400 int code = mypclose(fp, cd->pid);
411 // the plugin reports failure
413 if(likely(!cd->successful_collections)) {
414 // nothing collected - disable it
415 error("PLUGINSD: '%s' exited with error code %d. Disabling it.", cd->fullfilename, code);
419 // we have collected something
421 if(likely(cd->serial_failures <= 10)) {
422 error("PLUGINSD: '%s' exited with error code %d, but has given useful output in the past (%zu times). Waiting a bit before starting it again.", cd->fullfilename, code, cd->successful_collections);
423 sleep((unsigned int) (cd->update_every * 10));
426 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);
432 // the plugin reports success
434 if(unlikely(!cd->successful_collections)) {
435 // we have collected nothing so far
437 if(likely(cd->serial_failures <= 10)) {
438 error("PLUGINSD: '%s' (pid %d) does not generate useful output but it reports success (exits with 0). Waiting a bit before starting it again.", cd->fullfilename, cd->pid);
439 sleep((unsigned int) (cd->update_every * 10));
442 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);
447 sleep((unsigned int) cd->update_every);
451 if(unlikely(!cd->enabled))
460 void *pluginsd_main(void *ptr)
464 info("PLUGINS.D thread created with task id %d", gettid());
466 if(pthread_setcanceltype(PTHREAD_CANCEL_DEFERRED, NULL) != 0)
467 error("Cannot set pthread cancel type to DEFERRED.");
469 if(pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, NULL) != 0)
470 error("Cannot set pthread cancel state to ENABLE.");
472 char *dir_name = config_get("plugins", "plugins directory", PLUGINS_DIR);
473 int automatic_run = config_get_boolean("plugins", "enable running new plugins", 1);
474 int scan_frequency = (int) config_get_number("plugins", "check for new plugins every", 60);
476 struct dirent *file = NULL;
479 // enable the apps plugin by default
480 // config_get_boolean("plugins", "apps", 1);
482 if(scan_frequency < 1) scan_frequency = 1;
485 if(unlikely(netdata_exit)) break;
487 dir = opendir(dir_name);
489 error("Cannot open directory '%s'.", dir_name);
494 while(likely((file = readdir(dir)))) {
495 if(unlikely(netdata_exit)) break;
497 debug(D_PLUGINSD, "PLUGINSD: Examining file '%s'", file->d_name);
499 if(unlikely(strcmp(file->d_name, ".") == 0 || strcmp(file->d_name, "..") == 0)) continue;
501 int len = (int) strlen(file->d_name);
502 if(unlikely(len <= (int)PLUGINSD_FILE_SUFFIX_LEN)) continue;
503 if(unlikely(strcmp(PLUGINSD_FILE_SUFFIX, &file->d_name[len - (int)PLUGINSD_FILE_SUFFIX_LEN]) != 0)) {
504 debug(D_PLUGINSD, "PLUGINSD: File '%s' does not end in '%s'.", file->d_name, PLUGINSD_FILE_SUFFIX);
508 char pluginname[CONFIG_MAX_NAME + 1];
509 snprintfz(pluginname, CONFIG_MAX_NAME, "%.*s", (int)(len - PLUGINSD_FILE_SUFFIX_LEN), file->d_name);
510 int enabled = config_get_boolean("plugins", pluginname, automatic_run);
512 if(unlikely(!enabled)) {
513 debug(D_PLUGINSD, "PLUGINSD: plugin '%s' is not enabled", file->d_name);
517 // check if it runs already
518 for(cd = pluginsd_root ; likely(cd) ; cd = cd->next) {
519 if(unlikely(strcmp(cd->filename, file->d_name) == 0)) break;
521 if(likely(cd && !cd->obsolete)) {
522 debug(D_PLUGINSD, "PLUGINSD: plugin '%s' is already running", cd->filename);
527 // allocate a new one, or use the obsolete one
529 cd = calloc(sizeof(struct plugind), 1);
530 if(unlikely(!cd)) fatal("Cannot allocate memory for plugin.");
532 snprintfz(cd->id, CONFIG_MAX_NAME, "plugin:%s", pluginname);
534 strncpyz(cd->filename, file->d_name, FILENAME_MAX);
535 snprintfz(cd->fullfilename, FILENAME_MAX, "%s/%s", dir_name, cd->filename);
537 cd->enabled = enabled;
538 cd->update_every = (int) config_get_number(cd->id, "update every", rrd_update_every);
539 cd->started_t = time(NULL);
542 snprintfz(cd->cmd, PLUGINSD_CMD_MAX, "exec %s %d %s", cd->fullfilename, cd->update_every, config_get(cd->id, "command options", def));
545 if(likely(pluginsd_root)) cd->next = pluginsd_root;
550 if(unlikely(!cd->enabled)) continue;
552 // spawn a new thread for it
553 if(unlikely(pthread_create(&cd->thread, NULL, pluginsd_worker_thread, cd) != 0)) {
554 error("PLUGINSD: failed to create new thread for plugin '%s'.", cd->filename);
557 else if(unlikely(pthread_detach(cd->thread) != 0))
558 error("PLUGINSD: Cannot request detach of newly created thread for plugin '%s'.", cd->filename);
562 sleep((unsigned int) scan_frequency);