src/daemon/collectd.c

   1 /**
   2  * collectd - src/collectd.c
   3  * Copyright (C) 2005-2007  Florian octo Forster
   4  *
   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:
  11  *
  12  * The above copyright notice and this permission notice shall be included in
  13  * all copies or substantial portions of the Software.
  14  *
  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.
  22  *
  23  * Authors:
  24  *   Florian octo Forster <octo at collectd.org>
  25  *   Alvaro Barcellos <alvaro.barcellos at gmail.com>
  26  **/
  27
  28 #include "collectd.h"
  29 #include "common.h"
  30
  31 #include "plugin.h"
  32 #include "configfile.h"
  33
  34 #include <sys/types.h>
  35 #include <sys/socket.h>
  36 #include <sys/un.h>
  37 #include <netdb.h>
  38
  39 #include <pthread.h>
  40
  41 #if HAVE_LOCALE_H
  42 # include <locale.h>
  43 #endif
  44
  45 #if HAVE_STATGRAB_H
  46 # include <statgrab.h>
  47 #endif
  48
  49 #ifndef COLLECTD_LOCALE
  50 # define COLLECTD_LOCALE "C"
  51 #endif
  52
  53 /*
  54  * Global variables
  55  */
  56 char hostname_g[DATA_MAX_NAME_LEN];
  57 cdtime_t interval_g;
  58 int  pidfile_from_cli = 0;
  59 int  timeout_g;
  60 #if HAVE_LIBKSTAT
  61 kstat_ctl_t *kc;
  62 #endif /* HAVE_LIBKSTAT */
  63
  64 static int loop = 0;
  65
  66 static void *do_flush (void __attribute__((unused)) *arg)
  67 {
  68         INFO ("Flushing all data.");
  69         plugin_flush (/* plugin = */ NULL,
  70                         /* timeout = */ 0,
  71                         /* ident = */ NULL);
  72         INFO ("Finished flushing all data.");
  73         pthread_exit (NULL);
  74         return NULL;
  75 }
  76
  77 static void sig_int_handler (int __attribute__((unused)) signal)
  78 {
  79         loop++;
  80 }
  81
  82 static void sig_term_handler (int __attribute__((unused)) signal)
  83 {
  84         loop++;
  85 }
  86
  87 static void sig_usr1_handler (int __attribute__((unused)) signal)
  88 {
  89         pthread_t      thread;
  90         pthread_attr_t attr;
  91
  92         /* flushing the data might take a while,
  93          * so it should be done asynchronously */
  94         pthread_attr_init (&attr);
  95         pthread_attr_setdetachstate (&attr, PTHREAD_CREATE_DETACHED);
  96         pthread_create (&thread, &attr, do_flush, NULL);
  97         pthread_attr_destroy (&attr);
  98 }
  99
 100 static int init_hostname (void)
 101 {
 102         const char *str;
 103
 104         struct addrinfo  ai_hints;
 105         struct addrinfo *ai_list;
 106         struct addrinfo *ai_ptr;
 107         int status;
 108
 109         str = global_option_get ("Hostname");
 110         if (str != NULL)
 111         {
 112                 sstrncpy (hostname_g, str, sizeof (hostname_g));
 113                 return (0);
 114         }
 115
 116         if (gethostname (hostname_g, sizeof (hostname_g)) != 0)
 117         {
 118                 fprintf (stderr, "`gethostname' failed and no "
 119                                 "hostname was configured.\n");
 120                 return (-1);
 121         }
 122
 123         str = global_option_get ("FQDNLookup");
 124         if (IS_FALSE (str))
 125                 return (0);
 126
 127         memset (&ai_hints, '\0', sizeof (ai_hints));
 128         ai_hints.ai_flags = AI_CANONNAME;
 129
 130         status = getaddrinfo (hostname_g, NULL, &ai_hints, &ai_list);
 131         if (status != 0)
 132         {
 133                 ERROR ("Looking up \"%s\" failed. You have set the "
 134                                 "\"FQDNLookup\" option, but I cannot resolve "
 135                                 "my hostname to a fully qualified domain "
 136                                 "name. Please fix the network "
 137                                 "configuration.", hostname_g);
 138                 return (-1);
 139         }
 140
 141         for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
 142         {
 143                 if (ai_ptr->ai_canonname == NULL)
 144                         continue;
 145
 146                 sstrncpy (hostname_g, ai_ptr->ai_canonname, sizeof (hostname_g));
 147                 break;
 148         }
 149
 150         freeaddrinfo (ai_list);
 151         return (0);
 152 } /* int init_hostname */
 153
 154 static int init_global_variables (void)
 155 {
 156         char const *str;
 157
 158         interval_g = cf_get_default_interval ();
 159         assert (interval_g > 0);
 160         DEBUG ("interval_g = %.3f;", CDTIME_T_TO_DOUBLE (interval_g));
 161
 162         str = global_option_get ("Timeout");
 163         if (str == NULL)
 164                 str = "2";
 165         timeout_g = atoi (str);
 166         if (timeout_g <= 1)
 167         {
 168                 fprintf (stderr, "Cannot set the timeout to a correct value.\n"
 169                                 "Please check your settings.\n");
 170                 return (-1);
 171         }
 172         DEBUG ("timeout_g = %i;", timeout_g);
 173
 174         if (init_hostname () != 0)
 175                 return (-1);
 176         DEBUG ("hostname_g = %s;", hostname_g);
 177
 178         return (0);
 179 } /* int init_global_variables */
 180
 181 static int change_basedir (const char *orig_dir)
 182 {
 183         char *dir;
 184         size_t dirlen;
 185         int status;
 186
 187         dir = strdup (orig_dir);
 188         if (dir == NULL)
 189         {
 190                 char errbuf[1024];
 191                 ERROR ("strdup failed: %s",
 192                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 193                 return (-1);
 194         }
 195
 196         dirlen = strlen (dir);
 197         while ((dirlen > 0) && (dir[dirlen - 1] == '/'))
 198                 dir[--dirlen] = '\0';
 199
 200         if (dirlen <= 0)
 201                 return (-1);
 202
 203         status = chdir (dir);
 204         if (status == 0)
 205         {
 206                 free (dir);
 207                 return (0);
 208         }
 209         else if (errno != ENOENT)
 210         {
 211                 char errbuf[1024];
 212                 ERROR ("change_basedir: chdir (%s): %s", dir,
 213                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 214                 free (dir);
 215                 return (-1);
 216         }
 217
 218         status = mkdir (dir, S_IRWXU | S_IRWXG | S_IRWXO);
 219         if (status != 0)
 220         {
 221                 char errbuf[1024];
 222                 ERROR ("change_basedir: mkdir (%s): %s", dir,
 223                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 224                 free (dir);
 225                 return (-1);
 226         }
 227
 228         status = chdir (dir);
 229         if (status != 0)
 230         {
 231                 char errbuf[1024];
 232                 ERROR ("change_basedir: chdir (%s): %s", dir,
 233                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 234                 free (dir);
 235                 return (-1);
 236         }
 237
 238         free (dir);
 239         return (0);
 240 } /* static int change_basedir (char *dir) */
 241
 242 #if HAVE_LIBKSTAT
 243 static void update_kstat (void)
 244 {
 245         if (kc == NULL)
 246         {
 247                 if ((kc = kstat_open ()) == NULL)
 248                         ERROR ("Unable to open kstat control structure");
 249         }
 250         else
 251         {
 252                 kid_t kid;
 253                 kid = kstat_chain_update (kc);
 254                 if (kid > 0)
 255                 {
 256                         INFO ("kstat chain has been updated");
 257                         plugin_init_all ();
 258                 }
 259                 else if (kid < 0)
 260                         ERROR ("kstat chain update failed");
 261                 /* else: everything works as expected */
 262         }
 263
 264         return;
 265 } /* static void update_kstat (void) */
 266 #endif /* HAVE_LIBKSTAT */
 267
 268 /* TODO
 269  * Remove all settings but `-f' and `-C'
 270  */
 271 static void exit_usage (int status)
 272 {
 273         printf ("Usage: "PACKAGE" [OPTIONS]\n\n"
 274
 275                         "Available options:\n"
 276                         "  General:\n"
 277                         "    -C <file>       Configuration file.\n"
 278                         "                    Default: "CONFIGFILE"\n"
 279                         "    -t              Test config and exit.\n"
 280                         "    -T              Test plugin read and exit.\n"
 281                         "    -P <file>       PID-file.\n"
 282                         "                    Default: "PIDFILE"\n"
 283 #if COLLECT_DAEMON
 284                         "    -f              Don't fork to the background.\n"
 285 #endif
 286                         "    -h              Display help (this message)\n"
 287                         "\nBuiltin defaults:\n"
 288                         "  Config file       "CONFIGFILE"\n"
 289                         "  PID file          "PIDFILE"\n"
 290                         "  Plugin directory  "PLUGINDIR"\n"
 291                         "  Data directory    "PKGLOCALSTATEDIR"\n"
 292                         "\n"PACKAGE" "VERSION", http://collectd.org/\n"
 293                         "by Florian octo Forster <octo@collectd.org>\n"
 294                         "for contributions see `AUTHORS'\n");
 295         exit (status);
 296 } /* static void exit_usage (int status) */
 297
 298 static int do_init (void)
 299 {
 300 #if HAVE_SETLOCALE
 301         if (setlocale (LC_NUMERIC, COLLECTD_LOCALE) == NULL)
 302                 WARNING ("setlocale (\"%s\") failed.", COLLECTD_LOCALE);
 303 #endif
 304
 305 #if HAVE_LIBKSTAT
 306         kc = NULL;
 307         update_kstat ();
 308 #endif
 309
 310 #if HAVE_LIBSTATGRAB
 311         if (sg_init ())
 312         {
 313                 ERROR ("sg_init: %s", sg_str_error (sg_get_error ()));
 314                 return (-1);
 315         }
 316
 317         if (sg_drop_privileges ())
 318         {
 319                 ERROR ("sg_drop_privileges: %s", sg_str_error (sg_get_error ()));
 320                 return (-1);
 321         }
 322 #endif
 323
 324         plugin_init_all ();
 325
 326         return (0);
 327 } /* int do_init () */
 328
 329
 330 static int do_loop (void)
 331 {
 332         cdtime_t interval = cf_get_default_interval ();
 333         cdtime_t wait_until;
 334
 335         wait_until = cdtime () + interval;
 336
 337         while (loop == 0)
 338         {
 339                 struct timespec ts_wait = { 0, 0 };
 340                 cdtime_t now;
 341
 342 #if HAVE_LIBKSTAT
 343                 update_kstat ();
 344 #endif
 345
 346                 /* Issue all plugins */
 347                 plugin_read_all ();
 348
 349                 now = cdtime ();
 350                 if (now >= wait_until)
 351                 {
 352                         WARNING ("Not sleeping because the next interval is "
 353                                         "%.3f seconds in the past!",
 354                                         CDTIME_T_TO_DOUBLE (now - wait_until));
 355                         wait_until = now + interval;
 356                         continue;
 357                 }
 358
 359                 CDTIME_T_TO_TIMESPEC (wait_until - now, &ts_wait);
 360                 wait_until = wait_until + interval;
 361
 362                 while ((loop == 0) && (nanosleep (&ts_wait, &ts_wait) != 0))
 363                 {
 364                         if (errno != EINTR)
 365                         {
 366                                 char errbuf[1024];
 367                                 ERROR ("nanosleep failed: %s",
 368                                                 sstrerror (errno, errbuf,
 369                                                         sizeof (errbuf)));
 370                                 return (-1);
 371                         }
 372                 }
 373         } /* while (loop == 0) */
 374
 375         return (0);
 376 } /* int do_loop */
 377
 378 static int do_shutdown (void)
 379 {
 380         plugin_shutdown_all ();
 381         return (0);
 382 } /* int do_shutdown */
 383
 384 #if COLLECT_DAEMON
 385 static int pidfile_create (void)
 386 {
 387         FILE *fh;
 388         const char *file = global_option_get ("PIDFile");
 389
 390         if ((fh = fopen (file, "w")) == NULL)
 391         {
 392                 char errbuf[1024];
 393                 ERROR ("fopen (%s): %s", file,
 394                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 395                 return (1);
 396         }
 397
 398         fprintf (fh, "%i\n", (int) getpid ());
 399         fclose(fh);
 400
 401         return (0);
 402 } /* static int pidfile_create (const char *file) */
 403
 404 static int pidfile_remove (void)
 405 {
 406         const char *file = global_option_get ("PIDFile");
 407
 408         DEBUG ("unlink (%s)", (file != NULL) ? file : "<null>");
 409         return (unlink (file));
 410 } /* static int pidfile_remove (const char *file) */
 411 #endif /* COLLECT_DAEMON */
 412
 413 int notify_upstart (void)
 414 {
 415     const char  *upstart_job = getenv("UPSTART_JOB");
 416
 417     if (upstart_job == NULL)
 418         return 0;
 419
 420     if (strcmp(upstart_job, "collectd") != 0)
 421         return 0;
 422
 423     WARNING ("supervised by upstart, will stop to signal readyness");
 424     raise(SIGSTOP);
 425     unsetenv("UPSTART_JOB");
 426
 427     return 1;
 428 }
 429
 430 int notify_systemd (void)
 431 {
 432     int                  fd = -1;
 433     const char          *notifysocket = getenv("NOTIFY_SOCKET");
 434     struct sockaddr_un   su;
 435     struct iovec         iov;
 436     struct msghdr        hdr;
 437
 438     if (notifysocket == NULL)
 439         return 0;
 440
 441     if ((strchr("@/", notifysocket[0])) == NULL ||
 442         strlen(notifysocket) < 2)
 443         return 0;
 444
 445     WARNING ("supervised by systemd, will signal readyness");
 446     if ((fd = socket(AF_UNIX, SOCK_DGRAM, 0)) < 0) {
 447         WARNING ("cannot contact systemd socket %s", notifysocket);
 448         return 0;
 449     }
 450
 451     bzero(&su, sizeof(su));
 452     su.sun_family = AF_UNIX;
 453     sstrncpy (su.sun_path, notifysocket, sizeof(su.sun_path));
 454
 455     if (notifysocket[0] == '@')
 456         su.sun_path[0] = 0;
 457
 458     bzero(&iov, sizeof(iov));
 459     iov.iov_base = "READY=1";
 460     iov.iov_len = strlen("READY=1");
 461
 462     bzero(&hdr, sizeof(hdr));
 463     hdr.msg_name = &su;
 464     hdr.msg_namelen = offsetof(struct sockaddr_un, sun_path) +
 465         strlen(notifysocket);
 466     hdr.msg_iov = &iov;
 467     hdr.msg_iovlen = 1;
 468
 469     unsetenv("NOTIFY_SOCKET");
 470     if (sendmsg(fd, &hdr, MSG_NOSIGNAL) < 0) {
 471         WARNING ("cannot send notification to systemd");
 472         close(fd);
 473         return 0;
 474     }
 475     close(fd);
 476     return 1;
 477 }
 478
 479 int main (int argc, char **argv)
 480 {
 481         struct sigaction sig_int_action;
 482         struct sigaction sig_term_action;
 483         struct sigaction sig_usr1_action;
 484         struct sigaction sig_pipe_action;
 485         char *configfile = CONFIGFILE;
 486         int test_config  = 0;
 487         int test_readall = 0;
 488         const char *basedir;
 489 #if COLLECT_DAEMON
 490         struct sigaction sig_chld_action;
 491         pid_t pid;
 492         int daemonize    = 1;
 493 #endif
 494         int exit_status = 0;
 495
 496         /* read options */
 497         while (1)
 498         {
 499                 int c;
 500
 501                 c = getopt (argc, argv, "htTC:"
 502 #if COLLECT_DAEMON
 503                                 "fP:"
 504 #endif
 505                 );
 506
 507                 if (c == -1)
 508                         break;
 509
 510                 switch (c)
 511                 {
 512                         case 'C':
 513                                 configfile = optarg;
 514                                 break;
 515                         case 't':
 516                                 test_config = 1;
 517                                 break;
 518                         case 'T':
 519                                 test_readall = 1;
 520                                 global_option_set ("ReadThreads", "-1");
 521 #if COLLECT_DAEMON
 522                                 daemonize = 0;
 523 #endif /* COLLECT_DAEMON */
 524                                 break;
 525 #if COLLECT_DAEMON
 526                         case 'P':
 527                                 global_option_set ("PIDFile", optarg);
 528                                 pidfile_from_cli = 1;
 529                                 break;
 530                         case 'f':
 531                                 daemonize = 0;
 532                                 break;
 533 #endif /* COLLECT_DAEMON */
 534                         case 'h':
 535                                 exit_usage (0);
 536                                 break;
 537                         default:
 538                                 exit_usage (1);
 539                 } /* switch (c) */
 540         } /* while (1) */
 541
 542         if (optind < argc)
 543                 exit_usage (1);
 544
 545         plugin_init_ctx ();
 546
 547         /*
 548          * Read options from the config file, the environment and the command
 549          * line (in that order, with later options overwriting previous ones in
 550          * general).
 551          * Also, this will automatically load modules.
 552          */
 553         if (cf_read (configfile))
 554         {
 555                 fprintf (stderr, "Error: Reading the config file failed!\n"
 556                                 "Read the syslog for details.\n");
 557                 return (1);
 558         }
 559
 560         /*
 561          * Change directory. We do this _after_ reading the config and loading
 562          * modules to relative paths work as expected.
 563          */
 564         if ((basedir = global_option_get ("BaseDir")) == NULL)
 565         {
 566                 fprintf (stderr, "Don't have a basedir to use. This should not happen. Ever.");
 567                 return (1);
 568         }
 569         else if (change_basedir (basedir))
 570         {
 571                 fprintf (stderr, "Error: Unable to change to directory `%s'.\n", basedir);
 572                 return (1);
 573         }
 574
 575         /*
 576          * Set global variables or, if that failes, exit. We cannot run with
 577          * them being uninitialized. If nothing is configured, then defaults
 578          * are being used. So this means that the user has actually done
 579          * something wrong.
 580          */
 581         if (init_global_variables () != 0)
 582                 return (1);
 583
 584         if (test_config)
 585                 return (0);
 586
 587 #if COLLECT_DAEMON
 588         /*
 589          * fork off child
 590          */
 591         memset (&sig_chld_action, '\0', sizeof (sig_chld_action));
 592         sig_chld_action.sa_handler = SIG_IGN;
 593         sigaction (SIGCHLD, &sig_chld_action, NULL);
 594
 595     /*
 596      * Only daemonize if we're not being supervised
 597      * by upstart or systemd.
 598      */
 599         if (daemonize && notify_upstart() == 0 && notify_systemd() == 0)
 600         {
 601                 if ((pid = fork ()) == -1)
 602                 {
 603                         /* error */
 604                         char errbuf[1024];
 605                         fprintf (stderr, "fork: %s",
 606                                         sstrerror (errno, errbuf,
 607                                                 sizeof (errbuf)));
 608                         return (1);
 609                 }
 610                 else if (pid != 0)
 611                 {
 612                         /* parent */
 613                         /* printf ("Running (PID %i)\n", pid); */
 614                         return (0);
 615                 }
 616
 617                 /* Detach from session */
 618                 setsid ();
 619
 620                 /* Write pidfile */
 621                 if (pidfile_create ())
 622                         exit (2);
 623
 624                 /* close standard descriptors */
 625                 close (2);
 626                 close (1);
 627                 close (0);
 628
 629                 if (open ("/dev/null", O_RDWR) != 0)
 630                 {
 631                         ERROR ("Error: Could not connect `STDIN' to `/dev/null'");
 632                         return (1);
 633                 }
 634                 if (dup (0) != 1)
 635                 {
 636                         ERROR ("Error: Could not connect `STDOUT' to `/dev/null'");
 637                         return (1);
 638                 }
 639                 if (dup (0) != 2)
 640                 {
 641                         ERROR ("Error: Could not connect `STDERR' to `/dev/null'");
 642                         return (1);
 643                 }
 644         } /* if (daemonize) */
 645 #endif /* COLLECT_DAEMON */
 646
 647         memset (&sig_pipe_action, '\0', sizeof (sig_pipe_action));
 648         sig_pipe_action.sa_handler = SIG_IGN;
 649         sigaction (SIGPIPE, &sig_pipe_action, NULL);
 650
 651         /*
 652          * install signal handlers
 653          */
 654         memset (&sig_int_action, '\0', sizeof (sig_int_action));
 655         sig_int_action.sa_handler = sig_int_handler;
 656         if (0 != sigaction (SIGINT, &sig_int_action, NULL)) {
 657                 char errbuf[1024];
 658                 ERROR ("Error: Failed to install a signal handler for signal INT: %s",
 659                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 660                 return (1);
 661         }
 662
 663         memset (&sig_term_action, '\0', sizeof (sig_term_action));
 664         sig_term_action.sa_handler = sig_term_handler;
 665         if (0 != sigaction (SIGTERM, &sig_term_action, NULL)) {
 666                 char errbuf[1024];
 667                 ERROR ("Error: Failed to install a signal handler for signal TERM: %s",
 668                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 669                 return (1);
 670         }
 671
 672         memset (&sig_usr1_action, '\0', sizeof (sig_usr1_action));
 673         sig_usr1_action.sa_handler = sig_usr1_handler;
 674         if (0 != sigaction (SIGUSR1, &sig_usr1_action, NULL)) {
 675                 char errbuf[1024];
 676                 ERROR ("Error: Failed to install a signal handler for signal USR1: %s",
 677                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 678                 return (1);
 679         }
 680
 681         /*
 682          * run the actual loops
 683          */
 684         do_init ();
 685
 686         if (test_readall)
 687         {
 688                 if (plugin_read_all_once () != 0)
 689                         exit_status = 1;
 690         }
 691         else
 692         {
 693                 INFO ("Initialization complete, entering read-loop.");
 694                 do_loop ();
 695         }
 696
 697         /* close syslog */
 698         INFO ("Exiting normally.");
 699
 700         do_shutdown ();
 701
 702 #if COLLECT_DAEMON
 703         if (daemonize)
 704                 pidfile_remove ();
 705 #endif /* COLLECT_DAEMON */
 706
 707         return (exit_status);
 708 } /* int main */