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) {
81 struct addrinfo *ai_list;
84 long hostname_len = sysconf(_SC_HOST_NAME_MAX);
85 if (hostname_len == -1) {
86 hostname_len = NI_MAXHOST;
88 char hostname[hostname_len];
90 str = global_option_get("Hostname");
91 if ((str != NULL) && (str[0] != 0)) {
96 if (gethostname(hostname, hostname_len) != 0) {
97 fprintf(stderr, "`gethostname' failed and no "
98 "hostname was configured.\n");
102 str = global_option_get("FQDNLookup");
106 struct addrinfo ai_hints = {.ai_flags = AI_CANONNAME};
108 status = getaddrinfo(hostname, NULL, &ai_hints, &ai_list);
110 ERROR("Looking up \"%s\" failed. You have set the "
111 "\"FQDNLookup\" option, but I cannot resolve "
112 "my hostname to a fully qualified domain "
113 "name. Please fix the network "
119 for (struct addrinfo *ai_ptr = ai_list; ai_ptr != NULL;
120 ai_ptr = ai_ptr->ai_next) {
121 if (ai_ptr->ai_canonname == NULL)
124 hostname_set(ai_ptr->ai_canonname);
128 freeaddrinfo(ai_list);
130 } /* int init_hostname */
132 static int init_global_variables(void) {
135 interval_g = cf_get_default_interval();
136 assert(interval_g > 0);
137 DEBUG("interval_g = %.3f;", CDTIME_T_TO_DOUBLE(interval_g));
139 str = global_option_get("Timeout");
142 timeout_g = atoi(str);
143 if (timeout_g <= 1) {
144 fprintf(stderr, "Cannot set the timeout to a correct value.\n"
145 "Please check your settings.\n");
148 DEBUG("timeout_g = %i;", timeout_g);
150 if (init_hostname() != 0)
152 DEBUG("hostname_g = %s;", hostname_g);
155 } /* int init_global_variables */
157 static int change_basedir(const char *orig_dir, _Bool create) {
162 dir = strdup(orig_dir);
165 ERROR("strdup failed: %s", sstrerror(errno, errbuf, sizeof(errbuf)));
169 dirlen = strlen(dir);
170 while ((dirlen > 0) && (dir[dirlen - 1] == '/'))
171 dir[--dirlen] = '\0';
182 } else if (!create || (errno != ENOENT)) {
184 ERROR("change_basedir: chdir (%s): %s", dir,
185 sstrerror(errno, errbuf, sizeof(errbuf)));
190 status = mkdir(dir, S_IRWXU | S_IRWXG | S_IRWXO);
193 ERROR("change_basedir: mkdir (%s): %s", dir,
194 sstrerror(errno, errbuf, sizeof(errbuf)));
202 ERROR("change_basedir: chdir (%s): %s", dir,
203 sstrerror(errno, errbuf, sizeof(errbuf)));
210 } /* static int change_basedir (char *dir) */
213 static void update_kstat(void) {
215 if ((kc = kstat_open()) == NULL)
216 ERROR("Unable to open kstat control structure");
219 kid = kstat_chain_update(kc);
221 INFO("kstat chain has been updated");
224 ERROR("kstat chain update failed");
225 /* else: everything works as expected */
229 } /* static void update_kstat (void) */
230 #endif /* HAVE_LIBKSTAT */
233 * Remove all settings but `-f' and `-C'
235 __attribute__((noreturn)) static void exit_usage(int status) {
236 printf("Usage: " PACKAGE_NAME " [OPTIONS]\n\n"
238 "Available options:\n"
240 " -C <file> Configuration file.\n"
241 " Default: " CONFIGFILE "\n"
242 " -t Test config and exit.\n"
243 " -T Test plugin read and exit.\n"
244 " -P <file> PID-file.\n"
245 " Default: " PIDFILE "\n"
247 " -f Don't fork to the background.\n"
249 " -B Don't create the BaseDir\n"
250 " -h Display help (this message)\n"
251 "\nBuiltin defaults:\n"
252 " Config file " CONFIGFILE "\n"
253 " PID file " PIDFILE "\n"
254 " Plugin directory " PLUGINDIR "\n"
255 " Data directory " PKGLOCALSTATEDIR "\n"
256 "\n" PACKAGE_NAME " " PACKAGE_VERSION ", http://collectd.org/\n"
257 "by Florian octo Forster <octo@collectd.org>\n"
258 "for contributions see `AUTHORS'\n");
260 } /* static void exit_usage (int status) */
262 static int do_init(void) {
264 if (setlocale(LC_NUMERIC, COLLECTD_LOCALE) == NULL)
265 WARNING("setlocale (\"%s\") failed.", COLLECTD_LOCALE);
267 /* Update the environment, so that libraries that are calling
268 * setlocale(LC_NUMERIC, "") don't accidentally revert these changes. */
270 setenv("LC_NUMERIC", COLLECTD_LOCALE, /* overwrite = */ 1);
280 #if HAVE_LIBSTATGRAB_0_90
284 ERROR("sg_init: %s", sg_str_error(sg_get_error()));
288 if (sg_drop_privileges()) {
289 ERROR("sg_drop_privileges: %s", sg_str_error(sg_get_error()));
294 return plugin_init_all();
295 } /* int do_init () */
297 static int do_loop(void) {
298 cdtime_t interval = cf_get_default_interval();
301 wait_until = cdtime() + interval;
310 /* Issue all plugins */
314 if (now >= wait_until) {
315 WARNING("Not sleeping because the next interval is "
316 "%.3f seconds in the past!",
317 CDTIME_T_TO_DOUBLE(now - wait_until));
318 wait_until = now + interval;
322 struct timespec ts_wait = CDTIME_T_TO_TIMESPEC(wait_until - now);
323 wait_until = wait_until + interval;
325 while ((loop == 0) && (nanosleep(&ts_wait, &ts_wait) != 0)) {
326 if (errno != EINTR) {
328 ERROR("nanosleep failed: %s", sstrerror(errno, errbuf, sizeof(errbuf)));
332 } /* while (loop == 0) */
337 static int do_shutdown(void) {
338 return plugin_shutdown_all();
339 } /* int do_shutdown */
342 static int pidfile_create(void) {
344 const char *file = global_option_get("PIDFile");
346 if ((fh = fopen(file, "w")) == NULL) {
348 ERROR("fopen (%s): %s", file, sstrerror(errno, errbuf, sizeof(errbuf)));
352 fprintf(fh, "%i\n", (int)getpid());
356 } /* static int pidfile_create (const char *file) */
358 static int pidfile_remove(void) {
359 const char *file = global_option_get("PIDFile");
364 } /* static int pidfile_remove (const char *file) */
365 #endif /* COLLECT_DAEMON */
368 static int notify_upstart(void) {
369 char const *upstart_job = getenv("UPSTART_JOB");
371 if (upstart_job == NULL)
374 if (strcmp(upstart_job, "collectd") != 0) {
375 WARNING("Environment specifies unexpected UPSTART_JOB=\"%s\", expected "
376 "\"collectd\". Ignoring the variable.",
381 NOTICE("Upstart detected, stopping now to signal readyness.");
383 unsetenv("UPSTART_JOB");
388 static int notify_systemd(void) {
390 const char *notifysocket;
391 struct sockaddr_un su = {0};
393 char buffer[] = "READY=1\n";
395 notifysocket = getenv("NOTIFY_SOCKET");
396 if (notifysocket == NULL)
399 if ((strlen(notifysocket) < 2) ||
400 ((notifysocket[0] != '@') && (notifysocket[0] != '/'))) {
401 ERROR("invalid notification socket NOTIFY_SOCKET=\"%s\": path must be "
406 NOTICE("Systemd detected, trying to signal readyness.");
408 unsetenv("NOTIFY_SOCKET");
410 #if defined(SOCK_CLOEXEC)
411 fd = socket(AF_UNIX, SOCK_DGRAM | SOCK_CLOEXEC, /* protocol = */ 0);
413 fd = socket(AF_UNIX, SOCK_DGRAM, /* protocol = */ 0);
417 ERROR("creating UNIX socket failed: %s",
418 sstrerror(errno, errbuf, sizeof(errbuf)));
422 su.sun_family = AF_UNIX;
423 if (notifysocket[0] != '@') {
424 /* regular UNIX socket */
425 sstrncpy(su.sun_path, notifysocket, sizeof(su.sun_path));
426 su_size = sizeof(su);
428 /* Linux abstract namespace socket: specify address as "\0foo", i.e.
429 * start with a null byte. Since null bytes have no special meaning in
430 * that case, we have to set su_size correctly to cover only the bytes
431 * that are part of the address. */
432 sstrncpy(su.sun_path, notifysocket, sizeof(su.sun_path));
434 su_size = sizeof(sa_family_t) + strlen(notifysocket);
435 if (su_size > sizeof(su))
436 su_size = sizeof(su);
439 if (sendto(fd, buffer, strlen(buffer), MSG_NOSIGNAL, (void *)&su,
440 (socklen_t)su_size) < 0) {
442 ERROR("sendto(\"%s\") failed: %s", notifysocket,
443 sstrerror(errno, errbuf, sizeof(errbuf)));
448 unsetenv("NOTIFY_SOCKET");
452 #endif /* KERNEL_LINUX */
454 struct cmdline_config {
457 _Bool create_basedir;
458 const char *configfile;
462 void read_cmdline(int argc, char **argv, struct cmdline_config *config) {
466 c = getopt(argc, argv,
478 config->create_basedir = 0;
481 config->configfile = optarg;
484 config->test_config = 1;
487 config->test_readall = 1;
488 global_option_set("ReadThreads", "-1", 1);
490 config->daemonize = 0;
491 #endif /* COLLECT_DAEMON */
495 global_option_set("PIDFile", optarg, 1);
498 config->daemonize = 0;
500 #endif /* COLLECT_DAEMON */
510 int configure_collectd(struct cmdline_config *config) {
513 * Read options from the config file, the environment and the command
514 * line (in that order, with later options overwriting previous ones in
516 * Also, this will automatically load modules.
518 if (cf_read(config->configfile)) {
519 fprintf(stderr, "Error: Reading the config file failed!\n"
520 "Read the logs for details.\n");
525 * Change directory. We do this _after_ reading the config and loading
526 * modules to relative paths work as expected.
528 if ((basedir = global_option_get("BaseDir")) == NULL) {
530 "Don't have a basedir to use. This should not happen. Ever.");
532 } else if (change_basedir(basedir, config->create_basedir)) {
533 fprintf(stderr, "Error: Unable to change to directory `%s'.\n", basedir);
538 * Set global variables or, if that fails, exit. We cannot run with
539 * them being uninitialized. If nothing is configured, then defaults
540 * are being used. So this means that the user has actually done
543 if (init_global_variables() != 0)
549 int main(int argc, char **argv) {
555 struct cmdline_config config = {
558 .configfile = CONFIGFILE,
561 read_cmdline(argc, argv, &config);
563 if (config.test_config)
572 if ((status = configure_collectd(&config)) != 0)
579 struct sigaction sig_chld_action = {.sa_handler = SIG_IGN};
581 sigaction(SIGCHLD, &sig_chld_action, NULL);
584 * Only daemonize if we're not being supervised
585 * by upstart or systemd (when using Linux).
589 && notify_upstart() == 0 && notify_systemd() == 0
594 if ((pid = fork()) == -1) {
597 fprintf(stderr, "fork: %s", sstrerror(errno, errbuf, sizeof(errbuf)));
599 } else if (pid != 0) {
601 /* printf ("Running (PID %i)\n", pid); */
605 /* Detach from session */
609 if (pidfile_create())
612 /* close standard descriptors */
617 status = open("/dev/null", O_RDWR);
619 ERROR("Error: Could not connect `STDIN' to `/dev/null' (status %d)",
626 ERROR("Error: Could not connect `STDOUT' to `/dev/null' (status %d)",
633 ERROR("Error: Could not connect `STDERR' to `/dev/null', (status %d)",
637 } /* if (config.daemonize) */
638 #endif /* COLLECT_DAEMON */
640 struct sigaction sig_pipe_action = {.sa_handler = SIG_IGN};
642 sigaction(SIGPIPE, &sig_pipe_action, NULL);
645 * install signal handlers
647 struct sigaction sig_int_action = {.sa_handler = sig_int_handler};
649 if (0 != sigaction(SIGINT, &sig_int_action, NULL)) {
651 ERROR("Error: Failed to install a signal handler for signal INT: %s",
652 sstrerror(errno, errbuf, sizeof(errbuf)));
656 struct sigaction sig_term_action = {.sa_handler = sig_term_handler};
658 if (0 != sigaction(SIGTERM, &sig_term_action, NULL)) {
660 ERROR("Error: Failed to install a signal handler for signal TERM: %s",
661 sstrerror(errno, errbuf, sizeof(errbuf)));
665 struct sigaction sig_usr1_action = {.sa_handler = sig_usr1_handler};
667 if (0 != sigaction(SIGUSR1, &sig_usr1_action, NULL)) {
669 ERROR("Error: Failed to install a signal handler for signal USR1: %s",
670 sstrerror(errno, errbuf, sizeof(errbuf)));
675 * run the actual loops
677 if (do_init() != 0) {
678 ERROR("Error: one or more plugin init callbacks failed.");
682 if (config.test_readall) {
683 if (plugin_read_all_once() != 0) {
684 ERROR("Error: one or more plugin read callbacks failed.");
688 INFO("Initialization complete, entering read-loop.");
693 INFO("Exiting normally.");
695 if (do_shutdown() != 0) {
696 ERROR("Error: one or more plugin shutdown callbacks failed.");
701 if (config.daemonize)
703 #endif /* COLLECT_DAEMON */