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);
162 ERROR("strdup failed: %s", STRERRNO);
166 dirlen = strlen(dir);
167 while ((dirlen > 0) && (dir[dirlen - 1] == '/'))
168 dir[--dirlen] = '\0';
179 } else if (!create || (errno != ENOENT)) {
180 ERROR("change_basedir: chdir (%s): %s", dir, STRERRNO);
185 status = mkdir(dir, S_IRWXU | S_IRWXG | S_IRWXO);
187 ERROR("change_basedir: mkdir (%s): %s", dir, STRERRNO);
194 ERROR("change_basedir: chdir (%s): %s", dir, STRERRNO);
201 } /* static int change_basedir (char *dir) */
204 static void update_kstat(void) {
206 if ((kc = kstat_open()) == NULL)
207 ERROR("Unable to open kstat control structure");
210 kid = kstat_chain_update(kc);
212 INFO("kstat chain has been updated");
215 ERROR("kstat chain update failed");
216 /* else: everything works as expected */
220 } /* static void update_kstat (void) */
221 #endif /* HAVE_LIBKSTAT */
224 * Remove all settings but `-f' and `-C'
226 __attribute__((noreturn)) static void exit_usage(int status) {
227 printf("Usage: " PACKAGE_NAME " [OPTIONS]\n\n"
229 "Available options:\n"
231 " -C <file> Configuration file.\n"
232 " Default: " CONFIGFILE "\n"
233 " -t Test config and exit.\n"
234 " -T Test plugin read and exit.\n"
235 " -P <file> PID-file.\n"
236 " Default: " PIDFILE "\n"
238 " -f Don't fork to the background.\n"
240 " -B Don't create the BaseDir\n"
241 " -h Display help (this message)\n"
242 "\nBuiltin defaults:\n"
243 " Config file " CONFIGFILE "\n"
244 " PID file " PIDFILE "\n"
245 " Plugin directory " PLUGINDIR "\n"
246 " Data directory " PKGLOCALSTATEDIR "\n"
247 "\n" PACKAGE_NAME " " PACKAGE_VERSION ", http://collectd.org/\n"
248 "by Florian octo Forster <octo@collectd.org>\n"
249 "for contributions see `AUTHORS'\n");
251 } /* static void exit_usage (int status) */
253 static int do_init(void) {
255 if (setlocale(LC_NUMERIC, COLLECTD_LOCALE) == NULL)
256 WARNING("setlocale (\"%s\") failed.", COLLECTD_LOCALE);
258 /* Update the environment, so that libraries that are calling
259 * setlocale(LC_NUMERIC, "") don't accidentally revert these changes. */
261 setenv("LC_NUMERIC", COLLECTD_LOCALE, /* overwrite = */ 1);
271 #if HAVE_LIBSTATGRAB_0_90
275 ERROR("sg_init: %s", sg_str_error(sg_get_error()));
279 if (sg_drop_privileges()) {
280 ERROR("sg_drop_privileges: %s", sg_str_error(sg_get_error()));
285 return plugin_init_all();
286 } /* int do_init () */
288 static int do_loop(void) {
289 cdtime_t interval = cf_get_default_interval();
292 wait_until = cdtime() + interval;
301 /* Issue all plugins */
305 if (now >= wait_until) {
306 WARNING("Not sleeping because the next interval is "
307 "%.3f seconds in the past!",
308 CDTIME_T_TO_DOUBLE(now - wait_until));
309 wait_until = now + interval;
313 struct timespec ts_wait = CDTIME_T_TO_TIMESPEC(wait_until - now);
314 wait_until = wait_until + interval;
316 while ((loop == 0) && (nanosleep(&ts_wait, &ts_wait) != 0)) {
317 if (errno != EINTR) {
318 ERROR("nanosleep failed: %s", STRERRNO);
322 } /* while (loop == 0) */
327 static int do_shutdown(void) {
328 return plugin_shutdown_all();
329 } /* int do_shutdown */
332 static int pidfile_create(void) {
334 const char *file = global_option_get("PIDFile");
336 if ((fh = fopen(file, "w")) == NULL) {
337 ERROR("fopen (%s): %s", file, STRERRNO);
341 fprintf(fh, "%i\n", (int)getpid());
345 } /* static int pidfile_create (const char *file) */
347 static int pidfile_remove(void) {
348 const char *file = global_option_get("PIDFile");
353 } /* static int pidfile_remove (const char *file) */
354 #endif /* COLLECT_DAEMON */
357 static int notify_upstart(void) {
358 char const *upstart_job = getenv("UPSTART_JOB");
360 if (upstart_job == NULL)
363 if (strcmp(upstart_job, "collectd") != 0) {
364 WARNING("Environment specifies unexpected UPSTART_JOB=\"%s\", expected "
365 "\"collectd\". Ignoring the variable.",
370 NOTICE("Upstart detected, stopping now to signal readiness.");
372 unsetenv("UPSTART_JOB");
377 static int notify_systemd(void) {
379 const char *notifysocket;
380 struct sockaddr_un su = {0};
382 char buffer[] = "READY=1\n";
384 notifysocket = getenv("NOTIFY_SOCKET");
385 if (notifysocket == NULL)
388 if ((strlen(notifysocket) < 2) ||
389 ((notifysocket[0] != '@') && (notifysocket[0] != '/'))) {
390 ERROR("invalid notification socket NOTIFY_SOCKET=\"%s\": path must be "
395 NOTICE("Systemd detected, trying to signal readiness.");
397 unsetenv("NOTIFY_SOCKET");
399 #if defined(SOCK_CLOEXEC)
400 fd = socket(AF_UNIX, SOCK_DGRAM | SOCK_CLOEXEC, /* protocol = */ 0);
402 fd = socket(AF_UNIX, SOCK_DGRAM, /* protocol = */ 0);
405 ERROR("creating UNIX socket failed: %s", STRERRNO);
409 su.sun_family = AF_UNIX;
410 if (notifysocket[0] != '@') {
411 /* regular UNIX socket */
412 sstrncpy(su.sun_path, notifysocket, sizeof(su.sun_path));
413 su_size = sizeof(su);
415 /* Linux abstract namespace socket: specify address as "\0foo", i.e.
416 * start with a null byte. Since null bytes have no special meaning in
417 * that case, we have to set su_size correctly to cover only the bytes
418 * that are part of the address. */
419 sstrncpy(su.sun_path, notifysocket, sizeof(su.sun_path));
421 su_size = sizeof(sa_family_t) + strlen(notifysocket);
422 if (su_size > sizeof(su))
423 su_size = sizeof(su);
426 if (sendto(fd, buffer, strlen(buffer), MSG_NOSIGNAL, (void *)&su,
427 (socklen_t)su_size) < 0) {
428 ERROR("sendto(\"%s\") failed: %s", notifysocket, STRERRNO);
433 unsetenv("NOTIFY_SOCKET");
437 #endif /* KERNEL_LINUX */
439 struct cmdline_config {
442 _Bool create_basedir;
443 const char *configfile;
447 void read_cmdline(int argc, char **argv, struct cmdline_config *config) {
451 c = getopt(argc, argv, "htTC:"
462 config->create_basedir = 0;
465 config->configfile = optarg;
468 config->test_config = 1;
471 config->test_readall = 1;
472 global_option_set("ReadThreads", "-1", 1);
474 config->daemonize = 0;
475 #endif /* COLLECT_DAEMON */
479 global_option_set("PIDFile", optarg, 1);
482 config->daemonize = 0;
484 #endif /* COLLECT_DAEMON */
494 int configure_collectd(struct cmdline_config *config) {
497 * Read options from the config file, the environment and the command
498 * line (in that order, with later options overwriting previous ones in
500 * Also, this will automatically load modules.
502 if (cf_read(config->configfile)) {
503 fprintf(stderr, "Error: Reading the config file failed!\n"
504 "Read the logs for details.\n");
509 * Change directory. We do this _after_ reading the config and loading
510 * modules to relative paths work as expected.
512 if ((basedir = global_option_get("BaseDir")) == NULL) {
514 "Don't have a basedir to use. This should not happen. Ever.");
516 } else if (change_basedir(basedir, config->create_basedir)) {
517 fprintf(stderr, "Error: Unable to change to directory `%s'.\n", basedir);
522 * Set global variables or, if that fails, exit. We cannot run with
523 * them being uninitialized. If nothing is configured, then defaults
524 * are being used. So this means that the user has actually done
527 if (init_global_variables() != 0)
533 int main(int argc, char **argv) {
539 struct cmdline_config config = {
540 .daemonize = 1, .create_basedir = 1, .configfile = CONFIGFILE,
543 read_cmdline(argc, argv, &config);
545 if (config.test_config)
554 if ((status = configure_collectd(&config)) != 0)
561 struct sigaction sig_chld_action = {.sa_handler = SIG_IGN};
563 sigaction(SIGCHLD, &sig_chld_action, NULL);
566 * Only daemonize if we're not being supervised
567 * by upstart or systemd (when using Linux).
571 && notify_upstart() == 0 && notify_systemd() == 0
576 if ((pid = fork()) == -1) {
578 fprintf(stderr, "fork: %s", STRERRNO);
580 } else if (pid != 0) {
582 /* printf ("Running (PID %i)\n", pid); */
586 /* Detach from session */
590 if (pidfile_create())
593 /* close standard descriptors */
598 status = open("/dev/null", O_RDWR);
600 ERROR("Error: Could not connect `STDIN' to `/dev/null' (status %d)",
607 ERROR("Error: Could not connect `STDOUT' to `/dev/null' (status %d)",
614 ERROR("Error: Could not connect `STDERR' to `/dev/null', (status %d)",
618 } /* if (config.daemonize) */
619 #endif /* COLLECT_DAEMON */
621 struct sigaction sig_pipe_action = {.sa_handler = SIG_IGN};
623 sigaction(SIGPIPE, &sig_pipe_action, NULL);
626 * install signal handlers
628 struct sigaction sig_int_action = {.sa_handler = sig_int_handler};
630 if (0 != sigaction(SIGINT, &sig_int_action, NULL)) {
631 ERROR("Error: Failed to install a signal handler for signal INT: %s",
636 struct sigaction sig_term_action = {.sa_handler = sig_term_handler};
638 if (0 != sigaction(SIGTERM, &sig_term_action, NULL)) {
639 ERROR("Error: Failed to install a signal handler for signal TERM: %s",
644 struct sigaction sig_usr1_action = {.sa_handler = sig_usr1_handler};
646 if (0 != sigaction(SIGUSR1, &sig_usr1_action, NULL)) {
647 ERROR("Error: Failed to install a signal handler for signal USR1: %s",
653 * run the actual loops
655 if (do_init() != 0) {
656 ERROR("Error: one or more plugin init callbacks failed.");
660 if (config.test_readall) {
661 if (plugin_read_all_once() != 0) {
662 ERROR("Error: one or more plugin read callbacks failed.");
666 INFO("Initialization complete, entering read-loop.");
671 INFO("Exiting normally.");
673 if (do_shutdown() != 0) {
674 ERROR("Error: one or more plugin shutdown callbacks failed.");
679 if (config.daemonize)
681 #endif /* COLLECT_DAEMON */