added url template.

Author: MarcusDunn

instrumentation-api/src/main/java/io/opentelemetry/instrumentation/api/semconv/http/HttpClientAttributesGetter.java

@@ -7,6 +7,7 @@
 
 import io.opentelemetry.instrumentation.api.semconv.network.NetworkAttributesGetter;
 import io.opentelemetry.instrumentation.api.semconv.network.ServerAttributesGetter;
+import io.opentelemetry.instrumentation.api.semconv.url.UrlAttributesGetter;
 import javax.annotation.Nullable;
 
 /**
@@ -21,7 +22,8 @@
 public interface HttpClientAttributesGetter<REQUEST, RESPONSE>
     extends HttpCommonAttributesGetter<REQUEST, RESPONSE>,
         NetworkAttributesGetter<REQUEST, RESPONSE>,
-        ServerAttributesGetter<REQUEST> {
+        ServerAttributesGetter<REQUEST>,
+        UrlAttributesGetter<REQUEST> {
 
   /**
    * Returns the absolute URL describing a network resource according to <a

instrumentation-api/src/main/java/io/opentelemetry/instrumentation/api/semconv/http/HttpSpanNameExtractor.java

@@ -70,10 +70,11 @@ static final class Client<REQUEST> implements SpanNameExtractor<REQUEST> {
     @Override
     public String extract(REQUEST request) {
       String method = getter.getHttpRequestMethod(request);
+      String template = getter.getUrlTemplate(request);
       if (method == null || !knownMethods.contains(method)) {
         return "HTTP";
       }
-      return method;
+      return template == null ? method : method + " " + template;
     }
   }
 

instrumentation-api/src/main/java/io/opentelemetry/instrumentation/api/semconv/url/UrlAttributesGetter.java

@@ -50,4 +50,14 @@ default String getUrlPath(REQUEST request) {
   default String getUrlQuery(REQUEST request) {
     return null;
   }
+
+  /**
+   * Returns the template used to build the full URL (if available)
+   *
+   * <p>Examples: {@code /users/{id}}; {@code /users?q={query}}</p>
+   */
+  @Nullable
+  default String getUrlTemplate(REQUEST request) {
+    return null;
+  }
 }

instrumentation-api/src/main/java/io/opentelemetry/instrumentation/api/semconv/url/internal/InternalUrlAttributesExtractor.java

@@ -7,6 +7,7 @@
 
 import static io.opentelemetry.instrumentation.api.internal.AttributesExtractorUtil.internalSet;
 
+import io.opentelemetry.api.common.AttributeKey;
 import io.opentelemetry.api.common.AttributesBuilder;
 import io.opentelemetry.instrumentation.api.semconv.url.UrlAttributesGetter;
 import io.opentelemetry.semconv.UrlAttributes;
@@ -31,10 +32,12 @@ public void onStart(AttributesBuilder attributes, REQUEST request) {
     String urlScheme = getUrlScheme(request);
     String urlPath = getter.getUrlPath(request);
     String urlQuery = getter.getUrlQuery(request);
+    String urlTemplate = getter.getUrlTemplate(request);
 
     internalSet(attributes, UrlAttributes.URL_SCHEME, urlScheme);
     internalSet(attributes, UrlAttributes.URL_PATH, urlPath);
     internalSet(attributes, UrlAttributes.URL_QUERY, urlQuery);
+    internalSet(attributes, AttributeKey.stringKey("url.template"), urlTemplate);
   }
 
   private String getUrlScheme(REQUEST request) {

instrumentation/ktor/ktor-2-common/library/src/main/kotlin/io/opentelemetry/instrumentation/ktor/v2_0/common/KtorHttpClientAttributesGetter.kt

@@ -7,6 +7,7 @@ package io.opentelemetry.instrumentation.ktor.v2_0.common
 
 import io.ktor.client.request.*
 import io.ktor.client.statement.*
+import io.ktor.util.AttributeKey
 import io.opentelemetry.instrumentation.api.semconv.http.HttpClientAttributesGetter
 
 internal object KtorHttpClientAttributesGetter : HttpClientAttributesGetter<HttpRequestData, HttpResponse> {
@@ -34,4 +35,7 @@ internal object KtorHttpClientAttributesGetter : HttpClientAttributesGetter<Http
   override fun getServerAddress(request: HttpRequestData) = request.url.host
 
   override fun getServerPort(request: HttpRequestData) = request.url.port
+
+  private val urlTemplateAttributeKey = AttributeKey<String>("URL_TEMPLATE")
+  override fun getUrlTemplate(request: HttpRequestData): String? = request.attributes.getOrNull(urlTemplateAttributeKey)
 }