Add resource attributes as metric labels (#314)

* Add resource attributes as metric labels

* fix comment language

Author: psx95

exporters/metrics/build.gradle

@@ -26,7 +26,7 @@ dependencies {
 	implementation(platform(libraries.google_cloud_bom))
 	implementation(platform(libraries.opentelemetry_bom))
 	implementation(project(':shared-resourcemapping'))
-	testImplementation(libraries.opentelemetry_semconv)
+	implementation(libraries.opentelemetry_semconv)
 	testImplementation(testLibraries.junit)
 	testImplementation(testLibraries.mockito)
 	testImplementation(testLibraries.slf4j_simple)

exporters/metrics/src/main/java/com/google/cloud/opentelemetry/metric/AggregateByLabelMetricTimeSeriesBuilder.java

@@ -27,17 +27,20 @@
 import com.google.monitoring.v3.TypedValue;
 import io.opentelemetry.api.common.AttributeKey;
 import io.opentelemetry.api.common.Attributes;
+import io.opentelemetry.api.common.AttributesBuilder;
 import io.opentelemetry.sdk.common.InstrumentationScopeInfo;
 import io.opentelemetry.sdk.metrics.data.DoublePointData;
 import io.opentelemetry.sdk.metrics.data.HistogramPointData;
 import io.opentelemetry.sdk.metrics.data.LongPointData;
 import io.opentelemetry.sdk.metrics.data.MetricData;
 import io.opentelemetry.sdk.metrics.data.PointData;
+import io.opentelemetry.sdk.resources.Resource;
 import java.util.Collection;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.Objects;
+import java.util.function.Predicate;
 import java.util.stream.Collectors;
 
 /**
@@ -55,10 +58,20 @@ public final class AggregateByLabelMetricTimeSeriesBuilder implements MetricTime
   private final Map<MetricWithLabels, TimeSeries.Builder> pendingTimeSeries = new HashMap<>();
   private final String projectId;
   private final String prefix;
+  private final Predicate<AttributeKey<?>> resourceAttributeFilter;
 
+  @Deprecated
   public AggregateByLabelMetricTimeSeriesBuilder(String projectId, String prefix) {
     this.projectId = projectId;
     this.prefix = prefix;
+    this.resourceAttributeFilter = MetricConfiguration.NO_RESOURCE_ATTRIBUTES;
+  }
+
+  public AggregateByLabelMetricTimeSeriesBuilder(
+      String projectId, String prefix, Predicate<AttributeKey<?>> resourceAttributeFilter) {
+    this.projectId = projectId;
+    this.prefix = prefix;
+    this.resourceAttributeFilter = resourceAttributeFilter;
   }
 
   @Override
@@ -96,15 +109,21 @@ public void recordPoint(MetricData metricData, HistogramPointData pointData) {
   }
 
   private void recordPointInTimeSeries(MetricData metric, PointData point, Point builtPoint) {
-    MetricDescriptor descriptor = mapMetricDescriptor(this.prefix, metric, point);
+    MetricDescriptor descriptor =
+        mapMetricDescriptor(
+            this.prefix, metric, point, extraLabelsFromResource(metric.getResource()));
     if (descriptor == null) {
       // Unsupported type.
       return;
     }
     descriptors.putIfAbsent(descriptor.getType(), descriptor);
     Attributes metricAttributes =
-        attachInstrumentationLibraryLabels(
-            point.getAttributes(), metric.getInstrumentationScopeInfo());
+        Attributes.builder()
+            .putAll(
+                instrumentationLibraryLabels(
+                    point.getAttributes(), metric.getInstrumentationScopeInfo()))
+            .putAll(extraLabelsFromResource(metric.getResource()))
+            .build();
     MetricWithLabels key = new MetricWithLabels(descriptor.getType(), metricAttributes);
     pendingTimeSeries
         .computeIfAbsent(key, k -> makeTimeSeriesHeader(metric, metricAttributes, descriptor))
@@ -119,7 +138,13 @@ private TimeSeries.Builder makeTimeSeriesHeader(
         .setResource(mapResource(metric.getResource()));
   }
 
-  private Attributes attachInstrumentationLibraryLabels(
+  private Attributes extraLabelsFromResource(Resource resource) {
+    AttributesBuilder attrBuilder = resource.getAttributes().toBuilder();
+    attrBuilder.removeIf(resourceAttributeFilter.negate());
+    return attrBuilder.build();
+  }
+
+  private Attributes instrumentationLibraryLabels(
       Attributes attributes, InstrumentationScopeInfo instrumentationScopeInfo) {
     return attributes.toBuilder()
         .put(

exporters/metrics/src/main/java/com/google/cloud/opentelemetry/metric/InternalMetricExporter.java

@@ -32,6 +32,7 @@
 import com.google.monitoring.v3.ProjectName;
 import com.google.monitoring.v3.TimeSeries;
 import io.grpc.ManagedChannelBuilder;
+import io.opentelemetry.api.common.AttributeKey;
 import io.opentelemetry.sdk.common.CompletableResultCode;
 import io.opentelemetry.sdk.metrics.InstrumentType;
 import io.opentelemetry.sdk.metrics.data.AggregationTemporality;
@@ -44,6 +45,7 @@
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.List;
+import java.util.function.Predicate;
 import javax.annotation.Nonnull;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -63,16 +65,19 @@ class InternalMetricExporter implements MetricExporter {
   private final String projectId;
   private final String prefix;
   private final MetricDescriptorStrategy metricDescriptorStrategy;
+  private final Predicate<AttributeKey<?>> resourceAttributesFilter;
 
   InternalMetricExporter(
       String projectId,
       String prefix,
       CloudMetricClient client,
-      MetricDescriptorStrategy descriptorStrategy) {
+      MetricDescriptorStrategy descriptorStrategy,
+      Predicate<AttributeKey<?>> resourceAttributesFilter) {
     this.projectId = projectId;
     this.prefix = prefix;
     this.metricServiceClient = client;
     this.metricDescriptorStrategy = descriptorStrategy;
+    this.resourceAttributesFilter = resourceAttributesFilter;
   }
 
   static InternalMetricExporter createWithConfiguration(MetricConfiguration configuration)
@@ -109,16 +114,19 @@ static InternalMetricExporter createWithConfiguration(MetricConfiguration config
         projectId,
         prefix,
         new CloudMetricClientImpl(MetricServiceClient.create(builder.build())),
-        configuration.getDescriptorStrategy());
+        configuration.getDescriptorStrategy(),
+        configuration.getResourceAttributesFilter());
   }
 
   @VisibleForTesting
   static InternalMetricExporter createWithClient(
       String projectId,
       String prefix,
       CloudMetricClient metricServiceClient,
-      MetricDescriptorStrategy descriptorStrategy) {
-    return new InternalMetricExporter(projectId, prefix, metricServiceClient, descriptorStrategy);
+      MetricDescriptorStrategy descriptorStrategy,
+      Predicate<AttributeKey<?>> resourceAttributesFilter) {
+    return new InternalMetricExporter(
+        projectId, prefix, metricServiceClient, descriptorStrategy, resourceAttributesFilter);
   }
 
   private void exportDescriptor(MetricDescriptor descriptor) {
@@ -142,7 +150,7 @@ public CompletableResultCode export(Collection<MetricData> metrics) {
     // 2. Attempt to register MetricDescriptors (using configured strategy)
     // 3. Fire the set of time series off.
     MetricTimeSeriesBuilder builder =
-        new AggregateByLabelMetricTimeSeriesBuilder(projectId, prefix);
+        new AggregateByLabelMetricTimeSeriesBuilder(projectId, prefix, resourceAttributesFilter);
     for (final MetricData metricData : metrics) {
       // Extract all the underlying points.
       switch (metricData.getType()) {

exporters/metrics/src/main/java/com/google/cloud/opentelemetry/metric/MetricConfiguration.java

@@ -25,7 +25,10 @@
 import com.google.common.base.Preconditions;
 import com.google.common.base.Strings;
 import com.google.common.base.Suppliers;
+import io.opentelemetry.api.common.AttributeKey;
+import io.opentelemetry.semconv.ResourceAttributes;
 import java.time.Duration;
+import java.util.function.Predicate;
 import java.util.function.Supplier;
 import javax.annotation.Nullable;
 import javax.annotation.concurrent.Immutable;
@@ -38,6 +41,19 @@
 @AutoValue
 @Immutable
 public abstract class MetricConfiguration {
+  /** Resource attribute filter that disables addition of resource attributes to metric labels. */
+  public static final Predicate<AttributeKey<?>> NO_RESOURCE_ATTRIBUTES = attributeKey -> false;
+
+  /**
+   * Default resource attribute filter that adds recommended resource attributes to metric labels.
+   */
+  public static final Predicate<AttributeKey<?>> DEFAULT_RESOURCE_ATTRIBUTES_FILTER =
+      attributeKey ->
+          (attributeKey.equals(ResourceAttributes.SERVICE_NAME)
+                  || attributeKey.equals(ResourceAttributes.SERVICE_NAMESPACE)
+                  || attributeKey.equals(ResourceAttributes.SERVICE_INSTANCE_ID))
+              && !attributeKey.getKey().isEmpty();
+
   static final String DEFAULT_PREFIX = "workload.googleapis.com";
 
   private static final Duration DEFAULT_DEADLINE =
@@ -100,7 +116,7 @@ public final String getProjectId() {
    *
    * <p>The Default is to only send descriptors once per process/classloader.
    *
-   * @return thhe configured strategy.
+   * @return the configured strategy.
    */
   public abstract MetricDescriptorStrategy getDescriptorStrategy();
 
@@ -112,6 +128,19 @@ public final String getProjectId() {
   @Nullable
   public abstract String getMetricServiceEndpoint();
 
+  /**
+   * Returns the {@link Predicate} based filter that determines which resource attributes to add as
+   * metric labels.
+   *
+   * <p>The default filter adds {@link ResourceAttributes#SERVICE_NAME}, {@link
+   * ResourceAttributes#SERVICE_NAMESPACE}, and {@link ResourceAttributes#SERVICE_INSTANCE_ID} as
+   * metric labels.
+   *
+   * @return a {@link Predicate} that acts as a resource attribute filter.
+   * @see Builder#setResourceAttributesFilter(Predicate) for details.
+   */
+  public abstract Predicate<AttributeKey<?>> getResourceAttributesFilter();
+
   @VisibleForTesting
   abstract boolean getInsecureEndpoint();
 
@@ -135,6 +164,7 @@ public static Builder builder() {
         .setDeadline(DEFAULT_DEADLINE)
         .setDescriptorStrategy(MetricDescriptorStrategy.SEND_ONCE)
         .setInsecureEndpoint(false)
+        .setResourceAttributesFilter(DEFAULT_RESOURCE_ATTRIBUTES_FILTER)
         .setMetricServiceEndpoint(MetricServiceStubSettings.getDefaultEndpoint());
   }
 
@@ -188,6 +218,19 @@ public final Builder setProjectId(String projectId) {
     @VisibleForTesting
     abstract Builder setInsecureEndpoint(boolean value);
 
+    /**
+     * Set a filter to determine which resource attributes to add to metrics as metric labels. By
+     * default, it adds service.name, service.namespace, and service.instance.id. This is
+     * recommended to avoid writing duplicate timeseries against the same monitored resource. Use
+     * setResourceAttributesFilter(NO_RESOURCE_ATTRIBUTES) to disable the addition of resource
+     * attributes to metric labels.
+     *
+     * @param filter A {@link Predicate} that determines if a resource attribute would be added as a
+     *     metric label
+     * @return this.
+     */
+    abstract Builder setResourceAttributesFilter(Predicate<AttributeKey<?>> filter);
+
     abstract MetricConfiguration autoBuild();
 
     /**

exporters/metrics/src/main/java/com/google/cloud/opentelemetry/metric/MetricTranslator.java

@@ -64,13 +64,18 @@ static Metric mapMetric(Attributes attributes, String type) {
   }
 
   static MetricDescriptor mapMetricDescriptor(
-      String prefix, MetricData metric, io.opentelemetry.sdk.metrics.data.PointData metricPoint) {
+      String prefix,
+      MetricData metric,
+      io.opentelemetry.sdk.metrics.data.PointData metricPoint,
+      Attributes extraLabels) {
     MetricDescriptor.Builder builder =
         MetricDescriptor.newBuilder()
             .setDisplayName(metric.getName())
             .setDescription(metric.getDescription())
             .setType(mapMetricType(metric.getName(), prefix))
             .setUnit(metric.getUnit());
+    // add extra labels if any
+    extraLabels.forEach((key, value) -> builder.addLabels(mapAttribute(key, prefix)));
     metricPoint
         .getAttributes()
         .forEach((key, value) -> builder.addLabels(mapAttribute(key, prefix)));

exporters/metrics/src/test/java/com/google/cloud/opentelemetry/metric/FakeData.java

@@ -70,6 +70,9 @@ public class FakeData {
           .put(ResourceAttributes.HOST_ID, aHostId)
           .put(ResourceAttributes.CLOUD_AVAILABILITY_ZONE, aCloudZone)
           .put(ResourceAttributes.CLOUD_PROVIDER, "gcp")
+          .put(ResourceAttributes.SERVICE_NAME, "test-gce-service")
+          .put(ResourceAttributes.SERVICE_NAMESPACE, "test-gce-service-ns")
+          .put(ResourceAttributes.SERVICE_INSTANCE_ID, "test-gce-service-id")
           .put("extra_info", "extra")
           .put("not_gcp_resource", "value")
           .build();