Don't capture http.target as metrics attribute (#5081)

open-telemetry · Jan 12, 2022 · b8ea362 · b8ea362
1 parent 5577afb
commit b8ea362
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 4 deletions.
diff --git a/...ain/java/io/opentelemetry/instrumentation/api/instrumenter/http/TemporaryMetricsView.java b/...ain/java/io/opentelemetry/instrumentation/api/instrumenter/http/TemporaryMetricsView.java
@@ -8,6 +8,7 @@
 import io.opentelemetry.api.common.AttributeKey;
 import io.opentelemetry.api.common.Attributes;
 import io.opentelemetry.api.common.AttributesBuilder;
+import io.opentelemetry.instrumentation.api.config.Config;
 import io.opentelemetry.semconv.trace.attributes.SemanticAttributes;
 import java.util.HashSet;
 import java.util.Set;
@@ -18,6 +19,14 @@
 @SuppressWarnings("rawtypes")
 final class TemporaryMetricsView {
 
+  // TODO (trask) remove this once http.route is captured consistently
+  //
+  // this is not enabled by default because it falls back to http.target (which can be high
+  // cardinality) when http.route is not available
+  private static final boolean USE_HTTP_TARGET_FALLBACK =
+      Config.get()
+          .getBoolean("otel.instrumentation.metrics.experimental.use-http-target-fallback", false);
+
   private static final Set<AttributeKey> durationAlwaysInclude = buildDurationAlwaysInclude();
   private static final Set<AttributeKey> durationClientView = buildDurationClientView();
   private static final Set<AttributeKey> durationServerView = buildDurationServerView();
@@ -96,7 +105,8 @@ private static <T> boolean containsAttribute(
   static Attributes applyServerDurationView(Attributes startAttributes, Attributes endAttributes) {
     Set<AttributeKey> fullSet = durationServerView;
     // Use http.target when http.route is not available.
-    if (!containsAttribute(SemanticAttributes.HTTP_ROUTE, startAttributes, endAttributes)) {
+    if (USE_HTTP_TARGET_FALLBACK
+        && !containsAttribute(SemanticAttributes.HTTP_ROUTE, startAttributes, endAttributes)) {
       fullSet = durationServerFallbackView;
     }
     AttributesBuilder filtered = Attributes.builder();

diff --git a/...st/java/io/opentelemetry/instrumentation/api/instrumenter/http/HttpServerMetricsTest.java b/...st/java/io/opentelemetry/instrumentation/api/instrumenter/http/HttpServerMetricsTest.java
@@ -143,7 +143,6 @@ void collectsMetrics() {
                                         .containsOnly(
                                             attributeEntry("http.scheme", "https"),
                                             attributeEntry("http.host", "host"),
-                                            attributeEntry("http.target", "/"),
                                             attributeEntry("http.method", "GET"),
                                             attributeEntry("http.status_code", 200),
                                             attributeEntry("http.flavor", "2.0"));

diff --git a/...java/io/opentelemetry/instrumentation/api/instrumenter/http/TemporaryMetricsViewTest.java b/...java/io/opentelemetry/instrumentation/api/instrumenter/http/TemporaryMetricsViewTest.java
@@ -136,8 +136,6 @@ public void shouldApplyServerDurationView_withTarget() {
         .containsOnly(
             attributeEntry(SemanticAttributes.HTTP_SCHEME.getKey(), "https"),
             attributeEntry(SemanticAttributes.HTTP_HOST.getKey(), "somehost"),
-            attributeEntry(
-                SemanticAttributes.HTTP_TARGET.getKey(), "/somehost/high/cardinality/12345"),
             attributeEntry(SemanticAttributes.HTTP_METHOD.getKey(), "GET"),
             attributeEntry(SemanticAttributes.HTTP_STATUS_CODE.getKey(), 500));
   }