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>
50 #ifndef COLLECTD_LOCALE
51 #define COLLECTD_LOCALE "C"
56 static void *do_flush(void __attribute__((unused)) * arg) {
57 INFO("Flushing all data.");
58 plugin_flush(/* plugin = */ NULL,
61 INFO("Finished flushing all data.");
66 static void sig_int_handler(int __attribute__((unused)) signal) { loop++; }
68 static void sig_term_handler(int __attribute__((unused)) signal) { loop++; }
70 static void sig_usr1_handler(int __attribute__((unused)) signal) {
74 /* flushing the data might take a while,
75 * so it should be done asynchronously */
76 pthread_attr_init(&attr);
77 pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED);
78 pthread_create(&thread, &attr, do_flush, NULL);
79 pthread_attr_destroy(&attr);
82 static int init_hostname(void) {
83 const char *str = global_option_get("Hostname");
84 if ((str != NULL) && (str[0] != 0)) {
89 long hostname_len = sysconf(_SC_HOST_NAME_MAX);
90 if (hostname_len == -1) {
91 hostname_len = NI_MAXHOST;
93 char hostname[hostname_len];
95 if (gethostname(hostname, hostname_len) != 0) {
96 fprintf(stderr, "`gethostname' failed and no "
97 "hostname was configured.\n");
101 hostname_set(hostname);
103 str = global_option_get("FQDNLookup");
107 struct addrinfo *ai_list;
108 struct addrinfo ai_hints = {.ai_flags = AI_CANONNAME};
110 int status = getaddrinfo(hostname, NULL, &ai_hints, &ai_list);
112 ERROR("Looking up \"%s\" failed. You have set the "
113 "\"FQDNLookup\" option, but I cannot resolve "
114 "my hostname to a fully qualified domain "
115 "name. Please fix the network "
121 for (struct addrinfo *ai_ptr = ai_list; ai_ptr != NULL;
122 ai_ptr = ai_ptr->ai_next) {
123 if (ai_ptr->ai_canonname == NULL)
126 hostname_set(ai_ptr->ai_canonname);
130 freeaddrinfo(ai_list);
132 } /* int init_hostname */
134 static int init_global_variables(void) {
137 interval_g = cf_get_default_interval();
138 assert(interval_g > 0);
139 DEBUG("interval_g = %.3f;", CDTIME_T_TO_DOUBLE(interval_g));
141 str = global_option_get("Timeout");
144 timeout_g = atoi(str);
145 if (timeout_g <= 1) {
146 fprintf(stderr, "Cannot set the timeout to a correct value.\n"
147 "Please check your settings.\n");
150 DEBUG("timeout_g = %i;", timeout_g);
152 if (init_hostname() != 0)
154 DEBUG("hostname_g = %s;", hostname_g);
157 } /* int init_global_variables */
159 static int change_basedir(const char *orig_dir, _Bool create) {
164 dir = strdup(orig_dir);
167 ERROR("strdup failed: %s", sstrerror(errno, errbuf, sizeof(errbuf)));
171 dirlen = strlen(dir);
172 while ((dirlen > 0) && (dir[dirlen - 1] == '/'))
173 dir[--dirlen] = '\0';
184 } else if (!create || (errno != ENOENT)) {
186 ERROR("change_basedir: chdir (%s): %s", dir,
187 sstrerror(errno, errbuf, sizeof(errbuf)));
192 status = mkdir(dir, S_IRWXU | S_IRWXG | S_IRWXO);
195 ERROR("change_basedir: mkdir (%s): %s", dir,
196 sstrerror(errno, errbuf, sizeof(errbuf)));
204 ERROR("change_basedir: chdir (%s): %s", dir,
205 sstrerror(errno, errbuf, sizeof(errbuf)));
212 } /* static int change_basedir (char *dir) */
215 extern kstat_ctl_t *kc;
216 static void update_kstat(void) {
218 if ((kc = kstat_open()) == NULL)
219 ERROR("Unable to open kstat control structure");
222 kid = kstat_chain_update(kc);
224 INFO("kstat chain has been updated");
227 ERROR("kstat chain update failed");
228 /* else: everything works as expected */
232 } /* static void update_kstat (void) */
233 #endif /* HAVE_LIBKSTAT */
236 * Remove all settings but `-f' and `-C'
238 __attribute__((noreturn)) static void exit_usage(int status) {
239 printf("Usage: " PACKAGE_NAME " [OPTIONS]\n\n"
241 "Available options:\n"
243 " -C <file> Configuration file.\n"
244 " Default: " CONFIGFILE "\n"
245 " -t Test config and exit.\n"
246 " -T Test plugin read and exit.\n"
247 " -P <file> PID-file.\n"
248 " Default: " PIDFILE "\n"
250 " -f Don't fork to the background.\n"
252 " -B Don't create the BaseDir\n"
253 " -h Display help (this message)\n"
254 "\nBuiltin defaults:\n"
255 " Config file " CONFIGFILE "\n"
256 " PID file " PIDFILE "\n"
257 " Plugin directory " PLUGINDIR "\n"
258 " Data directory " PKGLOCALSTATEDIR "\n"
259 "\n" PACKAGE_NAME " " PACKAGE_VERSION ", http://collectd.org/\n"
260 "by Florian octo Forster <octo@collectd.org>\n"
261 "for contributions see `AUTHORS'\n");
263 } /* static void exit_usage (int status) */
265 static int do_init(void) {
267 if (setlocale(LC_NUMERIC, COLLECTD_LOCALE) == NULL)
268 WARNING("setlocale (\"%s\") failed.", COLLECTD_LOCALE);
270 /* Update the environment, so that libraries that are calling
271 * setlocale(LC_NUMERIC, "") don't accidentally revert these changes. */
273 setenv("LC_NUMERIC", COLLECTD_LOCALE, /* overwrite = */ 1);
283 #if HAVE_LIBSTATGRAB_0_90
287 ERROR("sg_init: %s", sg_str_error(sg_get_error()));
291 if (sg_drop_privileges()) {
292 ERROR("sg_drop_privileges: %s", sg_str_error(sg_get_error()));
297 return plugin_init_all();
298 } /* int do_init () */
300 static int do_loop(void) {
301 cdtime_t interval = cf_get_default_interval();
304 wait_until = cdtime() + interval;
313 /* Issue all plugins */
317 if (now >= wait_until) {
318 WARNING("Not sleeping because the next interval is "
319 "%.3f seconds in the past!",
320 CDTIME_T_TO_DOUBLE(now - wait_until));
321 wait_until = now + interval;
325 struct timespec ts_wait = CDTIME_T_TO_TIMESPEC(wait_until - now);
326 wait_until = wait_until + interval;
328 while ((loop == 0) && (nanosleep(&ts_wait, &ts_wait) != 0)) {
329 if (errno != EINTR) {
331 ERROR("nanosleep failed: %s", sstrerror(errno, errbuf, sizeof(errbuf)));
335 } /* while (loop == 0) */
340 static int do_shutdown(void) {
341 return plugin_shutdown_all();
342 } /* int do_shutdown */
345 static int pidfile_create(void) {
347 const char *file = global_option_get("PIDFile");
349 if ((fh = fopen(file, "w")) == NULL) {
351 ERROR("fopen (%s): %s", file, sstrerror(errno, errbuf, sizeof(errbuf)));
355 fprintf(fh, "%i\n", (int)getpid());
359 } /* static int pidfile_create (const char *file) */
361 static int pidfile_remove(void) {
362 const char *file = global_option_get("PIDFile");
367 } /* static int pidfile_remove (const char *file) */
368 #endif /* COLLECT_DAEMON */
371 static int notify_upstart(void) {
372 char const *upstart_job = getenv("UPSTART_JOB");
374 if (upstart_job == NULL)
377 if (strcmp(upstart_job, "collectd") != 0) {
378 WARNING("Environment specifies unexpected UPSTART_JOB=\"%s\", expected "
379 "\"collectd\". Ignoring the variable.",
384 NOTICE("Upstart detected, stopping now to signal readyness.");
386 unsetenv("UPSTART_JOB");
391 static int notify_systemd(void) {
393 const char *notifysocket;
394 struct sockaddr_un su = {0};
396 char buffer[] = "READY=1\n";
398 notifysocket = getenv("NOTIFY_SOCKET");
399 if (notifysocket == NULL)
402 if ((strlen(notifysocket) < 2) ||
403 ((notifysocket[0] != '@') && (notifysocket[0] != '/'))) {
404 ERROR("invalid notification socket NOTIFY_SOCKET=\"%s\": path must be "
409 NOTICE("Systemd detected, trying to signal readyness.");
411 unsetenv("NOTIFY_SOCKET");
413 #if defined(SOCK_CLOEXEC)
414 fd = socket(AF_UNIX, SOCK_DGRAM | SOCK_CLOEXEC, /* protocol = */ 0);
416 fd = socket(AF_UNIX, SOCK_DGRAM, /* protocol = */ 0);
420 ERROR("creating UNIX socket failed: %s",
421 sstrerror(errno, errbuf, sizeof(errbuf)));
425 su.sun_family = AF_UNIX;
426 if (notifysocket[0] != '@') {
427 /* regular UNIX socket */
428 sstrncpy(su.sun_path, notifysocket, sizeof(su.sun_path));
429 su_size = sizeof(su);
431 /* Linux abstract namespace socket: specify address as "\0foo", i.e.
432 * start with a null byte. Since null bytes have no special meaning in
433 * that case, we have to set su_size correctly to cover only the bytes
434 * that are part of the address. */
435 sstrncpy(su.sun_path, notifysocket, sizeof(su.sun_path));
437 su_size = sizeof(sa_family_t) + strlen(notifysocket);
438 if (su_size > sizeof(su))
439 su_size = sizeof(su);
442 if (sendto(fd, buffer, strlen(buffer), MSG_NOSIGNAL, (void *)&su,
443 (socklen_t)su_size) < 0) {
445 ERROR("sendto(\"%s\") failed: %s", notifysocket,
446 sstrerror(errno, errbuf, sizeof(errbuf)));
451 unsetenv("NOTIFY_SOCKET");
455 #endif /* KERNEL_LINUX */
457 struct cmdline_config {
460 _Bool create_basedir;
461 const char *configfile;
465 void read_cmdline(int argc, char **argv, struct cmdline_config *config) {
469 c = getopt(argc, argv, "htTC:"
480 config->create_basedir = 0;
483 config->configfile = optarg;
486 config->test_config = 1;
489 config->test_readall = 1;
490 global_option_set("ReadThreads", "-1", 1);
492 config->daemonize = 0;
493 #endif /* COLLECT_DAEMON */
497 global_option_set("PIDFile", optarg, 1);
500 config->daemonize = 0;
502 #endif /* COLLECT_DAEMON */
512 int configure_collectd(struct cmdline_config *config) {
515 * Read options from the config file, the environment and the command
516 * line (in that order, with later options overwriting previous ones in
518 * Also, this will automatically load modules.
520 if (cf_read(config->configfile)) {
521 fprintf(stderr, "Error: Reading the config file failed!\n"
522 "Read the logs for details.\n");
527 * Change directory. We do this _after_ reading the config and loading
528 * modules to relative paths work as expected.
530 if ((basedir = global_option_get("BaseDir")) == NULL) {
532 "Don't have a basedir to use. This should not happen. Ever.");
534 } else if (change_basedir(basedir, config->create_basedir)) {
535 fprintf(stderr, "Error: Unable to change to directory `%s'.\n", basedir);
540 * Set global variables or, if that fails, exit. We cannot run with
541 * them being uninitialized. If nothing is configured, then defaults
542 * are being used. So this means that the user has actually done
545 if (init_global_variables() != 0)
551 int main(int argc, char **argv) {
557 struct cmdline_config config = {
558 .daemonize = 1, .create_basedir = 1, .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 */