14 #include "appconfig.h"
18 #include "plugins_d.h"
20 struct plugind *pluginsd_root = NULL;
24 static inline int pluginsd_space(char c) {
38 static int pluginsd_split_words(char *str, char **words, int max_words) {
39 char *s = str, quote = 0;
42 // skip all white space
43 while(unlikely(pluginsd_space(*s))) s++;
46 if(unlikely(*s == '\'' || *s == '"')) {
47 quote = *s; // remember the quote
48 s++; // skip the quote
51 // store the first word
54 // while we have something
57 if(unlikely(*s == '\\' && s[1])) {
63 else if(unlikely(*s == quote)) {
70 else if(unlikely(quote == 0 && pluginsd_space(*s))) {
75 // skip all white space
76 while(likely(pluginsd_space(*s))) s++;
79 if(unlikely(*s == '\'' || *s == '"')) {
80 quote = *s; // remember the quote
81 s++; // skip the quote
84 // if we reached the end, stop
85 if(unlikely(!*s)) break;
87 // store the next word
88 if(likely(i < max_words)) words[i++] = s;
96 // terminate the words
98 while(likely(j < max_words)) words[j++] = NULL;
104 void *pluginsd_worker_thread(void *arg)
106 struct plugind *cd = (struct plugind *)arg;
107 char line[PLUGINSD_LINE_MAX + 1];
109 #ifdef DETACH_PLUGINS_FROM_NETDATA
110 unsigned long long usec = 0, susec = 0;
111 struct timeval last = {0, 0} , now = {0, 0};
114 char *words[MAX_WORDS] = { NULL };
115 uint32_t SET_HASH = simple_hash("SET");
116 uint32_t BEGIN_HASH = simple_hash("BEGIN");
117 uint32_t END_HASH = simple_hash("END");
118 uint32_t FLUSH_HASH = simple_hash("FLUSH");
119 uint32_t CHART_HASH = simple_hash("CHART");
120 uint32_t DIMENSION_HASH = simple_hash("DIMENSION");
121 uint32_t DISABLE_HASH = simple_hash("DISABLE");
122 #ifdef DETACH_PLUGINS_FROM_NETDATA
123 uint32_t MYPID_HASH = simple_hash("MYPID");
124 uint32_t STOPPING_WAKE_ME_UP_PLEASE_HASH = simple_hash("STOPPING_WAKE_ME_UP_PLEASE");
128 FILE *fp = mypopen(cd->cmd, &cd->pid);
130 error("Cannot popen(\"%s\", \"r\").", cd->cmd);
134 info("PLUGINSD: '%s' running on pid %d", cd->fullfilename, cd->pid);
137 unsigned long long count = 0;
141 while(likely(fgets(line, PLUGINSD_LINE_MAX, fp) != NULL)) {
142 if(netdata_exit) break;
144 line[PLUGINSD_LINE_MAX] = '\0';
146 // debug(D_PLUGINSD, "PLUGINSD: %s: %s", cd->filename, line);
148 int w = pluginsd_split_words(line, words, MAX_WORDS);
150 if(unlikely(!s || !*s || !w)) {
151 // debug(D_PLUGINSD, "PLUGINSD: empty line");
155 // 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]);
157 hash = simple_hash(s);
159 if(likely(hash == SET_HASH && !strcmp(s, "SET"))) {
160 char *dimension = words[1];
161 char *value = words[2];
163 if(unlikely(!dimension || !*dimension)) {
164 error("PLUGINSD: '%s' is requesting a SET on chart '%s', without a dimension. Disabling it.", cd->fullfilename, st->id);
166 killpid(cd->pid, SIGTERM);
170 if(unlikely(!value || !*value)) value = NULL;
173 error("PLUGINSD: '%s' is requesting a SET on dimension %s with value %s, without a BEGIN. Disabling it.", cd->fullfilename, dimension, value?value:"<nothing>");
175 killpid(cd->pid, SIGTERM);
179 if(unlikely(st->debug)) debug(D_PLUGINSD, "PLUGINSD: '%s' is setting dimension %s/%s to %s", cd->fullfilename, st->id, dimension, value?value:"<nothing>");
181 if(value) rrddim_set(st, dimension, atoll(value));
185 else if(likely(hash == BEGIN_HASH && !strcmp(s, "BEGIN"))) {
187 char *microseconds_txt = words[2];
190 error("PLUGINSD: '%s' is requesting a BEGIN without a chart id. Disabling it.", cd->fullfilename);
192 killpid(cd->pid, SIGTERM);
196 st = rrdset_find(id);
198 error("PLUGINSD: '%s' is requesting a BEGIN on chart '%s', which does not exist. Disabling it.", cd->fullfilename, id);
200 killpid(cd->pid, SIGTERM);
204 if(likely(st->counter_done)) {
205 unsigned long long microseconds = 0;
206 if(microseconds_txt && *microseconds_txt) microseconds = strtoull(microseconds_txt, NULL, 10);
207 if(microseconds) rrdset_next_usec(st, microseconds);
208 else rrdset_next_plugins(st);
211 else if(likely(hash == END_HASH && !strcmp(s, "END"))) {
213 error("PLUGINSD: '%s' is requesting an END, without a BEGIN. Disabling it.", cd->fullfilename);
215 killpid(cd->pid, SIGTERM);
219 if(unlikely(st->debug)) debug(D_PLUGINSD, "PLUGINSD: '%s' is requesting a END on chart %s", cd->fullfilename, st->id);
224 else if(likely(hash == FLUSH_HASH && !strcmp(s, "FLUSH"))) {
225 debug(D_PLUGINSD, "PLUGINSD: '%s' is requesting a FLUSH", cd->fullfilename);
228 else if(likely(hash == CHART_HASH && !strcmp(s, "CHART"))) {
231 char *type = words[1];
234 id = strchr(type, '.');
235 if(likely(id)) { *id = '\0'; id++; }
237 char *name = words[2];
238 char *title = words[3];
239 char *units = words[4];
240 char *family = words[5];
241 char *category = words[6];
242 char *chart = words[7];
243 char *priority_s = words[8];
244 char *update_every_s = words[9];
246 if(unlikely(!type || !*type || !id || !*id)) {
247 error("PLUGINSD: '%s' is requesting a CHART, without a type.id. Disabling it.", cd->fullfilename);
249 killpid(cd->pid, SIGTERM);
254 if(likely(priority_s)) priority = atoi(priority_s);
256 int update_every = cd->update_every;
257 if(likely(update_every_s)) update_every = atoi(update_every_s);
258 if(unlikely(!update_every)) update_every = cd->update_every;
260 int chart_type = RRDSET_TYPE_LINE;
261 if(unlikely(chart)) chart_type = rrdset_type_id(chart);
263 if(unlikely(!name || !*name)) name = NULL;
264 if(unlikely(!family || !*family)) family = id;
265 if(unlikely(!category || !*category)) category = type;
267 st = rrdset_find_bytype(type, id);
269 debug(D_PLUGINSD, "PLUGINSD: Creating chart type='%s', id='%s', name='%s', family='%s', category='%s', chart='%s', priority=%d, update_every=%d"
273 , category?category:""
274 , rrdset_type_name(chart_type)
279 st = rrdset_create(type, id, name, family, title, units, priority, update_every, chart_type);
280 cd->update_every = update_every;
282 if(unlikely(strcmp(category, "none") == 0)) st->isdetail = 1;
284 else debug(D_PLUGINSD, "PLUGINSD: Chart '%s' already exists. Not adding it again.", st->id);
286 else if(likely(hash == DIMENSION_HASH && !strcmp(s, "DIMENSION"))) {
288 char *name = words[2];
289 char *algorithm = words[3];
290 char *multiplier_s = words[4];
291 char *divisor_s = words[5];
292 char *options = words[6];
294 if(unlikely(!id || !*id)) {
295 error("PLUGINSD: '%s' is requesting a DIMENSION, without an id. Disabling it.", cd->fullfilename);
297 killpid(cd->pid, SIGTERM);
302 error("PLUGINSD: '%s' is requesting a DIMENSION, without a CHART. Disabling it.", cd->fullfilename);
304 killpid(cd->pid, SIGTERM);
309 if(multiplier_s && *multiplier_s) multiplier = atol(multiplier_s);
310 if(unlikely(!multiplier)) multiplier = 1;
313 if(likely(divisor_s && *divisor_s)) divisor = atol(divisor_s);
314 if(unlikely(!divisor)) divisor = 1;
316 if(unlikely(!algorithm || !*algorithm)) algorithm = "absolute";
318 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'"
322 , rrddim_algorithm_name(rrddim_algorithm_id(algorithm))
328 RRDDIM *rd = rrddim_find(st, id);
330 rd = rrddim_add(st, id, name, multiplier, divisor, rrddim_algorithm_id(algorithm));
331 rd->flags = 0x00000000;
332 if(options && *options) {
333 if(strstr(options, "hidden") != NULL) rd->flags |= RRDDIM_FLAG_HIDDEN;
334 if(strstr(options, "noreset") != NULL) rd->flags |= RRDDIM_FLAG_DONT_DETECT_RESETS_OR_OVERFLOWS;
335 if(strstr(options, "nooverflow") != NULL) rd->flags |= RRDDIM_FLAG_DONT_DETECT_RESETS_OR_OVERFLOWS;
338 else if(unlikely(st->debug)) debug(D_PLUGINSD, "PLUGINSD: dimension %s/%s already exists. Not adding it again.", st->id, id);
340 else if(unlikely(hash == DISABLE_HASH && !strcmp(s, "DISABLE"))) {
341 error("PLUGINSD: '%s' called DISABLE. Disabling it.", cd->fullfilename);
343 killpid(cd->pid, SIGTERM);
346 #ifdef DETACH_PLUGINS_FROM_NETDATA
347 else if(likely(hash == MYPID_HASH && !strcmp(s, "MYPID"))) {
348 char *pid_s = words[1];
349 pid_t pid = atol(pid_s);
351 if(likely(pid)) cd->pid = pid;
352 debug(D_PLUGINSD, "PLUGINSD: %s is on pid %d", cd->id, cd->pid);
354 else if(likely(hash == STOPPING_WAKE_ME_UP_PLEASE_HASH && !strcmp(s, "STOPPING_WAKE_ME_UP_PLEASE"))) {
355 error("PLUGINSD: '%s' (pid %d) called STOPPING_WAKE_ME_UP_PLEASE.", cd->fullfilename, cd->pid);
357 gettimeofday(&now, NULL);
358 if(unlikely(!usec && !susec)) {
360 susec = cd->rrd_update_every * 1000000ULL;
364 usec = usecdiff(&now, &last) - susec;
365 error("PLUGINSD: %s last loop took %llu usec (worked for %llu, sleeped for %llu).\n", cd->fullfilename, usec + susec, usec, susec);
366 if(unlikely(usec < (rrd_update_every * 1000000ULL / 2ULL))) susec = (rrd_update_every * 1000000ULL) - usec;
367 else susec = rrd_update_every * 1000000ULL / 2ULL;
370 error("PLUGINSD: %s sleeping for %llu. Will kill with SIGCONT pid %d to wake it up.\n", cd->fullfilename, susec, cd->pid);
372 killpid(cd->pid, SIGCONT);
373 bcopy(&now, &last, sizeof(struct timeval));
378 error("PLUGINSD: '%s' is sending command '%s' which is not known by netdata. Disabling it.", cd->fullfilename, s);
380 killpid(cd->pid, SIGTERM);
385 info("PLUGINSD: '%s' on pid %d stopped.", cd->fullfilename, cd->pid);
387 // fgets() failed or loop broke
388 mypclose(fp, cd->pid);
397 if(unlikely(!count && cd->enabled)) {
398 error("PLUGINSD: '%s' (pid %d) does not generate usefull output. Waiting a bit before starting it again.", cd->fullfilename, cd->pid);
399 sleep((unsigned int) (cd->update_every * 10));
402 if(likely(cd->enabled)) sleep((unsigned int) cd->update_every);
410 void *pluginsd_main(void *ptr)
414 info("PLUGINS.D thread created with task id %d", gettid());
416 if(pthread_setcanceltype(PTHREAD_CANCEL_DEFERRED, NULL) != 0)
417 error("Cannot set pthread cancel type to DEFERRED.");
419 if(pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, NULL) != 0)
420 error("Cannot set pthread cancel state to ENABLE.");
422 char *dir_name = config_get("plugins", "plugins directory", PLUGINS_DIR);
423 int automatic_run = config_get_boolean("plugins", "enable running new plugins", 1);
424 int scan_frequency = (int) config_get_number("plugins", "check for new plugins every", 60);
426 struct dirent *file = NULL;
429 // enable the apps plugin by default
430 // config_get_boolean("plugins", "apps", 1);
432 if(scan_frequency < 1) scan_frequency = 1;
435 if(netdata_exit) break;
437 dir = opendir(dir_name);
439 error("Cannot open directory '%s'.", dir_name);
443 while(likely((file = readdir(dir)))) {
444 if(netdata_exit) break;
446 debug(D_PLUGINSD, "PLUGINSD: Examining file '%s'", file->d_name);
448 if(unlikely(strcmp(file->d_name, ".") == 0 || strcmp(file->d_name, "..") == 0)) continue;
450 int len = (int) strlen(file->d_name);
451 if(unlikely(len <= (int)PLUGINSD_FILE_SUFFIX_LEN)) continue;
452 if(unlikely(strcmp(PLUGINSD_FILE_SUFFIX, &file->d_name[len - (int)PLUGINSD_FILE_SUFFIX_LEN]) != 0)) {
453 debug(D_PLUGINSD, "PLUGINSD: File '%s' does not end in '%s'.", file->d_name, PLUGINSD_FILE_SUFFIX);
457 char pluginname[CONFIG_MAX_NAME + 1];
458 snprintf(pluginname, CONFIG_MAX_NAME, "%.*s", (int)(len - PLUGINSD_FILE_SUFFIX_LEN), file->d_name);
459 int enabled = config_get_boolean("plugins", pluginname, automatic_run);
461 if(unlikely(!enabled)) {
462 debug(D_PLUGINSD, "PLUGINSD: plugin '%s' is not enabled", file->d_name);
466 // check if it runs already
467 for(cd = pluginsd_root ; likely(cd) ; cd = cd->next) {
468 if(unlikely(strcmp(cd->filename, file->d_name) == 0)) break;
470 if(likely(cd && !cd->obsolete)) {
471 debug(D_PLUGINSD, "PLUGINSD: plugin '%s' is already running", cd->filename);
476 // allocate a new one, or use the obsolete one
478 cd = calloc(sizeof(struct plugind), 1);
479 if(unlikely(!cd)) fatal("Cannot allocate memory for plugin.");
481 snprintf(cd->id, CONFIG_MAX_NAME, "plugin:%s", pluginname);
483 strncpy(cd->filename, file->d_name, FILENAME_MAX);
484 snprintf(cd->fullfilename, FILENAME_MAX, "%s/%s", dir_name, cd->filename);
486 cd->enabled = enabled;
487 cd->update_every = (int) config_get_number(cd->id, "update every", rrd_update_every);
488 cd->started_t = time(NULL);
491 snprintf(cd->cmd, PLUGINSD_CMD_MAX, "exec %s %d %s", cd->fullfilename, cd->update_every, config_get(cd->id, "command options", def));
494 if(likely(pluginsd_root)) cd->next = pluginsd_root;
499 if(unlikely(!cd->enabled)) continue;
501 // spawn a new thread for it
502 if(unlikely(pthread_create(&cd->thread, NULL, pluginsd_worker_thread, cd) != 0)) {
503 error("PLUGINSD: failed to create new thread for plugin '%s'.", cd->filename);
506 else if(unlikely(pthread_detach(cd->thread) != 0))
507 error("PLUGINSD: Cannot request detach of newly created thread for plugin '%s'.", cd->filename);
511 sleep((unsigned int) scan_frequency);