[grid] Add http logs flag to allow http trace event logs

Author: pujagani

java/client/src/org/openqa/selenium/remote/tracing/BUILD.bazel

@@ -27,6 +27,7 @@ java_library(
     deps = [
         "//java/client/src/org/openqa/selenium:core",
         "//java/client/src/org/openqa/selenium/remote/http",
+        "//java/server/src/org/openqa/selenium/grid/config",
         artifact("com.google.guava:guava"),
         artifact("io.opentelemetry:opentelemetry-api"),
         artifact("io.opentelemetry:opentelemetry-context"),

java/client/src/org/openqa/selenium/remote/tracing/opentelemetry/BUILD.bazel

@@ -13,6 +13,7 @@ java_library(
         "//java/client/src/org/openqa/selenium:core",
         "//java/client/src/org/openqa/selenium/json",
         "//java/client/src/org/openqa/selenium/remote/tracing",
+        "//java/server/src/org/openqa/selenium/grid/config",
         artifact("com.google.guava:guava"),
         artifact("io.opentelemetry:opentelemetry-api"),
         artifact("io.opentelemetry:opentelemetry-context"),

java/client/src/org/openqa/selenium/remote/tracing/opentelemetry/OpenTelemetryTracer.java

@@ -31,6 +31,7 @@
 public class OpenTelemetryTracer implements org.openqa.selenium.remote.tracing.Tracer {
 
   private static final Logger LOG = Logger.getLogger(OpenTelemetryTracer.class.getName());
+  private static boolean HTTP_LOGS;
 
   // We obtain the underlying tracer instance from the singleton instance
   // that OpenTelemetry maintains. If we blindly grabbed the tracing provider
@@ -41,6 +42,14 @@ public class OpenTelemetryTracer implements org.openqa.selenium.remote.tracing.T
   // adding unit tests for this.
   private static volatile OpenTelemetryTracer singleton;
 
+  public static void setHttpLogs(boolean value) {
+    HTTP_LOGS = value;
+  }
+
+  public static boolean getHttpLogs() {
+    return HTTP_LOGS;
+  }
+
   public static OpenTelemetryTracer getInstance() {
     OpenTelemetryTracer localTracer = singleton;
     if (localTracer == null) {

java/client/src/org/openqa/selenium/remote/tracing/opentelemetry/SeleniumSpanExporter.java

@@ -18,29 +18,32 @@
 package org.openqa.selenium.remote.tracing.opentelemetry;
 
 import com.google.auto.service.AutoService;
+import io.opentelemetry.api.common.AttributeKey;
 import io.opentelemetry.api.common.Attributes;
 import io.opentelemetry.api.trace.StatusCode;
 import io.opentelemetry.sdk.autoconfigure.spi.SdkTracerProviderConfigurer;
 import io.opentelemetry.sdk.common.CompletableResultCode;
 import io.opentelemetry.sdk.trace.SdkTracerProviderBuilder;
 import io.opentelemetry.sdk.trace.data.EventData;
 import io.opentelemetry.sdk.trace.data.SpanData;
-import io.opentelemetry.sdk.trace.data.StatusData;
 import io.opentelemetry.sdk.trace.export.SimpleSpanProcessor;
 import io.opentelemetry.sdk.trace.export.SpanExporter;
 import org.openqa.selenium.json.Json;
 import org.openqa.selenium.json.JsonOutput;
+import org.openqa.selenium.remote.tracing.Span;
 
 import java.util.Collection;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.Optional;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 
 @AutoService(SdkTracerProviderConfigurer.class)
 public class SeleniumSpanExporter implements SdkTracerProviderConfigurer {
   private static final Logger LOG = Logger.getLogger(SeleniumSpanExporter.class.getName());
+  private final boolean httpLogs = OpenTelemetryTracer.getHttpLogs();
 
   @Override
   public void configure(SdkTracerProviderBuilder tracerProvider) {
@@ -51,25 +54,20 @@ public CompletableResultCode export(Collection<SpanData> spans) {
           LOG.fine(String.valueOf(span));
 
           String traceId = span.getTraceId();
-          String spanId = span.getSpanId();
-          StatusData status = span.getStatus();
           List<EventData> eventList = span.getEvents();
+
+          Level logLevel = getLogLevel(span);
+
           eventList.forEach(event -> {
             Map<String, Object> map = new HashMap<>();
             map.put("eventTime", event.getEpochNanos());
             map.put("traceId", traceId);
-            map.put("spanId", spanId);
-            map.put("spanKind", span.getKind().toString());
             map.put("eventName", event.getName());
 
             Attributes attributes = event.getAttributes();
             map.put("attributes", attributes.asMap());
             String jsonString = getJsonString(map);
-            if (status.getStatusCode() == StatusCode.ERROR) {
-              LOG.log(Level.WARNING, jsonString);
-            } else {
-              LOG.log(Level.FINE, jsonString);
-            }
+            LOG.log(logLevel, jsonString);
           });
         });
         return CompletableResultCode.ofSuccess();
@@ -96,4 +94,25 @@ private static String getJsonString(Map<String, Object> map) {
     }
     return text.toString();
   }
+
+  private Level getLogLevel(SpanData span) {
+    Level level = Level.FINE;
+
+    Optional<String> kind = Optional.ofNullable(span
+      .getAttributes()
+      .get(AttributeKey.stringKey(org.openqa.selenium.remote.tracing.AttributeKey.SPAN_KIND.getKey())));
+
+    if (span.getStatus().getStatusCode() == StatusCode.ERROR) {
+      level = Level.WARNING;
+    } else {
+      if (httpLogs && kind.isPresent()) {
+        String kindValue = kind.get();
+        if (Span.Kind.SERVER.name().equalsIgnoreCase(kindValue) ||
+          Span.Kind.CLIENT.name().equalsIgnoreCase(kindValue)) {
+          level = Level.INFO;
+        }
+      }
+    }
+    return level;
+  }
 }

java/server/src/org/openqa/selenium/grid/config/BUILD.bazel

@@ -12,6 +12,8 @@ java_library(
         "//java/server/src/org/openqa/selenium/grid:__subpackages__",
         "//java/server/src/org/openqa/selenium/netty/server:__pkg__",
         "//java/server/src/org/openqa/selenium/server/htmlrunner:__pkg__",
+        "//java/client/src/org/openqa/selenium/remote:__pkg__",
+        "//java/client/src/org/openqa/selenium/remote/tracing:__subpackages__",
         "//java/server/test/com/thoughtworks/selenium/webdriven:__pkg__",
         "//java/server/test/org/openqa/selenium:__subpackages__",
     ],

java/server/src/org/openqa/selenium/grid/log/LoggingFlags.java

@@ -29,6 +29,7 @@
 
 import static org.openqa.selenium.grid.config.StandardGridRoles.ALL_ROLES;
 import static org.openqa.selenium.grid.log.LoggingOptions.DEFAULT_CONFIGURE_LOGGING;
+import static org.openqa.selenium.grid.log.LoggingOptions.DEFAULT_HTTP_LOGS;
 import static org.openqa.selenium.grid.log.LoggingOptions.DEFAULT_LOG_LEVEL;
 import static org.openqa.selenium.grid.log.LoggingOptions.DEFAULT_PLAIN_LOGS;
 import static org.openqa.selenium.grid.log.LoggingOptions.DEFAULT_STRUCTURED_LOGS;
@@ -59,6 +60,10 @@ public class LoggingFlags implements HasRoles {
   @ConfigValue(section = LOGGING_SECTION, name = "tracing", example = "true")
   private Boolean enableTracing = DEFAULT_TRACING_ENABLED;
 
+  @Parameter(description = "Enable http logging. Tracing should be enabled to log http logs.", hidden = true, names = "--http-logs", arity = 1)
+  @ConfigValue(section = LOGGING_SECTION, name = "http-logs", example = "true")
+  private Boolean httpLogs = DEFAULT_HTTP_LOGS;
+
   @Parameter(description = "File to write out logs", names = "--log", arity = 1)
   @ConfigValue(section = LOGGING_SECTION, name = "log-file", example = "true")
   private String logFile;

java/server/src/org/openqa/selenium/grid/log/LoggingOptions.java

@@ -45,6 +45,7 @@ public class LoggingOptions {
   static final boolean DEFAULT_PLAIN_LOGS = true;
   static final boolean DEFAULT_STRUCTURED_LOGS = false;
   static final boolean DEFAULT_TRACING_ENABLED = true;
+  public static final boolean DEFAULT_HTTP_LOGS = false;
   private static final Logger LOG = Logger.getLogger(LoggingOptions.class.getName());
   private final Config config;
   private Level level = Level.INFO;
@@ -57,6 +58,10 @@ public boolean isUsingStructuredLogging() {
     return config.getBool(LOGGING_SECTION, "structured-logs").orElse(DEFAULT_STRUCTURED_LOGS);
   }
 
+  public boolean shouldLogHttpLogs() {
+    return config.getBool(LOGGING_SECTION, "http-logs").orElse(DEFAULT_HTTP_LOGS);
+  }
+
   public boolean isUsingPlainLogs() {
     return config.getBool(LOGGING_SECTION, "plain-logs").orElse(DEFAULT_PLAIN_LOGS);
   }
@@ -83,6 +88,8 @@ public Tracer getTracer() {
       return new NullTracer();
     }
 
+    OpenTelemetryTracer.setHttpLogs(shouldLogHttpLogs());
+
     return OpenTelemetryTracer.getInstance();
   }
 

java/server/test/org/openqa/selenium/grid/router/BUILD.bazel

@@ -22,6 +22,7 @@ java_library(
         artifact("org.slf4j:slf4j-jdk14"),
     ],
     deps = [
+        "//java/server/src/org/openqa/selenium/grid/config",
         "//java/client/src/org/openqa/selenium:core",
         "//java/client/src/org/openqa/selenium/json",
         "//java/client/src/org/openqa/selenium/remote/http",
@@ -56,6 +57,7 @@ java_selenium_test_suite(
         "//java/client/test/org/openqa/selenium/testing:annotations",
         "//java/client/test/org/openqa/selenium/testing:test-base",
         "//java/server/src/org/openqa/selenium/grid",
+        "//java/server/src/org/openqa/selenium/grid/config",
         "//java/server/test/org/openqa/selenium/grid/testing",
         artifact("com.google.guava:guava"),
         artifact("junit:junit"),
@@ -82,6 +84,7 @@ java_test_suite(
         "//java/client/test/org/openqa/selenium/testing:test-base",
         "//java/server/src/org/openqa/selenium/grid",
         "//java/server/test/org/openqa/selenium/grid/testing",
+        "//java/server/src/org/openqa/selenium/grid/config",
         artifact("com.google.guava:guava"),
         artifact("io.opentelemetry:opentelemetry-api"),
         artifact("junit:junit"),