Log file (#588)

Add file logging option

Author: Kalfou

doc/usage.md

@@ -285,3 +285,10 @@ CodeCompass_webserver \
 
 The server will be available in a browser on
 [`http://localhost:6251`](http://localhost:6251).
+
+### Logging
+
+In both the parser and the webserver it is possible to write the logs to a given directory.
+This feature can be enabled by passing the `--logtarget` command line option with the full
+path to the directory to be used for storing the log files.
+If this argument is not specified, the logs will be written to the terminal only.

parser/src/parser.cpp

@@ -70,6 +70,9 @@ po::options_description commandLineArguments()
       po::value<trivial::severity_level>()->default_value(trivial::info),
       "Logging legel of the parser. Possible values are: debug, info, warning, "
       "error, critical.")
+    ("logtarget", po::value<std::string>(),
+      "This is the path to the folder where the logging output files will be written. "
+      "If omitted, the output will be on the console only.")
     ("jobs,j", po::value<int>()->default_value(4),
       "Number of threads the parsers can use.")
     ("skip,s", po::value<std::vector<std::string>>(),
@@ -219,7 +222,7 @@ int main(int argc, char* argv[])
 
   cc::parser::PluginHandler pHandler(PARSER_PLUGIN_DIR);
 
-  cc::util::initLogger();
+  cc::util::initConsoleLogger();
 
   //--- Process command line arguments ---//
 
@@ -229,6 +232,17 @@ int main(int argc, char* argv[])
   po::store(po::command_line_parser(argc, argv)
     .options(desc).allow_unregistered().run(), vm);
 
+  if (vm.count("logtarget"))
+  {
+    vm.at("logtarget").value() = cc::util::getLoggingBase( vm["logtarget"].as<std::string>()
+                                                          , vm["name"].as<std::string>()
+                                                          );
+    if (!cc::util::initFileLogger(vm["logtarget"].as<std::string>() + "parser.log"))
+    {
+      vm.at("logtarget").value() = std::string();
+    }
+  }
+
   //--- Skip parser list ---//
 
   std::vector<std::string> skipParserList;

plugins/search/common/CMakeLists.txt

@@ -9,6 +9,7 @@ add_jar(searchcommonjava
   ${CMAKE_CURRENT_SOURCE_DIR}/src/cc/search/analysis/Location.java
   ${CMAKE_CURRENT_SOURCE_DIR}/src/cc/search/analysis/SourceTextAnalyzer.java
   ${CMAKE_CURRENT_SOURCE_DIR}/src/cc/search/analysis/SourceTextTokenizer.java
+  ${CMAKE_CURRENT_SOURCE_DIR}/src/cc/search/common/FileLoggerInitializer.java
   ${CMAKE_CURRENT_SOURCE_DIR}/src/cc/search/common/IndexFields.java
   ${CMAKE_CURRENT_SOURCE_DIR}/src/cc/search/common/SuggestionDatabase.java
   ${CMAKE_CURRENT_SOURCE_DIR}/src/cc/search/common/NFSFriendlyLockFactory.java

plugins/search/common/src/cc/search/common/FileLoggerInitializer.java

@@ -0,0 +1,28 @@
+package cc.search.common;
+
+import cc.search.common.config.CommonOptions;
+
+import java.util.logging.Level;
+import java.util.logging.Logger;
+import java.util.logging.FileHandler;
+import java.util.logging.SimpleFormatter;
+
+/**
+ * Adds file to logging when needed
+ */
+public class FileLoggerInitializer {
+  public static void addFileOutput(CommonOptions options_, Logger log_, String pluginName_) {
+    String filePathField = options_.logFilePath + pluginName_ + ".log";
+    if (!options_.logFilePath.isEmpty()) {
+      try {
+        FileHandler fileHandler = new FileHandler(filePathField, false);
+        SimpleFormatter formatter = new SimpleFormatter();
+        fileHandler.setFormatter(formatter);
+        log_.addHandler(fileHandler);
+        log_.info("Logging started to file: " + filePathField);
+      } catch (Exception ex) {
+        log_.log(Level.WARNING, "Could not add logs to file: " + filePathField, ex);
+      }
+    }
+  }
+}

plugins/search/common/src/cc/search/common/config/CommonOptions.java

@@ -16,6 +16,11 @@ public abstract class CommonOptions {
    * Index database path
    */
   public String indexDirPath;
+  /**
+   * Logging file path
+   * (if there is no file logging, empty string)
+   */
+  public String logFilePath = "";
   /**
    * Input file descriptor for thrift IPC.
    */
@@ -77,6 +82,15 @@ protected void setFromCommandLineArguments(List<String> args_)
             argIter.remove();
           }
           break;
+        case "-logTarget":
+          if (!argIter.hasNext()) {
+            throw new InvalidValueException("No path for -logTarget");
+          } else {
+            argIter.remove();
+            logFilePath = argIter.next();
+            argIter.remove();
+          }
+          break;
         case "-ipcInFd":
           if (!argIter.hasNext()) {
             throw new InvalidValueException("-ipcInFd is empty");
@@ -136,6 +150,7 @@ public static String getUsage() {
       + "\t-ipcInFd fd\n\t\tFile descriptor for IPC IN.\n"
       + "\t-ipcOutFd id\n\t\tFile descriptor for IPC OUT.\n"
       + "\t-useSimpleFileLock\n\t\tUse NFS friendly file locks.\n"
+      + "\t-logTarget\n\t\tPath to logging file.\n"
       + "\t-cleanupLocks\n\t\tCleanup locks before first lock..\n";
   }
 }

plugins/search/common/src/cc/search/common/config/LogConfigurator.java

@@ -25,7 +25,7 @@ public LogConfigurator() {
       logManager.readConfiguration(cfgStream);
 
     } catch (IOException | SecurityException ex) {
-      Logger.getLogger(LogConfigurator.class.getName()).log(Level.SEVERE,
+      Logger.getGlobal().log(Level.SEVERE,
         "Failed to configure custom log propeties!", ex);
     }
   }

plugins/search/common/src/cc/search/common/ipc/IPCProcessor.java

@@ -22,8 +22,7 @@ public class IPCProcessor implements AutoCloseable {
   /**
    * Logger.
    */
-  private static final Logger _log  = Logger.getLogger(
-    IPCProcessor.class.getName());
+  private static final Logger _log  = Logger.getGlobal();
   /**
    * Processor for thrift messages.
    */

plugins/search/indexer/include/indexer/indexerprocess.h

@@ -64,7 +64,8 @@ class IndexerProcess :
     const std::string& indexDatabase_,
     const std::string& compassRoot_,
     OpenMode openMode_,
-    LockMode lockMode_ = LockMode::Simple);
+    LockMode lockMode_ = LockMode::Simple,
+    const std::string& logTarget_ = "");
 
   /**
    * Closes the I/O pipe so the child process will exit if it finished. Also

plugins/search/indexer/indexer-java/src/cc/search/analysis/SourceAnalyzer.java

@@ -20,8 +20,7 @@ public final class SourceAnalyzer extends AnalyzerWrapper {
   /**
    * Logger.
    */
-  private static final Logger _log  = Logger.getLogger(SourceAnalyzer.class
-    .getName());
+  private static final Logger _log  = Logger.getGlobal();
   /**
    * Analyzer for a full path.
    */

plugins/search/indexer/indexer-java/src/cc/search/analysis/tags/CTags.java

@@ -19,8 +19,7 @@ class CTags implements TagGenerator {
   /**
    * Logger.
    */
-  private final static Logger _log  = Logger.getLogger(CTags.class
-    .getName());
+  private final static Logger _log  = Logger.getGlobal();
   /**
    * Filter terminator string for ctags.
    */