feat: add sdk logging helpers

Author: JoeWang1127

java-sdk-logging/logback-extension/pom.xml

@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+  <parent>
+    <groupId>com.google.api</groupId>
+    <artifactId>java-sdk-logging</artifactId>
+    <version>0.0.1-SNAPSHOT</version>
+  </parent>
+  <artifactId>logback-extension</artifactId>
+
+  <properties>
+    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    <logback.version>1.2.13</logback.version>
+    <logstash.encoder.version>7.3</logstash.encoder.version>
+  </properties>
+
+  <dependencies>
+    <dependency>
+      <groupId>org.slf4j</groupId>
+      <artifactId>slf4j-api</artifactId>
+      <version>${slf4j.version}</version>
+    </dependency>
+    <dependency>
+      <groupId>ch.qos.logback</groupId>
+      <artifactId>logback-classic</artifactId>
+      <version>${logback.version}</version>
+      <optional>true</optional>
+    </dependency>
+    <dependency>
+      <groupId>net.logstash.logback</groupId>
+      <artifactId>logstash-logback-encoder</artifactId>
+      <version>${logstash.encoder.version}</version>
+      <optional>true</optional>
+    </dependency>
+  </dependencies>
+</project>

java-sdk-logging/logback-extension/src/main/java/com/google/api/logging/LoggingMdcJsonProvider.java

@@ -0,0 +1,62 @@
+package com.google.api.logging;
+
+import ch.qos.logback.classic.spi.ILoggingEvent;
+import com.fasterxml.jackson.core.JsonGenerator;
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import java.io.IOException;
+import java.util.Map;
+import net.logstash.logback.composite.loggingevent.MdcJsonProvider;
+
+public class LoggingMdcJsonProvider extends MdcJsonProvider {
+  private final ObjectMapper objectMapper = new ObjectMapper();
+
+  @Override
+  public void writeTo(JsonGenerator generator, ILoggingEvent event) throws IOException {
+    Map<String, String> mdcProperties = event.getMDCPropertyMap();
+    if (mdcProperties != null && !mdcProperties.isEmpty()) {
+
+      boolean hasWrittenStart = false;
+
+      for (Map.Entry<String, String> entry : mdcProperties.entrySet()) {
+        // removed ability to override MDC key names
+        String fieldName = entry.getKey();
+
+        if (!hasWrittenStart && getFieldName() != null) {
+          generator.writeObjectFieldStart(getFieldName());
+          hasWrittenStart = true;
+        }
+        generator.writeFieldName(fieldName);
+        String entryValueString = entry.getValue();
+        if (isJsonStringJackson(entryValueString)) {
+          try {
+            generator.writeTree(convertToTreeNode(entryValueString));
+          } catch (Exception e) {
+            // in case of conversion exception, just use String
+            generator.writeObject(entryValueString);
+          }
+        } else {
+          generator.writeObject(entryValueString);
+        }
+      }
+      if (hasWrittenStart) {
+        generator.writeEndObject();
+      }
+    }
+  }
+
+  public boolean isJsonStringJackson(String s) {
+    try {
+      JsonNode jsonNode = objectMapper.readTree(s);
+      return jsonNode != null;
+    } catch (JsonProcessingException e) {
+      return false;
+    }
+  }
+
+  private JsonNode convertToTreeNode(String jsonString) throws Exception{
+    JsonNode jsonNode = objectMapper.readTree(jsonString);
+    return jsonNode;
+  }
+}

java-sdk-logging/pom.xml

@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+  <groupId>com.google.api</groupId>
+  <artifactId>java-sdk-logging</artifactId>
+  <version>0.0.1-SNAPSHOT</version>
+  <packaging>pom</packaging>
+  <modules>
+    <module>logback-extension</module>
+  </modules>
+
+  <properties>
+    <maven.compiler.source>1.8</maven.compiler.source>
+    <maven.compiler.target>1.8</maven.compiler.target>
+    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    <slf4j.version>1.7.36</slf4j.version>
+  </properties>
+
+</project>

pom.xml

@@ -24,6 +24,7 @@
     <module>gapic-generator-java-bom</module>
     <module>java-shared-dependencies</module>
     <module>sdk-platform-java-config</module>
+    <module>java-sdk-logging</module>
   </modules>
   <!-- Do not deploy the aggregator POM -->
   <build>