src/gcm_input/gcm_input.cpp

   1 /**************************************************************************
   2 **  (c) Copyright 2002, Andromeda Technology & Automation
   3 ** This is free software; you can redistribute it and/or modify it under the
   4 ** terms of the GNU General Public License, see the file COPYING.
   5 ***************************************************************************
   6 ** MODULE INFORMATION *
   7 ***********************
   8 **      FILE NAME      : gcm_input.cpp
   9 **      SYSTEM NAME    : Gnucomo - Gnu Computer Monitoring
  10 **      VERSION NUMBER : $Revision: 1.15 $
  11 **
  12 **  DESCRIPTION      :  Application to store client messages into the database
  13 **                      The client message contains a log file from one of the
  14 **                      system logs. Gcm_input parses the log file and enters
  15 **                      the raw data into the 'log' table of the gnucomo database.
  16 **
  17 **                      The system log may arrive in one of several forms:
  18 **                      1. Log file (archived or not) from a client machine.
  19 **                      2. Log file from a client system, arriving in a clear Email.
  20 **                      3. Log file from a client machine, arriving in an
  21 **                         encrypted Email.
  22 **
  23 **                      additional information we need that may not be availble in
  24 **                      the content of the log is:
  25 **                      - FQDN of the client.
  26 **                      - Time of arrival of the log
  27 **                      - Service that created the log.
  28 **
  29 **                      If the log arrives in an Email, these items probably are
  30 **                      available in the mail header. Otherwise, they have to be
  31 **                      provided as command line arguments.
  32 **
  33 **                      Command line arguments:
  34 **                      -c <name>        Configuration name (default = gnucomo).
  35 **                      -d <date>        Date and time of log arrival.
  36 **                      -h <hostname>    FQDN of the client.
  37 **                      -i               Incremental - partial list of parameters.
  38 **                      -s <service>     Service that created the log.
  39 **                      -T               Test mode. Do not alter the database.
  40 **                      -v               Verbose (debug) output.
  41 **                      -V               Print version and exit.
  42 **
  43 **  EXPORTED OBJECTS :
  44 **  LOCAL    OBJECTS :
  45 **  MODULES  USED    :
  46 ***************************************************************************
  47 **  ADMINISTRATIVE INFORMATION *
  48 ********************************
  49 **      ORIGINAL AUTHOR : Arjen Baart - arjen@andromeda.nl
  50 **      CREATION DATE   : Aug 29, 2002
  51 **      LAST UPDATE     : Nov 26, 2003
  52 **      MODIFICATIONS   :
  53 **************************************************************************/
  54
  55 /*****************************
  56    $Log: gcm_input.cpp,v $
  57    Revision 1.15  2007-11-14 16:19:25  arjen
  58    Bugfix: Segmentation fault when reading an rpm package list
  59    with empty lines.
  60
  61    Revision 1.14  2007/11/03 10:26:13  arjen
  62    Added a new filter which can directly read the output
  63    of the UNIX df command. A brief description is added in
  64    the user manual.
  65
  66    Revision 1.13  2003/12/22 10:20:21  arjen
  67    Report if the message type can not be detected.
  68
  69    Revision 1.12  2003/12/04 10:38:09  arjen
  70    Major redesign. All input is handled through XML. Raw input data is first
  71    transformed into an XML document for further processing.
  72    A collection of polymorphic classes handle the transformation of various
  73    input formats into XML.
  74    Classifying input data is done with a finite improbability calculation.
  75
  76    Revision 1.11  2003/10/27 13:00:15  arjen
  77    Catch exceptions from the database library
  78
  79    Revision 1.10  2003/09/03 06:58:31  arjen
  80    Changed version string to 0.0.8
  81
  82    Revision 1.9  2003/09/01 06:59:26  arjen
  83    A date without the time for the '-d <date> option will
  84    assume midnight on that date.
  85
  86    Revision 1.8  2003/08/16 15:30:19  arjen
  87    Fixed a gcc 2 vs. gcc 3 problem
  88
  89    Revision 1.7  2003/08/14 10:28:37  arjen
  90    Use parameters from a new section 'logging' with three configuration parameters:
  91       method       - Output method to use for logging.
  92       destination  - Name of the log output destination.
  93       level        - Log level: Verbose output if greater than 0.
  94
  95    Revision 1.6  2003/08/11 16:56:16  arjen
  96    Different kinds of log files are parsed by a collection of objects
  97    of different classes, derived from the base class line_cooker
  98    Depending on the message content or the message_type element in
  99    XML, one of these objects is selected.
 100
 101    Logrunner is integrated with gcm_input. Although its functionality
 102    is still limited, a connection between logrunner and gcm_input
 103    is beginning to form.
 104
 105    Revision 1.5  2003/08/05 08:11:06  arjen
 106    Added two configuration parameters:
 107       logfile   - Log to this file instead of stderr.
 108       verbosity - Verbose output if greater than 0.
 109    Added '-i' option for incremental parameter updates
 110
 111    Revision 1.4  2003/03/29 08:42:00  arjen
 112    Exit without reading any input if the database connection fails.
 113
 114    Revision 1.3  2002/11/09 08:04:27  arjen
 115    Added a reference to the GPL
 116
 117    Revision 1.2  2002/11/04 10:13:36  arjen
 118    Use proper namespace for iostream classes
 119
 120    Revision 1.1  2002/10/05 10:25:49  arjen
 121    Creation of gcm_input and a first approach to a web interface
 122
 123 *****************************/
 124
 125 static const char *RCSID = "$Id: gcm_input.cpp,v 1.15 2007-11-14 16:19:25 arjen Exp $";
 126
 127 #include <fstream>
 128
 129 #include <getopt.h>
 130
 131 #include "message.h"
 132 #include "log_filter.h"
 133 #include "rpm_filter.h"
 134 #include "df_filter.h"
 135
 136 #include "xml_cooker.h"
 137 #include "syslog_cooker.h"
 138 #include "irix_syslog_cooker.h"
 139 #include "access_cooker.h"
 140 #include "error_cooker.h"
 141
 142 bool verbose = false;
 143 bool testmode = false;
 144 bool incremental = false;
 145 std::ostream *Log = &std::cerr;
 146
 147 static char *Version = "gcm_input version 0.0.11 - Nov 22, 2007";
 148
 149
 150 /*=========================================================================
 151 **  NAME           : main
 152 **  SYNOPSIS       : int main(int argc, char *argv[])
 153 **  PARAMETERS     :
 154 **  RETURN VALUE   :
 155 **
 156 **  DESCRIPTION    : Parse command line arguments and establish a connection
 157 **                   to the database.
 158 **                   When we have a database connection, parse the log file
 159 **                   from stdin.
 160 **
 161 **  VARS USED      :
 162 **  VARS CHANGED   :
 163 **  FUNCTIONS USED :
 164 **  SEE ALSO       :
 165 **  LAST MODIFIED  : Aug 11, 2003
 166 **=========================================================================
 167 */
 168
 169 int main(int argc, char *argv[])
 170 {
 171    const char *usage = "Usage: gcm_input [-c configname] [-h hostname] [-i] [-d date]"
 172                        " [-s service] [-T] [-v] [-V]\n";
 173
 174    gnucomo_config    cfg;
 175    char             *config_name = "gnucomo";
 176    std::ofstream    logfile;
 177
 178
 179    /*   Parse command line arguments */
 180
 181    UTC    arrival = Now();
 182    String  hostname(""), service("");
 183    int     option;
 184
 185
 186    while ((option = getopt(argc, argv, "c:h:d:s:iTvV")) != -1)
 187    {
 188       switch (option)
 189       {
 190       case 'c':
 191          config_name = optarg;
 192          break;
 193
 194       case 'h':
 195          hostname = optarg;
 196          break;
 197
 198       case 'd':
 199          arrival = String(optarg);
 200          if (!date(arrival).proper())
 201          {
 202             std::cerr << "gcm_input: Invalid date string: " << optarg
 203                       << "(" << arrival << ").\n";
 204             exit(1);
 205          }
 206          else if (!hour(arrival).proper())
 207          {
 208             arrival = UTC(date(arrival), hour(0,0,0));
 209          }
 210          break;
 211
 212       case 's':
 213          service = optarg;
 214          break;
 215
 216       case 'i':
 217          incremental = true;
 218          break;
 219
 220       case 'T':
 221          testmode = true;
 222          break;
 223
 224       case 'v':
 225          verbose = true;
 226          break;
 227
 228       case 'V':
 229          std::cout << Version << "\n";
 230          exit(0);
 231
 232       case '?':
 233       case ':':
 234          std::cerr << usage;
 235          exit(1);
 236       }
 237    }
 238    /*  Get the configuration file */
 239
 240    if (!cfg.read(config_name))
 241    {
 242       std::cerr << "Can not read Gnucomo configuration file for " << config_name << ".\n";
 243       exit(1);
 244    }
 245
 246    String log_method      = cfg.find_parameter("logging", "method");
 247    String log_destination = cfg.find_parameter("logging", "destination");
 248    int    level           = cfg.find_parameter("logging", "level");
 249
 250    if (log_method == "file" && log_destination != "")
 251    {
 252 #if __GNUC__ == 2
 253       logfile.open(log_destination, _IO_APPEND); // for gcc 2
 254 #else
 255       logfile.open(log_destination, std::ios_base::app); // for gcc 3
 256 #endif
 257       if (!logfile)
 258       {
 259          std::cerr << "Can't open logfile " << log_destination << " for writing.\n";
 260       }
 261       else
 262       {
 263          Log = &logfile;
 264       }
 265    }
 266    verbose = verbose || level > 0;
 267
 268    if (verbose)
 269    {
 270       *Log << "Hostname = " << hostname;
 271       *Log << " Arrival = " << arrival;
 272       *Log << " Service = " << service << "\n";
 273       *Log << "Config OK.\n";
 274    }
 275
 276    /*  Try to connect to the database */
 277
 278    gnucomo_database db(&cfg);
 279
 280    if (db.is_connected())
 281    {
 282
 283       client_message      msg(&std::cin, db);
 284
 285       double              message_probability;
 286
 287       message_filter      shortcircuit(hostname, arrival, service);
 288       log_filter          lf(hostname, arrival, service);
 289       rpm_filter          rf(hostname, arrival, service);
 290       df_filter           df(hostname, arrival, service);
 291
 292       syslog_cooker       slc;
 293       irix_syslog_cooker  islc;
 294       access_cooker       alc;
 295       error_cooker        elc;
 296       xml_cooker          xlc;
 297       rpm_cooker          rlc;
 298       df_cooker           dlc;
 299
 300       msg.add_cooker(&xlc,  &shortcircuit);
 301       msg.add_cooker(&slc,  &lf);
 302       msg.add_cooker(&islc, &lf);
 303       msg.add_cooker(&alc,  &lf);
 304       msg.add_cooker(&elc,  &lf);
 305       msg.add_cooker(&rlc,  &rf);
 306       msg.add_cooker(&dlc,  &df);
 307
 308       message_probability = msg.classify(hostname, arrival, service);
 309       if (message_probability > 0.75)
 310       {
 311          try
 312          {
 313             msg.enter();
 314          }
 315          catch (std::exception &e)
 316          {
 317             *Log << "Caught an exception: " << e.what() << "\n";
 318          }
 319       }
 320       else
 321       {
 322          *Log << "Cannot determine message type with sufficient certainty.\n";
 323       }
 324       return 0;
 325    }
 326    else
 327    {
 328       *Log << "gcm_input: Can not connect to database.\n";
 329       *Log << "Gcm_input finished at " << Now() << ".\n";
 330       return 1;
 331    }
 332 }
 333