[java] Log Timestamp flag added

Amil Uslu · pujagani · web-flow · commit fe6b3c5e0d6b · 2022-01-28T17:16:13.000+05:30
Co-authored-by: Puja Jagani &lt;puja.jagani93@gmail.com&gt;
diff --git a/java/src/org/openqa/selenium/grid/log/LoggingFlags.java b/java/src/org/openqa/selenium/grid/log/LoggingFlags.java
@@ -86,6 +86,10 @@ public class LoggingFlags implements HasRoles {
   @ConfigValue(section = LOGGING_SECTION, name = "log-level", example = "INFO")
   private String logLevel = DEFAULT_LOG_LEVEL;
 
+  @Parameter(description = "Format of the timestamp in log output", names = "--log-timestamp-format", arity = 1)
+  @ConfigValue(section = LOGGING_SECTION, name = "log-timestamp-format", example = "HH:mm:ss.SSS")
+  private String logTimestampFormat;
+
   @Override
   public Set<Role> getRoles() {
     return ALL_ROLES;
diff --git a/java/src/org/openqa/selenium/grid/log/LoggingOptions.java b/java/src/org/openqa/selenium/grid/log/LoggingOptions.java
@@ -49,6 +49,7 @@ public class LoggingOptions {
   private static final Logger LOG = Logger.getLogger(LoggingOptions.class.getName());
   private final Config config;
   private Level level = Level.INFO;
+  public static final String DEFAULT_LOG_TIMESTAMP_FORMAT = "HH:mm:ss.SSS";
 
   public LoggingOptions(Config config) {
     this.config = Require.nonNull("Config", config);
@@ -119,7 +120,7 @@ public void configureLogging() {
 
     if (isUsingPlainLogs()) {
       Handler handler = new FlushingHandler(out);
-      handler.setFormatter(new TerseFormatter());
+      handler.setFormatter(new TerseFormatter(getLogTimestampFormat()));
       handler.setLevel(level);
       configureLogEncoding(logger, encoding, handler);
     }
@@ -160,4 +161,8 @@ private OutputStream getOutputStream() {
       })
       .orElse(System.out);
   }
+
+  public String getLogTimestampFormat() {
+      return config.get(LOGGING_SECTION, "log-timestamp-format").orElse(DEFAULT_LOG_TIMESTAMP_FORMAT);
+  }
 }
diff --git a/java/src/org/openqa/selenium/grid/log/TerseFormatter.java b/java/src/org/openqa/selenium/grid/log/TerseFormatter.java
@@ -60,10 +60,10 @@ public class TerseFormatter extends Formatter {
   private final StringBuilder buffer;
   private final SimpleDateFormat timestampFormatter;
 
-  public TerseFormatter() {
+  public TerseFormatter(String logTimestampFormat) {
     buffer = new StringBuilder();
     buffer.append(PREFIX);
-    timestampFormatter = new SimpleDateFormat("HH:mm:ss.SSS");
+    timestampFormatter = new SimpleDateFormat(logTimestampFormat);
   }
 
   /**
diff --git a/java/src/org/openqa/selenium/remote/server/log/LoggingManager.java b/java/src/org/openqa/selenium/remote/server/log/LoggingManager.java
@@ -17,6 +17,7 @@
 
 package org.openqa.selenium.remote.server.log;
 
+import org.openqa.selenium.grid.log.LoggingOptions;
 import org.openqa.selenium.grid.log.TerseFormatter;
 
 import java.util.logging.ConsoleHandler;
@@ -32,7 +33,7 @@
 public class LoggingManager {
 
   private static PerSessionLogHandler perSessionLogHandler =
-    new PerSessionLogHandler(4000, new TerseFormatter(), false);
+    new PerSessionLogHandler(4000, new TerseFormatter(LoggingOptions.DEFAULT_LOG_TIMESTAMP_FORMAT), false);
 
   public static synchronized void configureLogging(boolean debugMode) {
     final Logger currentLogger;
@@ -67,14 +68,14 @@ public static void overrideSimpleFormatterWithTerseOneForConsoleHandler(
            * DGF - Nobody likes the SimpleFormatter; surely they wanted our terse formatter instead.
            */
           originalLevel = handler.getLevel();
-          handler.setFormatter(new TerseFormatter());
+          handler.setFormatter(new TerseFormatter(LoggingOptions.DEFAULT_LOG_TIMESTAMP_FORMAT));
           handler.setLevel(Level.WARNING);
 
           /*
            * Furthermore, we all want DEBUG/INFO on stdout and WARN/ERROR on stderr
            */
           stdOutHandler = new StdOutHandler();
-          stdOutHandler.setFormatter(new TerseFormatter());
+          stdOutHandler.setFormatter(new TerseFormatter(LoggingOptions.DEFAULT_LOG_TIMESTAMP_FORMAT));
           stdOutHandler.setFilter(new MaxLevelFilter(Level.INFO));
           stdOutHandler.setLevel(originalLevel);
           logger.addHandler(stdOutHandler);
