[pinpoint-apm#10041] Add collected uri type option for spans

ga-ram · Jun 15, 2023 · 7f01d6d · 7f01d6d
1 parent b387f49
commit 7f01d6d
Show file tree

Hide file tree

Showing 4 changed files with 37 additions and 6 deletions.
diff --git a/agent/src/main/resources/pinpoint-root.config b/agent/src/main/resources/pinpoint-root.config
@@ -403,4 +403,14 @@ pinpoint.banner.configs=pinpoint.profiler.profiles.active,\
                         profiler.sampling.enable,\
                         profiler.sampling.type,\
                         profiler.sampling.counting.sampling-rate,\
-                        profiler.sampling.percent.sampling-rate
+                        profiler.sampling.percent.sampling-rate
+
+###########################################################
+# SPAN COLLECTED URL TYPE                                 #
+###########################################################
+# Collected URI Type for profiler : TEMPLATE (default), RAW
+# e.g.)
+# Collected URI for each type for a request `/randomResponseTime/50` mapped to `@RequestMapping("/randomResponseTime/**")`
+# TEMPLATE (default) : `/randomResponseTime/**`
+# RAW : `/randomResponseTime/50`
+profiler.span.collected.uri.type=TEMPLATE
diff --git a/.../src/main/java/com/navercorp/pinpoint/profiler/context/grpc/GrpcSpanMessageConverter.java b/.../src/main/java/com/navercorp/pinpoint/profiler/context/grpc/GrpcSpanMessageConverter.java
@@ -80,11 +80,19 @@ public class GrpcSpanMessageConverter implements MessageConverter<SpanType, Gene
 
     private final PAnnotation.Builder pAnnotationBuilder = PAnnotation.newBuilder();
 
+    public enum SpanUriType {
+        TEMPLATE, RAW
+    }
+
+    private final SpanUriType spanCollectedUriType;
+
     public GrpcSpanMessageConverter(String agentId, short applicationServiceType,
-                                    SpanProcessor<PSpan.Builder, PSpanChunk.Builder> spanProcessor) {
+                                    SpanProcessor<PSpan.Builder, PSpanChunk.Builder> spanProcessor,
+                                    String spanCollectedUriType) {
         this.agentId = Objects.requireNonNull(agentId, "agentId");
         this.applicationServiceType = applicationServiceType;
         this.spanProcessor = Objects.requireNonNull(spanProcessor, "spanProcessor");
+        this.spanCollectedUriType = SpanUriType.valueOf(spanCollectedUriType);
     }
 
     @Override
@@ -188,7 +196,13 @@ private PAcceptEvent newAcceptEvent(Span span) {
         }
 
         final Shared shared = span.getTraceRoot().getShared();
-        final String rpc = shared.getRpcName();
+        final String rpc;
+        if (spanCollectedUriType == SpanUriType.RAW) {
+            rpc = shared.getRpcName();
+        } else {
+            rpc = shared.getUriTemplate();
+        }
+
         if (StringUtils.isEmpty(rpc)) {
             hasEmptyValue = true;
             builder.setRpc(DEFAULT_RPC_NAME);

diff --git a/...n/java/com/navercorp/pinpoint/profiler/context/grpc/GrpcSpanMessageConverterProvider.java b/...n/java/com/navercorp/pinpoint/profiler/context/grpc/GrpcSpanMessageConverterProvider.java
@@ -19,6 +19,7 @@
 import com.google.inject.Inject;
 import com.google.inject.Provider;
 import com.google.protobuf.GeneratedMessageV3;
+import com.navercorp.pinpoint.bootstrap.config.ProfilerConfig;
 import com.navercorp.pinpoint.common.profiler.message.MessageConverter;
 import com.navercorp.pinpoint.common.trace.ServiceType;
 import com.navercorp.pinpoint.grpc.trace.PSpan;
@@ -34,22 +35,28 @@
  * @author Woonduk Kang(emeroad)
  */
 public class GrpcSpanMessageConverterProvider implements Provider<MessageConverter<SpanType, GeneratedMessageV3>> {
+    public static final String SPAN_COLLECTED_URI_CONFIG = "profiler.span.collected.uri.type";
 
     private final String agentId;
     private final short applicationServiceTypeCode;
 
     private final SpanProcessor<PSpan.Builder, PSpanChunk.Builder> spanPostProcessor;
 
+    private final String spanCollectedUriType;
+
     @Inject
     public GrpcSpanMessageConverterProvider(@AgentId String agentId, @ApplicationServerType ServiceType applicationServiceType,
-                                            SpanProcessor<PSpan.Builder, PSpanChunk.Builder> spanPostProcessor) {
+                                            SpanProcessor<PSpan.Builder, PSpanChunk.Builder> spanPostProcessor,
+                                            ProfilerConfig profilerConfig) {
         this.agentId = Objects.requireNonNull(agentId, "agentId");
         this.applicationServiceTypeCode = applicationServiceType.getCode();
         this.spanPostProcessor = Objects.requireNonNull(spanPostProcessor, "spanPostProcessor");
+        Objects.requireNonNull(profilerConfig, "profilerConfig");
+        this.spanCollectedUriType = profilerConfig.readString(SPAN_COLLECTED_URI_CONFIG, "TEMPLATE");
     }
 
     @Override
     public MessageConverter<SpanType, GeneratedMessageV3> get() {
-        return new GrpcSpanMessageConverter(agentId, applicationServiceTypeCode, spanPostProcessor);
+        return new GrpcSpanMessageConverter(agentId, applicationServiceTypeCode, spanPostProcessor, spanCollectedUriType);
     }
 }
diff --git a/...c/test/java/com/navercorp/pinpoint/profiler/context/compress/GrpcSpanProcessorV2Test.java b/...c/test/java/com/navercorp/pinpoint/profiler/context/compress/GrpcSpanProcessorV2Test.java
@@ -37,7 +37,7 @@ public class GrpcSpanProcessorV2Test {
 
     private SpanProcessor<PSpan.Builder, PSpanChunk.Builder> spanProcessorProtoV2 = new GrpcSpanProcessorV2();
 
-    private GrpcSpanMessageConverter converter = new GrpcSpanMessageConverter("agentId", (short) 1, spanProcessorProtoV2);
+    private GrpcSpanMessageConverter converter = new GrpcSpanMessageConverter("agentId", (short) 1, spanProcessorProtoV2, "TEMPLATE");
 
     @Test
     public void preProcess() {