[#9504] Move recordUriTemplate() to SpanRecorder

pinpoint-apm · Dec 15, 2022 · 69981a4 · 69981a4
1 parent ad16219
commit 69981a4
Show file tree

Hide file tree

Showing 13 changed files with 97 additions and 91 deletions.
diff --git a/...s/bootstrap-core/src/main/java/com/navercorp/pinpoint/bootstrap/context/SpanRecorder.java b/...s/bootstrap-core/src/main/java/com/navercorp/pinpoint/bootstrap/context/SpanRecorder.java
@@ -46,4 +46,8 @@ public interface SpanRecorder extends FrameAttachment, AttributeRecorder {
     void recordLogging(LoggingInfo loggingInfo);
 
     void recordStatusCode(int statusCode);
+
+    boolean recordUriTemplate(String uriTemplate);
+
+    boolean recordUriTemplate(String uriTemplate, boolean force);
 }
diff --git a/bootstraps/bootstrap-core/src/main/java/com/navercorp/pinpoint/bootstrap/context/Trace.java b/bootstraps/bootstrap-core/src/main/java/com/navercorp/pinpoint/bootstrap/context/Trace.java
@@ -57,7 +57,4 @@ public interface Trace extends StackOperation {
 
     TraceScope addScope(String name);
 
-    boolean recordUriTemplate(String uriTemplate);
-
-    String getUriTemplate();
 }
diff --git a/.../navercorp/pinpoint/plugin/spring/web/interceptor/ExposePathWithinMappingInterceptor.java b/.../navercorp/pinpoint/plugin/spring/web/interceptor/ExposePathWithinMappingInterceptor.java
@@ -1,16 +1,14 @@
 package com.navercorp.pinpoint.plugin.spring.web.interceptor;
 
+import com.navercorp.pinpoint.bootstrap.context.SpanRecorder;
 import com.navercorp.pinpoint.bootstrap.context.Trace;
 import com.navercorp.pinpoint.bootstrap.context.TraceContext;
 import com.navercorp.pinpoint.bootstrap.interceptor.AroundInterceptor;
 import com.navercorp.pinpoint.common.util.ArrayArgumentUtils;
-import com.navercorp.pinpoint.plugin.spring.web.SpringWebMvcConstants;
 
-import javax.servlet.ServletRequest;
-import javax.servlet.http.HttpServletRequest;
 
 public class ExposePathWithinMappingInterceptor implements AroundInterceptor {
-    private TraceContext traceContext;
+    private final TraceContext traceContext;
 
 
     public ExposePathWithinMappingInterceptor(final TraceContext traceContext) {
@@ -23,10 +21,11 @@ public void before(Object target, Object[] args) {
 
     @Override
     public void after(Object target, Object[] args, Object result, Throwable throwable) {
-        Trace trace = traceContext.currentRawTraceObject();
+        final Trace trace = traceContext.currentRawTraceObject();
         if (trace != null) {
             String url = ArrayArgumentUtils.getArgument(args, 0, String.class);
-            trace.recordUriTemplate(url);
+            SpanRecorder spanRecorder = trace.getSpanRecorder();
+            spanRecorder.recordUriTemplate(url);
         }
     }
 }
diff --git a/.../com/navercorp/pinpoint/plugin/spring/web/interceptor/LookupHandlerMethodInterceptor.java b/.../com/navercorp/pinpoint/plugin/spring/web/interceptor/LookupHandlerMethodInterceptor.java
@@ -1,5 +1,6 @@
 package com.navercorp.pinpoint.plugin.spring.web.interceptor;
 
+import com.navercorp.pinpoint.bootstrap.context.SpanRecorder;
 import com.navercorp.pinpoint.bootstrap.context.Trace;
 import com.navercorp.pinpoint.bootstrap.context.TraceContext;
 import com.navercorp.pinpoint.bootstrap.interceptor.AroundInterceptor;
@@ -9,7 +10,7 @@
 import javax.servlet.ServletRequest;
 
 public class LookupHandlerMethodInterceptor implements AroundInterceptor {
-    private TraceContext traceContext;
+    private final TraceContext traceContext;
 
 
     public LookupHandlerMethodInterceptor(final TraceContext traceContext) {
@@ -22,11 +23,12 @@ public void before(Object target, Object[] args) {
 
     @Override
     public void after(Object target, Object[] args, Object result, Throwable throwable) {
-        Trace trace = traceContext.currentRawTraceObject();
+        final Trace trace = traceContext.currentRawTraceObject();
         if (trace != null) {
             ServletRequest arg = ArrayArgumentUtils.getArgument(args, 1, ServletRequest.class);
             String url = (String) arg.getAttribute(SpringWebMvcConstants.SPRING_MVC_DEFAULT_URI_ATTRIBUTE_KEY);
-            trace.recordUriTemplate(url);
+            SpanRecorder spanRecorder = trace.getSpanRecorder();
+            spanRecorder.recordUriTemplate(url);
         }
     }
 }
diff --git a/.../src/main/java/com/navercorp/pinpoint/plugin/vertx/interceptor/RouteStateInterceptor.java b/.../src/main/java/com/navercorp/pinpoint/plugin/vertx/interceptor/RouteStateInterceptor.java
@@ -1,5 +1,6 @@
 package com.navercorp.pinpoint.plugin.vertx.interceptor;
 
+import com.navercorp.pinpoint.bootstrap.context.SpanRecorder;
 import com.navercorp.pinpoint.bootstrap.context.Trace;
 import com.navercorp.pinpoint.bootstrap.context.TraceContext;
 import com.navercorp.pinpoint.bootstrap.interceptor.AroundInterceptor;
@@ -32,32 +33,32 @@ public void before(Object target, Object[] args) {
     public void after(Object target, Object[] args, Object result, Throwable throwable) {
         final RoutingContext routingContext = ArrayArgumentUtils.getArgument(args, 0, RoutingContext.class);
         if (routingContext != null) {
-            Trace trace = context.currentRawTraceObject();
-
+            final Trace trace = context.currentRawTraceObject();
+            if (trace == null) {
+                return;
+            }
             if (uriStatUseUserInput) {
                 if (recordWithUserInput(routingContext, trace)) {
                     return;
                 }
             }
-            Route route = routingContext.currentRoute();
-
+            final Route route = routingContext.currentRoute();
             if (route != null) {
                 String path = route.getPath();
                 logger.debug("vertx uriTemplate:{}", path);
-
-                if (trace != null) {
-                    trace.recordUriTemplate(path);
-                }
+                SpanRecorder spanRecorder = trace.getSpanRecorder();
+                spanRecorder.recordUriTemplate(path);
             }
 
         }
     }
 
     private boolean recordWithUserInput(RoutingContext routingContext, Trace trace) {
-        for(String key : VertxConstants.VERTX_URI_MAPPING_CONTEXT_KEYS) {
-            String value = routingContext.get(key);
-            if ((value != null) && (trace != null)) {
-                trace.recordUriTemplate(value);
+        for (String key : VertxConstants.VERTX_URI_MAPPING_CONTEXT_KEYS) {
+            String userUriTemplate = routingContext.get(key);
+            if (userUriTemplate != null) {
+                SpanRecorder spanRecorder = trace.getSpanRecorder();
+                spanRecorder.recordUriTemplate(userUriTemplate);
                 return true;
             }
         }

diff --git a/profiler/src/main/java/com/navercorp/pinpoint/profiler/context/AsyncChildTrace.java b/profiler/src/main/java/com/navercorp/pinpoint/profiler/context/AsyncChildTrace.java
@@ -303,16 +303,6 @@ public TraceScope addScope(String name) {
         return scopePool.add(name);
     }
 
-    @Override
-    public boolean recordUriTemplate(String uriTemplate) {
-        return getTraceRoot().getShared().setUriTemplate(uriTemplate);
-    }
-
-    @Override
-    public String getUriTemplate() {
-        return getTraceRoot().getShared().getUriTemplate();
-    }
-
     @Override
     public String toString() {
         return "AsyncChildTrace{" +

diff --git a/profiler/src/main/java/com/navercorp/pinpoint/profiler/context/AsyncTrace.java b/profiler/src/main/java/com/navercorp/pinpoint/profiler/context/AsyncTrace.java
@@ -149,16 +149,6 @@ public TraceScope addScope(String name) {
         return trace.addScope(name);
     }
 
-    @Override
-    public boolean recordUriTemplate(String uriTemplate) {
-        return traceRoot.getShared().setUriTemplate(uriTemplate);
-    }
-
-    @Override
-    public String getUriTemplate() {
-        return traceRoot.getShared().getUriTemplate();
-    }
-
     @Override
     public String toString() {
         return "AsyncTrace{" +

diff --git a/profiler/src/main/java/com/navercorp/pinpoint/profiler/context/DefaultTrace.java b/profiler/src/main/java/com/navercorp/pinpoint/profiler/context/DefaultTrace.java
@@ -353,16 +353,6 @@ public TraceScope addScope(String name) {
         return scopePool.add(name);
     }
 
-    @Override
-    public boolean recordUriTemplate(String uriTemplate) {
-        return getTraceRoot().getShared().setUriTemplate(uriTemplate);
-    }
-
-
-    @Override
-    public String getUriTemplate() {
-        return getTraceRoot().getShared().getUriTemplate();
-    }
 
     @Override
     public String toString() {

diff --git a/profiler/src/main/java/com/navercorp/pinpoint/profiler/context/DisableAsyncChildTrace.java b/profiler/src/main/java/com/navercorp/pinpoint/profiler/context/DisableAsyncChildTrace.java
@@ -144,15 +144,6 @@ public TraceScope addScope(String name) {
         return scopePool.add(name);
     }
 
-    @Override
-    public boolean recordUriTemplate(String uriTemplate) {
-        return traceRoot.getShared().setUriTemplate(uriTemplate);
-    }
-
-    @Override
-    public String getUriTemplate() {
-        return getTraceRoot().getShared().getUriTemplate();
-    }
 
     @Override
     public String toString() {

diff --git a/profiler/src/main/java/com/navercorp/pinpoint/profiler/context/DisableTrace.java b/profiler/src/main/java/com/navercorp/pinpoint/profiler/context/DisableTrace.java
@@ -22,6 +22,7 @@
 import com.navercorp.pinpoint.bootstrap.context.TraceId;
 import com.navercorp.pinpoint.bootstrap.context.scope.TraceScope;
 import com.navercorp.pinpoint.profiler.context.active.ActiveTraceHandle;
+import com.navercorp.pinpoint.profiler.context.id.Shared;
 import com.navercorp.pinpoint.profiler.context.id.TraceRoot;
 import com.navercorp.pinpoint.profiler.context.scope.DefaultTraceScopePool;
 import com.navercorp.pinpoint.profiler.context.storage.UriStatStorage;
@@ -128,12 +129,16 @@ public void close() {
         final long purgeTime = System.currentTimeMillis();
         handle.purge(purgeTime);
         boolean status = getStatus();
-        String uriTemplate = traceRoot.getShared().getUriTemplate();
+        String uriTemplate = getShared().getUriTemplate();
         uriStatStorage.store(uriTemplate, status, traceRoot.getTraceStartTime(), purgeTime);
     }
 
     private boolean getStatus() {
-        return traceRoot.getShared().getErrorCode() == 0;
+        return getShared().getErrorCode() == 0;
+    }
+
+    private Shared getShared() {
+        return traceRoot.getShared();
     }
 
 
@@ -168,13 +173,4 @@ public TraceScope addScope(String name) {
         return scopePool.add(name);
     }
 
-    @Override
-    public boolean recordUriTemplate(String uriTemplate) {
-        return this.traceRoot.getShared().setUriTemplate(uriTemplate);
-    }
-
-    @Override
-    public String getUriTemplate() {
-        return this.traceRoot.getShared().getUriTemplate();
-    }
 }
diff --git a/...r/src/main/java/com/navercorp/pinpoint/profiler/context/recorder/DefaultSpanRecorder.java b/...r/src/main/java/com/navercorp/pinpoint/profiler/context/recorder/DefaultSpanRecorder.java
@@ -22,11 +22,11 @@
 import com.navercorp.pinpoint.profiler.context.DefaultTrace;
 import com.navercorp.pinpoint.profiler.context.Span;
 import com.navercorp.pinpoint.profiler.context.errorhandler.IgnoreErrorHandler;
-import com.navercorp.pinpoint.profiler.context.id.TraceRoot;
+import com.navercorp.pinpoint.profiler.context.id.Shared;
 import com.navercorp.pinpoint.profiler.metadata.SqlMetaDataService;
 import com.navercorp.pinpoint.profiler.metadata.StringMetaDataService;
-import org.apache.logging.log4j.Logger;
 import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 
 /**
  * 
@@ -66,8 +66,7 @@ void setExceptionInfo(int exceptionClassId, String exceptionMessage) {
 
     @Override
     void maskErrorCode(final int errorCode) {
-        final TraceRoot traceRoot = span.getTraceRoot();
-        traceRoot.getShared().maskErrorCode(errorCode);
+        getShared().maskErrorCode(errorCode);
     }
 
     @Override
@@ -92,7 +91,7 @@ public void recordServiceType(ServiceType serviceType) {
     @Override
     public void recordRpcName(String rpc) {
 //        span.setRpc(rpc);
-        span.getTraceRoot().getShared().setRpcName(rpc);
+        getShared().setRpcName(rpc);
     }
 
     @Override
@@ -103,7 +102,7 @@ public void recordRemoteAddress(String remoteAddress) {
     @Override
     public void recordEndPoint(String endPoint) {
 //        span.setEndPoint(endPoint);
-        span.getTraceRoot().getShared().setEndPoint(endPoint);
+        getShared().setEndPoint(endPoint);
     }
 
     @Override
@@ -135,8 +134,7 @@ public boolean isRoot() {
 
     @Override
     public void recordLogging(LoggingInfo loggingInfo) {
-        final TraceRoot traceRoot = span.getTraceRoot();
-        traceRoot.getShared().setLoggingInfo(loggingInfo.getCode());
+        getShared().setLoggingInfo(loggingInfo.getCode());
     }
 
     @Override
@@ -170,6 +168,21 @@ public Object detachFrameObject() {
 
     @Override
     public void recordStatusCode(int statusCode) {
-        span.getTraceRoot().getShared().setStatusCode(statusCode);
+        getShared().setStatusCode(statusCode);
+    }
+
+    private Shared getShared() {
+        return span.getTraceRoot().getShared();
+    }
+
+    @Override
+    public boolean recordUriTemplate(String uriTemplate) {
+        return recordUriTemplate(uriTemplate, false);
+    }
+
+
+    @Override
+    public boolean recordUriTemplate(String uriTemplate, boolean force) {
+        return getShared().setUriTemplate(uriTemplate, force);
     }
 }
diff --git a/...r/src/main/java/com/navercorp/pinpoint/profiler/context/recorder/DisableSpanRecorder.java b/...r/src/main/java/com/navercorp/pinpoint/profiler/context/recorder/DisableSpanRecorder.java
@@ -23,6 +23,7 @@
 import com.navercorp.pinpoint.common.trace.ServiceType;
 import com.navercorp.pinpoint.common.util.DataType;
 import com.navercorp.pinpoint.profiler.context.errorhandler.IgnoreErrorHandler;
+import com.navercorp.pinpoint.profiler.context.id.Shared;
 import com.navercorp.pinpoint.profiler.context.id.TraceRoot;
 
 import java.util.Objects;
@@ -61,7 +62,7 @@ public void recordTime(boolean autoTimeRecoding) {
 
     @Override
     public void recordError() {
-        traceRoot.getShared().maskErrorCode(1);
+        getShared().maskErrorCode(1);
     }
 
     @Override
@@ -192,6 +193,22 @@ public void recordLogging(LoggingInfo loggingInfo) {
 
     @Override
     public void recordStatusCode(int statusCode) {
+        getShared().setStatusCode(statusCode);
+    }
+
+    @Override
+    public boolean recordUriTemplate(String uriTemplate) {
+        return recordUriTemplate(uriTemplate, false);
+    }
+
+
+    @Override
+    public boolean recordUriTemplate(String uriTemplate, boolean force) {
+        return getShared().setUriTemplate(uriTemplate, force);
+    }
+
+    private Shared getShared() {
+        return traceRoot.getShared();
     }
 
     @Override