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 && 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; ai_ptr = ai_ptr->ai_next) {
122 if (ai_ptr->ai_canonname == NULL)
125 hostname_set(ai_ptr->ai_canonname);
129 freeaddrinfo(ai_list);
131 } /* int init_hostname */
133 static int init_global_variables(void) {
134 interval_g = cf_get_default_interval();
135 assert(interval_g > 0);
136 DEBUG("interval_g = %.3f;", CDTIME_T_TO_DOUBLE(interval_g));
138 const char *str = global_option_get("Timeout");
141 timeout_g = atoi(str);
142 if (timeout_g <= 1) {
143 fprintf(stderr, "Cannot set the timeout to a correct value.\n"
144 "Please check your settings.\n");
147 DEBUG("timeout_g = %i;", timeout_g);
149 if (init_hostname() != 0)
151 DEBUG("hostname_g = %s;", hostname_g);
154 } /* int init_global_variables */
156 static int change_basedir(const char *orig_dir, bool create) {
157 char *dir = strdup(orig_dir);
159 ERROR("strdup failed: %s", STRERRNO);
163 size_t dirlen = strlen(dir);
164 while ((dirlen > 0) && (dir[dirlen - 1] == '/'))
165 dir[--dirlen] = '\0';
172 int status = chdir(dir);
176 } else if (!create || (errno != ENOENT)) {
177 ERROR("change_basedir: chdir (%s): %s", dir, STRERRNO);
182 status = mkdir(dir, S_IRWXU | S_IRWXG | S_IRWXO);
184 ERROR("change_basedir: mkdir (%s): %s", dir, STRERRNO);
191 ERROR("change_basedir: chdir (%s): %s", dir, STRERRNO);
198 } /* static int change_basedir (char *dir) */
201 extern kstat_ctl_t *kc;
202 static void update_kstat(void) {
204 if ((kc = kstat_open()) == NULL)
205 ERROR("Unable to open kstat control structure");
207 kid_t kid = kstat_chain_update(kc);
209 INFO("kstat chain has been updated");
212 ERROR("kstat chain update failed");
213 /* else: everything works as expected */
217 } /* static void update_kstat (void) */
218 #endif /* HAVE_LIBKSTAT */
220 __attribute__((noreturn)) static void exit_usage(int status) {
221 printf("Usage: " PACKAGE_NAME " [OPTIONS]\n\n"
223 "Available options:\n"
225 " -C <file> Configuration file.\n"
226 " Default: " CONFIGFILE "\n"
227 " -t Test config and exit.\n"
228 " -T Test plugin read and exit.\n"
229 " -P <file> PID-file.\n"
230 " Default: " PIDFILE "\n"
232 " -f Don't fork to the background.\n"
234 " -B Don't create the BaseDir\n"
235 " -h Display help (this message)\n"
236 "\nBuiltin defaults:\n"
237 " Config file " CONFIGFILE "\n"
238 " PID file " PIDFILE "\n"
239 " Plugin directory " PLUGINDIR "\n"
240 " Data directory " PKGLOCALSTATEDIR "\n"
241 "\n" PACKAGE_NAME " " PACKAGE_VERSION ", http://collectd.org/\n"
242 "by Florian octo Forster <octo@collectd.org>\n"
243 "for contributions see `AUTHORS'\n");
245 } /* static void exit_usage (int status) */
247 static int do_init(void) {
249 if (setlocale(LC_NUMERIC, COLLECTD_LOCALE) == NULL)
250 WARNING("setlocale (\"%s\") failed.", COLLECTD_LOCALE);
252 /* Update the environment, so that libraries that are calling
253 * setlocale(LC_NUMERIC, "") don't accidentally revert these changes. */
255 setenv("LC_NUMERIC", COLLECTD_LOCALE, /* overwrite = */ 1);
265 #if HAVE_LIBSTATGRAB_0_90
269 ERROR("sg_init: %s", sg_str_error(sg_get_error()));
273 if (sg_drop_privileges()) {
274 ERROR("sg_drop_privileges: %s", sg_str_error(sg_get_error()));
279 return plugin_init_all();
280 } /* int do_init () */
282 static int do_loop(void) {
283 cdtime_t interval = cf_get_default_interval();
284 cdtime_t wait_until = cdtime() + interval;
291 /* Issue all plugins */
294 cdtime_t now = cdtime();
295 if (now >= wait_until) {
296 WARNING("Not sleeping because the next interval is "
297 "%.3f seconds in the past!",
298 CDTIME_T_TO_DOUBLE(now - wait_until));
299 wait_until = now + interval;
303 struct timespec ts_wait = CDTIME_T_TO_TIMESPEC(wait_until - now);
304 wait_until = wait_until + interval;
306 while ((loop == 0) && (nanosleep(&ts_wait, &ts_wait) != 0)) {
307 if (errno != EINTR) {
308 ERROR("nanosleep failed: %s", STRERRNO);
312 } /* while (loop == 0) */
317 static int do_shutdown(void) {
318 return plugin_shutdown_all();
319 } /* int do_shutdown */
322 static int pidfile_create(void) {
324 const char *file = global_option_get("PIDFile");
326 if ((fh = fopen(file, "w")) == NULL) {
327 ERROR("fopen (%s): %s", file, STRERRNO);
331 fprintf(fh, "%i\n", (int)getpid());
335 } /* static int pidfile_create (const char *file) */
337 static int pidfile_remove(void) {
338 const char *file = global_option_get("PIDFile");
343 } /* static int pidfile_remove (const char *file) */
344 #endif /* COLLECT_DAEMON */
347 static int notify_upstart(void) {
348 char const *upstart_job = getenv("UPSTART_JOB");
350 if (upstart_job == NULL)
353 if (strcmp(upstart_job, "collectd") != 0) {
354 WARNING("Environment specifies unexpected UPSTART_JOB=\"%s\", expected "
355 "\"collectd\". Ignoring the variable.",
360 NOTICE("Upstart detected, stopping now to signal readiness.");
362 unsetenv("UPSTART_JOB");
367 static int notify_systemd(void) {
369 const char *notifysocket = getenv("NOTIFY_SOCKET");
370 if (notifysocket == NULL)
373 if ((strlen(notifysocket) < 2) ||
374 ((notifysocket[0] != '@') && (notifysocket[0] != '/'))) {
375 ERROR("invalid notification socket NOTIFY_SOCKET=\"%s\": path must be "
380 NOTICE("Systemd detected, trying to signal readiness.");
382 unsetenv("NOTIFY_SOCKET");
385 #if defined(SOCK_CLOEXEC)
386 fd = socket(AF_UNIX, SOCK_DGRAM | SOCK_CLOEXEC, /* protocol = */ 0);
388 fd = socket(AF_UNIX, SOCK_DGRAM, /* protocol = */ 0);
391 ERROR("creating UNIX socket failed: %s", STRERRNO);
395 struct sockaddr_un su = {0};
396 su.sun_family = AF_UNIX;
397 if (notifysocket[0] != '@') {
398 /* regular UNIX socket */
399 sstrncpy(su.sun_path, notifysocket, sizeof(su.sun_path));
400 su_size = sizeof(su);
402 /* Linux abstract namespace socket: specify address as "\0foo", i.e.
403 * start with a null byte. Since null bytes have no special meaning in
404 * that case, we have to set su_size correctly to cover only the bytes
405 * that are part of the address. */
406 sstrncpy(su.sun_path, notifysocket, sizeof(su.sun_path));
408 su_size = sizeof(sa_family_t) + strlen(notifysocket);
409 if (su_size > sizeof(su))
410 su_size = sizeof(su);
413 const char buffer[] = "READY=1\n";
414 if (sendto(fd, buffer, strlen(buffer), MSG_NOSIGNAL, (void *)&su,
415 (socklen_t)su_size) < 0) {
416 ERROR("sendto(\"%s\") failed: %s", notifysocket, STRERRNO);
421 unsetenv("NOTIFY_SOCKET");
425 #endif /* KERNEL_LINUX */
427 struct cmdline_config {
431 const char *configfile;
435 static void read_cmdline(int argc, char **argv, struct cmdline_config *config) {
438 int c = getopt(argc, argv, "htTC:"
449 config->create_basedir = false;
452 config->configfile = optarg;
455 config->test_config = true;
458 config->test_readall = true;
459 global_option_set("ReadThreads", "-1", 1);
461 config->daemonize = false;
462 #endif /* COLLECT_DAEMON */
466 global_option_set("PIDFile", optarg, 1);
469 config->daemonize = false;
471 #endif /* COLLECT_DAEMON */
480 static int configure_collectd(struct cmdline_config *config) {
482 * Read options from the config file, the environment and the command
483 * line (in that order, with later options overwriting previous ones in
485 * Also, this will automatically load modules.
487 if (cf_read(config->configfile)) {
488 fprintf(stderr, "Error: Reading the config file failed!\n"
489 "Read the logs for details.\n");
494 * Change directory. We do this _after_ reading the config and loading
495 * modules to relative paths work as expected.
498 if ((basedir = global_option_get("BaseDir")) == NULL) {
500 "Don't have a basedir to use. This should not happen. Ever.");
502 } else if (change_basedir(basedir, config->create_basedir)) {
503 fprintf(stderr, "Error: Unable to change to directory `%s'.\n", basedir);
508 * Set global variables or, if that fails, exit. We cannot run with
509 * them being uninitialized. If nothing is configured, then defaults
510 * are being used. So this means that the user has actually done
513 if (init_global_variables() != 0)
519 int main(int argc, char **argv) {
522 struct cmdline_config config = {
523 .daemonize = true, .create_basedir = true, .configfile = CONFIGFILE,
526 read_cmdline(argc, argv, &config);
528 if (config.test_config)
536 if (configure_collectd(&config) != 0)
543 struct sigaction sig_chld_action = {.sa_handler = SIG_IGN};
545 sigaction(SIGCHLD, &sig_chld_action, NULL);
548 * Only daemonize if we're not being supervised
549 * by upstart or systemd (when using Linux).
553 && notify_upstart() == 0 && notify_systemd() == 0
557 if ((pid = fork()) == -1) {
559 fprintf(stderr, "fork: %s", STRERRNO);
561 } else if (pid != 0) {
563 /* printf ("Running (PID %i)\n", pid); */
567 /* Detach from session */
571 if (pidfile_create())
574 /* close standard descriptors */
579 int status = open("/dev/null", O_RDWR);
581 ERROR("Error: Could not connect `STDIN' to `/dev/null' (status %d)",
588 ERROR("Error: Could not connect `STDOUT' to `/dev/null' (status %d)",
595 ERROR("Error: Could not connect `STDERR' to `/dev/null', (status %d)",
599 } /* if (config.daemonize) */
600 #endif /* COLLECT_DAEMON */
602 struct sigaction sig_pipe_action = {.sa_handler = SIG_IGN};
604 sigaction(SIGPIPE, &sig_pipe_action, NULL);
607 * install signal handlers
609 struct sigaction sig_int_action = {.sa_handler = sig_int_handler};
611 if (sigaction(SIGINT, &sig_int_action, NULL) != 0) {
612 ERROR("Error: Failed to install a signal handler for signal INT: %s",
617 struct sigaction sig_term_action = {.sa_handler = sig_term_handler};
619 if (sigaction(SIGTERM, &sig_term_action, NULL) != 0) {
620 ERROR("Error: Failed to install a signal handler for signal TERM: %s",
625 struct sigaction sig_usr1_action = {.sa_handler = sig_usr1_handler};
627 if (sigaction(SIGUSR1, &sig_usr1_action, NULL) != 0) {
628 ERROR("Error: Failed to install a signal handler for signal USR1: %s",
634 * run the actual loops
636 if (do_init() != 0) {
637 ERROR("Error: one or more plugin init callbacks failed.");
641 if (config.test_readall) {
642 if (plugin_read_all_once() != 0) {
643 ERROR("Error: one or more plugin read callbacks failed.");
647 INFO("Initialization complete, entering read-loop.");
652 INFO("Exiting normally.");
654 if (do_shutdown() != 0) {
655 ERROR("Error: one or more plugin shutdown callbacks failed.");
660 if (config.daemonize)
662 #endif /* COLLECT_DAEMON */