2 * collectd - src/collectd.c
3 * Copyright (C) 2005-2007 Florian octo Forster
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
24 * Florian octo Forster <octo at collectd.org>
25 * Alvaro Barcellos <alvaro.barcellos at gmail.com>
31 #include "configfile.h"
35 #include <sys/types.h>
46 #ifndef COLLECTD_LOCALE
47 #define COLLECTD_LOCALE "C"
52 static void *do_flush(void __attribute__((unused)) * arg) {
53 INFO("Flushing all data.");
54 plugin_flush(/* plugin = */ NULL,
57 INFO("Finished flushing all data.");
62 static void sig_int_handler(int __attribute__((unused)) signal) { loop++; }
64 static void sig_term_handler(int __attribute__((unused)) signal) { loop++; }
66 static void sig_usr1_handler(int __attribute__((unused)) signal) {
70 /* flushing the data might take a while,
71 * so it should be done asynchronously */
72 pthread_attr_init(&attr);
73 pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED);
74 pthread_create(&thread, &attr, do_flush, NULL);
75 pthread_attr_destroy(&attr);
78 static int init_hostname(void) {
79 const char *str = global_option_get("Hostname");
80 if ((str != NULL) && (str[0] != 0)) {
85 long hostname_len = sysconf(_SC_HOST_NAME_MAX);
86 if (hostname_len == -1) {
87 hostname_len = NI_MAXHOST;
89 char hostname[hostname_len];
91 if (gethostname(hostname, hostname_len) != 0) {
92 fprintf(stderr, "`gethostname' failed and no "
93 "hostname was configured.\n");
97 hostname_set(hostname);
99 str = global_option_get("FQDNLookup");
103 struct addrinfo *ai_list;
104 struct addrinfo ai_hints = {.ai_flags = AI_CANONNAME};
106 int status = getaddrinfo(hostname, NULL, &ai_hints, &ai_list);
108 ERROR("Looking up \"%s\" failed. You have set the "
109 "\"FQDNLookup\" option, but I cannot resolve "
110 "my hostname to a fully qualified domain "
111 "name. Please fix the network "
117 for (struct addrinfo *ai_ptr = ai_list; ai_ptr != NULL;
118 ai_ptr = ai_ptr->ai_next) {
119 if (ai_ptr->ai_canonname == NULL)
122 hostname_set(ai_ptr->ai_canonname);
126 freeaddrinfo(ai_list);
128 } /* int init_hostname */
130 static int init_global_variables(void) {
133 interval_g = cf_get_default_interval();
134 assert(interval_g > 0);
135 DEBUG("interval_g = %.3f;", CDTIME_T_TO_DOUBLE(interval_g));
137 str = global_option_get("Timeout");
140 timeout_g = atoi(str);
141 if (timeout_g <= 1) {
142 fprintf(stderr, "Cannot set the timeout to a correct value.\n"
143 "Please check your settings.\n");
146 DEBUG("timeout_g = %i;", timeout_g);
148 if (init_hostname() != 0)
150 DEBUG("hostname_g = %s;", hostname_g);
153 } /* int init_global_variables */
155 static int change_basedir(const char *orig_dir, _Bool create) {
160 dir = strdup(orig_dir);
163 ERROR("strdup failed: %s", sstrerror(errno, errbuf, sizeof(errbuf)));
167 dirlen = strlen(dir);
168 while ((dirlen > 0) && (dir[dirlen - 1] == '/'))
169 dir[--dirlen] = '\0';
180 } else if (!create || (errno != ENOENT)) {
182 ERROR("change_basedir: chdir (%s): %s", dir,
183 sstrerror(errno, errbuf, sizeof(errbuf)));
188 status = mkdir(dir, S_IRWXU | S_IRWXG | S_IRWXO);
191 ERROR("change_basedir: mkdir (%s): %s", dir,
192 sstrerror(errno, errbuf, sizeof(errbuf)));
200 ERROR("change_basedir: chdir (%s): %s", dir,
201 sstrerror(errno, errbuf, sizeof(errbuf)));
208 } /* static int change_basedir (char *dir) */
211 static void update_kstat(void) {
213 if ((kc = kstat_open()) == NULL)
214 ERROR("Unable to open kstat control structure");
217 kid = kstat_chain_update(kc);
219 INFO("kstat chain has been updated");
222 ERROR("kstat chain update failed");
223 /* else: everything works as expected */
227 } /* static void update_kstat (void) */
228 #endif /* HAVE_LIBKSTAT */
231 * Remove all settings but `-f' and `-C'
233 __attribute__((noreturn)) static void exit_usage(int status) {
234 printf("Usage: " PACKAGE_NAME " [OPTIONS]\n\n"
236 "Available options:\n"
238 " -C <file> Configuration file.\n"
239 " Default: " CONFIGFILE "\n"
240 " -t Test config and exit.\n"
241 " -T Test plugin read and exit.\n"
242 " -P <file> PID-file.\n"
243 " Default: " PIDFILE "\n"
245 " -f Don't fork to the background.\n"
247 " -B Don't create the BaseDir\n"
248 " -h Display help (this message)\n"
249 "\nBuiltin defaults:\n"
250 " Config file " CONFIGFILE "\n"
251 " PID file " PIDFILE "\n"
252 " Plugin directory " PLUGINDIR "\n"
253 " Data directory " PKGLOCALSTATEDIR "\n"
254 "\n" PACKAGE_NAME " " PACKAGE_VERSION ", http://collectd.org/\n"
255 "by Florian octo Forster <octo@collectd.org>\n"
256 "for contributions see `AUTHORS'\n");
258 } /* static void exit_usage (int status) */
260 static int do_init(void) {
262 if (setlocale(LC_NUMERIC, COLLECTD_LOCALE) == NULL)
263 WARNING("setlocale (\"%s\") failed.", COLLECTD_LOCALE);
265 /* Update the environment, so that libraries that are calling
266 * setlocale(LC_NUMERIC, "") don't accidentally revert these changes. */
268 setenv("LC_NUMERIC", COLLECTD_LOCALE, /* overwrite = */ 1);
278 #if HAVE_LIBSTATGRAB_0_90
282 ERROR("sg_init: %s", sg_str_error(sg_get_error()));
286 if (sg_drop_privileges()) {
287 ERROR("sg_drop_privileges: %s", sg_str_error(sg_get_error()));
292 return plugin_init_all();
293 } /* int do_init () */
295 static int do_loop(void) {
296 cdtime_t interval = cf_get_default_interval();
299 wait_until = cdtime() + interval;
308 /* Issue all plugins */
312 if (now >= wait_until) {
313 WARNING("Not sleeping because the next interval is "
314 "%.3f seconds in the past!",
315 CDTIME_T_TO_DOUBLE(now - wait_until));
316 wait_until = now + interval;
320 struct timespec ts_wait = CDTIME_T_TO_TIMESPEC(wait_until - now);
321 wait_until = wait_until + interval;
323 while ((loop == 0) && (nanosleep(&ts_wait, &ts_wait) != 0)) {
324 if (errno != EINTR) {
326 ERROR("nanosleep failed: %s", sstrerror(errno, errbuf, sizeof(errbuf)));
330 } /* while (loop == 0) */
335 static int do_shutdown(void) {
336 return plugin_shutdown_all();
337 } /* int do_shutdown */
340 static int pidfile_create(void) {
342 const char *file = global_option_get("PIDFile");
344 if ((fh = fopen(file, "w")) == NULL) {
346 ERROR("fopen (%s): %s", file, sstrerror(errno, errbuf, sizeof(errbuf)));
350 fprintf(fh, "%i\n", (int)getpid());
354 } /* static int pidfile_create (const char *file) */
356 static int pidfile_remove(void) {
357 const char *file = global_option_get("PIDFile");
362 } /* static int pidfile_remove (const char *file) */
363 #endif /* COLLECT_DAEMON */
366 static int notify_upstart(void) {
367 char const *upstart_job = getenv("UPSTART_JOB");
369 if (upstart_job == NULL)
372 if (strcmp(upstart_job, "collectd") != 0) {
373 WARNING("Environment specifies unexpected UPSTART_JOB=\"%s\", expected "
374 "\"collectd\". Ignoring the variable.",
379 NOTICE("Upstart detected, stopping now to signal readyness.");
381 unsetenv("UPSTART_JOB");
386 static int notify_systemd(void) {
388 const char *notifysocket;
389 struct sockaddr_un su = {0};
391 char buffer[] = "READY=1\n";
393 notifysocket = getenv("NOTIFY_SOCKET");
394 if (notifysocket == NULL)
397 if ((strlen(notifysocket) < 2) ||
398 ((notifysocket[0] != '@') && (notifysocket[0] != '/'))) {
399 ERROR("invalid notification socket NOTIFY_SOCKET=\"%s\": path must be "
404 NOTICE("Systemd detected, trying to signal readyness.");
406 unsetenv("NOTIFY_SOCKET");
408 #if defined(SOCK_CLOEXEC)
409 fd = socket(AF_UNIX, SOCK_DGRAM | SOCK_CLOEXEC, /* protocol = */ 0);
411 fd = socket(AF_UNIX, SOCK_DGRAM, /* protocol = */ 0);
415 ERROR("creating UNIX socket failed: %s",
416 sstrerror(errno, errbuf, sizeof(errbuf)));
420 su.sun_family = AF_UNIX;
421 if (notifysocket[0] != '@') {
422 /* regular UNIX socket */
423 sstrncpy(su.sun_path, notifysocket, sizeof(su.sun_path));
424 su_size = sizeof(su);
426 /* Linux abstract namespace socket: specify address as "\0foo", i.e.
427 * start with a null byte. Since null bytes have no special meaning in
428 * that case, we have to set su_size correctly to cover only the bytes
429 * that are part of the address. */
430 sstrncpy(su.sun_path, notifysocket, sizeof(su.sun_path));
432 su_size = sizeof(sa_family_t) + strlen(notifysocket);
433 if (su_size > sizeof(su))
434 su_size = sizeof(su);
437 if (sendto(fd, buffer, strlen(buffer), MSG_NOSIGNAL, (void *)&su,
438 (socklen_t)su_size) < 0) {
440 ERROR("sendto(\"%s\") failed: %s", notifysocket,
441 sstrerror(errno, errbuf, sizeof(errbuf)));
446 unsetenv("NOTIFY_SOCKET");
450 #endif /* KERNEL_LINUX */
452 struct cmdline_config {
455 _Bool create_basedir;
456 const char *configfile;
460 void read_cmdline(int argc, char **argv, struct cmdline_config *config) {
464 c = getopt(argc, argv, "htTC:"
475 config->create_basedir = 0;
478 config->configfile = optarg;
481 config->test_config = 1;
484 config->test_readall = 1;
485 global_option_set("ReadThreads", "-1", 1);
487 config->daemonize = 0;
488 #endif /* COLLECT_DAEMON */
492 global_option_set("PIDFile", optarg, 1);
495 config->daemonize = 0;
497 #endif /* COLLECT_DAEMON */
507 int configure_collectd(struct cmdline_config *config) {
510 * Read options from the config file, the environment and the command
511 * line (in that order, with later options overwriting previous ones in
513 * Also, this will automatically load modules.
515 if (cf_read(config->configfile)) {
516 fprintf(stderr, "Error: Reading the config file failed!\n"
517 "Read the logs for details.\n");
522 * Change directory. We do this _after_ reading the config and loading
523 * modules to relative paths work as expected.
525 if ((basedir = global_option_get("BaseDir")) == NULL) {
527 "Don't have a basedir to use. This should not happen. Ever.");
529 } else if (change_basedir(basedir, config->create_basedir)) {
530 fprintf(stderr, "Error: Unable to change to directory `%s'.\n", basedir);
535 * Set global variables or, if that fails, exit. We cannot run with
536 * them being uninitialized. If nothing is configured, then defaults
537 * are being used. So this means that the user has actually done
540 if (init_global_variables() != 0)
546 int main(int argc, char **argv) {
552 struct cmdline_config config = {
553 .daemonize = 1, .create_basedir = 1, .configfile = CONFIGFILE,
556 read_cmdline(argc, argv, &config);
558 if (config.test_config)
567 if ((status = configure_collectd(&config)) != 0)
574 struct sigaction sig_chld_action = {.sa_handler = SIG_IGN};
576 sigaction(SIGCHLD, &sig_chld_action, NULL);
579 * Only daemonize if we're not being supervised
580 * by upstart or systemd (when using Linux).
584 && notify_upstart() == 0 && notify_systemd() == 0
589 if ((pid = fork()) == -1) {
592 fprintf(stderr, "fork: %s", sstrerror(errno, errbuf, sizeof(errbuf)));
594 } else if (pid != 0) {
596 /* printf ("Running (PID %i)\n", pid); */
600 /* Detach from session */
604 if (pidfile_create())
607 /* close standard descriptors */
612 status = open("/dev/null", O_RDWR);
614 ERROR("Error: Could not connect `STDIN' to `/dev/null' (status %d)",
621 ERROR("Error: Could not connect `STDOUT' to `/dev/null' (status %d)",
628 ERROR("Error: Could not connect `STDERR' to `/dev/null', (status %d)",
632 } /* if (config.daemonize) */
633 #endif /* COLLECT_DAEMON */
635 struct sigaction sig_pipe_action = {.sa_handler = SIG_IGN};
637 sigaction(SIGPIPE, &sig_pipe_action, NULL);
640 * install signal handlers
642 struct sigaction sig_int_action = {.sa_handler = sig_int_handler};
644 if (0 != sigaction(SIGINT, &sig_int_action, NULL)) {
646 ERROR("Error: Failed to install a signal handler for signal INT: %s",
647 sstrerror(errno, errbuf, sizeof(errbuf)));
651 struct sigaction sig_term_action = {.sa_handler = sig_term_handler};
653 if (0 != sigaction(SIGTERM, &sig_term_action, NULL)) {
655 ERROR("Error: Failed to install a signal handler for signal TERM: %s",
656 sstrerror(errno, errbuf, sizeof(errbuf)));
660 struct sigaction sig_usr1_action = {.sa_handler = sig_usr1_handler};
662 if (0 != sigaction(SIGUSR1, &sig_usr1_action, NULL)) {
664 ERROR("Error: Failed to install a signal handler for signal USR1: %s",
665 sstrerror(errno, errbuf, sizeof(errbuf)));
670 * run the actual loops
672 if (do_init() != 0) {
673 ERROR("Error: one or more plugin init callbacks failed.");
677 if (config.test_readall) {
678 if (plugin_read_all_once() != 0) {
679 ERROR("Error: one or more plugin read callbacks failed.");
683 INFO("Initialization complete, entering read-loop.");
688 INFO("Exiting normally.");
690 if (do_shutdown() != 0) {
691 ERROR("Error: one or more plugin shutdown callbacks failed.");
696 if (config.daemonize)
698 #endif /* COLLECT_DAEMON */