gcp-observability: add custom tags for all 3 - metrics, logging, traces and remove old env-vars impl

gcp-observability/src/main/java/io/grpc/gcp/observability/GcpObservability.java

@@ -69,7 +69,7 @@ public static synchronized GcpObservability grpcInit() throws IOException {
       GlobalLoggingTags globalLoggingTags = new GlobalLoggingTags();
       ObservabilityConfigImpl observabilityConfig = ObservabilityConfigImpl.getInstance();
       Sink sink = new GcpLogSink(observabilityConfig.getDestinationProjectId(),
-          globalLoggingTags.getLocationTags(), globalLoggingTags.getCustomTags(),
+          globalLoggingTags.getLocationTags(), observabilityConfig.getCustomTags(),
           observabilityConfig.getFlushMessageCount());
       // TODO(dnvindhya): Cleanup code for LoggingChannelProvider and LoggingServerProvider
       // once ChannelBuilder and ServerBuilder are used

gcp-observability/src/main/java/io/grpc/gcp/observability/GlobalLoggingTags.java

@@ -41,14 +41,11 @@ final class GlobalLoggingTags {
 
   private static final String ENV_KEY_PREFIX = "GRPC_OBSERVABILITY_";
   private final Map<String, String> locationTags;
-  private final Map<String, String> customTags;
 
   GlobalLoggingTags() {
     ImmutableMap.Builder<String, String> locationTagsBuilder = ImmutableMap.builder();
-    ImmutableMap.Builder<String, String> customTagsBuilder = ImmutableMap.builder();
-    populate(locationTagsBuilder, customTagsBuilder);
+    populate(locationTagsBuilder);
     locationTags = locationTagsBuilder.buildOrThrow();
-    customTags = customTagsBuilder.buildOrThrow();
   }
 
   private static String applyTrim(String value) {
@@ -62,10 +59,6 @@ Map<String, String> getLocationTags() {
     return locationTags;
   }
 
-  Map<String, String> getCustomTags() {
-    return customTags;
-  }
-
   @VisibleForTesting
   static void populateFromMetadataServer(ImmutableMap.Builder<String, String> customTags) {
     MetadataConfig metadataConfig = new MetadataConfig(new DefaultHttpTransportFactory());
@@ -139,10 +132,6 @@ private static String readFileContents(String file) {
     return null;
   }
 
-  private static void populateFromEnvironmentVars(ImmutableMap.Builder<String, String> customTags) {
-    populateFromMap(System.getenv(), customTags);
-  }
-
   @VisibleForTesting
   static void populateFromMap(Map<String, String> map,
       final ImmutableMap.Builder<String, String> customTags) {
@@ -155,9 +144,7 @@ static void populateFromMap(Map<String, String> map,
     });
   }
 
-  static void populate(ImmutableMap.Builder<String, String> locationTags,
-      ImmutableMap.Builder<String, String> customTags) {
-    populateFromEnvironmentVars(customTags);
+  static void populate(ImmutableMap.Builder<String, String> locationTags) {
     populateFromMetadataServer(locationTags);
     populateFromKubernetesValues(locationTags,
         "/var/run/secrets/kubernetes.io/serviceaccount/namespace",

gcp-observability/src/main/java/io/grpc/gcp/observability/ObservabilityConfig.java

@@ -20,6 +20,7 @@
 import io.grpc.observabilitylog.v1.GrpcLogRecord.EventType;
 import io.opencensus.trace.Sampler;
 import java.util.List;
+import java.util.Map;
 
 @Internal
 public interface ObservabilityConfig {
@@ -47,6 +48,9 @@ public interface ObservabilityConfig {
   /** Get sampler for TraceConfig - when Cloud Tracing is enabled. */
   Sampler getSampler();
 
+  /** Map of all custom tags used for logging, metrics and traces. */
+  Map<String, String> getCustomTags();
+
   /**
    * POJO for representing a filter used in configuration.
    */

gcp-observability/src/main/java/io/grpc/gcp/observability/ObservabilityConfigImpl.java

@@ -20,6 +20,7 @@
 
 import com.google.common.base.Charsets;
 import com.google.common.collect.ImmutableList;
+import com.google.common.collect.ImmutableMap;
 import io.grpc.internal.JsonParser;
 import io.grpc.internal.JsonUtil;
 import io.grpc.observabilitylog.v1.GrpcLogRecord.EventType;
@@ -48,6 +49,7 @@ final class ObservabilityConfigImpl implements ObservabilityConfig {
   private List<LogFilter> logFilters;
   private List<EventType> eventTypes;
   private Sampler sampler;
+  private Map<String, String> customTags;
 
   static ObservabilityConfigImpl getInstance() throws IOException {
     ObservabilityConfigImpl config = new ObservabilityConfigImpl();
@@ -120,6 +122,17 @@ private void parseConfig(Map<String, ?> config) {
           this.sampler = Samplers.probabilitySampler(samplingRate);
         }
       }
+      Map<String, ?> rawCustomTags = JsonUtil.getObject(config, "custom_tags");
+      if (rawCustomTags != null) {
+        ImmutableMap.Builder<String, String> builder = new ImmutableMap.Builder<>();
+        for (Map.Entry<String, ?> entry: rawCustomTags.entrySet()) {
+          checkArgument(
+                  entry.getValue() instanceof String,
+                  "'custom_tags' needs to be a map of <string, string>");
+          builder.put(entry.getKey(), (String) entry.getValue());
+        }
+        customTags = builder.build();
+      }
     }
   }
 
@@ -191,4 +204,9 @@ public List<EventType> getEventTypes() {
   public Sampler getSampler() {
     return sampler;
   }
+
+  @Override
+  public Map<String, String> getCustomTags() {
+    return customTags;
+  }
 }

gcp-observability/src/test/java/io/grpc/gcp/observability/ObservabilityConfigImplTest.java

@@ -33,6 +33,7 @@
 import java.nio.file.Files;
 import java.nio.file.Paths;
 import java.util.List;
+import java.util.Map;
 
 import org.junit.Rule;
 import org.junit.Test;
@@ -106,6 +107,23 @@ public class ObservabilityConfigImplTest {
       + "    \"global_trace_sampling_rate\": -0.75\n"
       + "}";
 
+  private static final String CUSTOM_TAGS = "{\n"
+          + "    \"enable_cloud_logging\": true,\n"
+          + "    \"custom_tags\": {\n"
+          + "      \"SOURCE_VERSION\" : \"J2e1Cf\",\n"
+          + "      \"SERVICE_NAME\" : \"payment-service\",\n"
+          + "      \"ENTRYPOINT_SCRIPT\" : \"entrypoint.sh\"\n"
+          + "    }\n"
+          + "}";
+
+  private static final String BAD_CUSTOM_TAGS = "{\n"
+          + "    \"enable_cloud_monitoring\": true,\n"
+          + "    \"custom_tags\": {\n"
+          + "      \"SOURCE_VERSION\" : \"J2e1Cf\",\n"
+          + "      \"SERVICE_NAME\" : { \"SUB_SERVICE_NAME\" : \"payment-service\"},\n"
+          + "      \"ENTRYPOINT_SCRIPT\" : \"entrypoint.sh\"\n"
+          + "    }\n"
+          + "}";
 
   ObservabilityConfigImpl observabilityConfig = new ObservabilityConfigImpl();
 
@@ -257,4 +275,26 @@ public void configFileLogFilters() throws Exception {
     assertThat(logFilters.get(1).headerBytes).isNull();
     assertThat(logFilters.get(1).messageBytes).isNull();
   }
+
+  @Test
+  public void customTags() throws IOException {
+    observabilityConfig.parse(CUSTOM_TAGS);
+    assertTrue(observabilityConfig.isEnableCloudLogging());
+    Map<String, String> customTags = observabilityConfig.getCustomTags();
+    assertThat(customTags).hasSize(3);
+    assertThat(customTags).containsEntry("SOURCE_VERSION", "J2e1Cf");
+    assertThat(customTags).containsEntry("SERVICE_NAME", "payment-service");
+    assertThat(customTags).containsEntry("ENTRYPOINT_SCRIPT", "entrypoint.sh");
+  }
+
+  @Test
+  public void badCustomTags() throws IOException {
+    try {
+      observabilityConfig.parse(BAD_CUSTOM_TAGS);
+      fail("exception expected!");
+    } catch (IllegalArgumentException iae) {
+      assertThat(iae.getMessage()).isEqualTo(
+              "'custom_tags' needs to be a map of <string, string>");
+    }
+  }
 }