[#9631] Integrate ExceptionContext lifecycle into ExceptionRecordingService

profiler/src/main/java/com/navercorp/pinpoint/profiler/context/AsyncDefaultTrace.java

@@ -2,7 +2,6 @@
 
 import com.navercorp.pinpoint.bootstrap.context.AsyncState;
 import com.navercorp.pinpoint.bootstrap.context.SpanRecorder;
-import com.navercorp.pinpoint.profiler.context.exception.model.ExceptionContext;
 import com.navercorp.pinpoint.profiler.context.recorder.WrappedSpanEventRecorder;
 import com.navercorp.pinpoint.profiler.context.storage.Storage;
 
@@ -16,9 +15,8 @@
                              Storage storage,
                              SpanRecorder spanRecorder,
                              WrappedSpanEventRecorder wrappedSpanEventRecorder,
-                             ExceptionContext exceptionContext,
                              AsyncState asyncState) {
-        super(span, callStack, storage, spanRecorder, wrappedSpanEventRecorder, exceptionContext, CloseListener.EMPTY);
+        super(span, callStack, storage, spanRecorder, wrappedSpanEventRecorder, CloseListener.EMPTY);
         this.asyncState = Objects.requireNonNull(asyncState, "asyncState");
     }
 

profiler/src/main/java/com/navercorp/pinpoint/profiler/context/ChildTrace.java

@@ -23,7 +23,6 @@
 import com.navercorp.pinpoint.bootstrap.context.scope.TraceScope;
 import com.navercorp.pinpoint.common.annotations.VisibleForTesting;
 import com.navercorp.pinpoint.exception.PinpointException;
-import com.navercorp.pinpoint.profiler.context.exception.model.ExceptionContext;
 import com.navercorp.pinpoint.profiler.context.id.TraceRoot;
 import com.navercorp.pinpoint.profiler.context.recorder.WrappedSpanEventRecorder;
 import com.navercorp.pinpoint.profiler.context.scope.DefaultTraceScopePool;
@@ -47,8 +46,6 @@
     private final SpanRecorder spanRecorder;
     private final WrappedSpanEventRecorder wrappedSpanEventRecorder;
 
-    private final ExceptionContext exceptionContext;
-
     private boolean closed = false;
     // lazy initialize
     private DefaultTraceScopePool scopePool;
@@ -58,7 +55,6 @@
 
     public ChildTrace(final TraceRoot traceRoot, CallStack<SpanEvent> callStack, Storage storage,
                       SpanRecorder spanRecorder, WrappedSpanEventRecorder wrappedSpanEventRecorder,
-                      ExceptionContext exceptionContext,
                       final LocalAsyncId localAsyncId) {
 
         this.traceRoot = Objects.requireNonNull(traceRoot, "traceRoot");
@@ -67,7 +63,6 @@
 
         this.spanRecorder = Objects.requireNonNull(spanRecorder, "spanRecorder");
         this.wrappedSpanEventRecorder = Objects.requireNonNull(wrappedSpanEventRecorder, "wrappedSpanEventRecorder");
-        this.exceptionContext = Objects.requireNonNull(exceptionContext, "exceptionRecordingContext");
 
         this.localAsyncId = Objects.requireNonNull(localAsyncId, "localAsyncId");
         traceBlockBegin(ASYNC_BEGIN_STACK_ID);
@@ -79,7 +74,7 @@
     }
 
     private SpanEventRecorder wrappedSpanEventRecorder(WrappedSpanEventRecorder wrappedSpanEventRecorder, SpanEvent spanEvent) {
-        wrappedSpanEventRecorder.setWrapped(spanEvent, this.exceptionContext);
+        wrappedSpanEventRecorder.setWrapped(spanEvent);
         return wrappedSpanEventRecorder;
     }
 
@@ -185,7 +180,7 @@
         } else {
             logSpan();
         }
-
+        this.wrappedSpanEventRecorder.close();
         this.storage.close();
 
     }

profiler/src/main/java/com/navercorp/pinpoint/profiler/context/DefaultBaseTraceFactory.java

@@ -25,8 +25,6 @@
 import com.navercorp.pinpoint.common.annotations.InterfaceAudience;
 import com.navercorp.pinpoint.profiler.context.active.ActiveTraceHandle;
 import com.navercorp.pinpoint.profiler.context.active.ActiveTraceRepository;
-import com.navercorp.pinpoint.profiler.context.exception.model.ExceptionContext;
-import com.navercorp.pinpoint.profiler.context.exception.model.ExceptionContextFactory;
 import com.navercorp.pinpoint.profiler.context.id.ListenableAsyncState;
 import com.navercorp.pinpoint.profiler.context.id.LocalTraceRoot;
 import com.navercorp.pinpoint.profiler.context.id.LoggingAsyncState;
@@ -61,7 +59,6 @@
     private final TraceRootFactory traceRootFactory;
 
     private final ActiveTraceRepository activeTraceRepository;
-    private final ExceptionContextFactory exceptionContextFactory;
     private final UriStatStorage uriStatStorage;
 
     public DefaultBaseTraceFactory(TraceRootFactory traceRootFactory,
@@ -70,7 +67,6 @@
                                    TraceSampler traceSampler,
                                    SpanFactory spanFactory, RecorderFactory recorderFactory,
                                    ActiveTraceRepository activeTraceRepository,
-                                   ExceptionContextFactory exceptionContextFactory,
                                    UriStatStorage uriStatStorage) {
 
         this.traceRootFactory = Objects.requireNonNull(traceRootFactory, "traceRootFactory");
@@ -81,7 +77,6 @@
         this.spanFactory = Objects.requireNonNull(spanFactory, "spanFactory");
         this.recorderFactory = Objects.requireNonNull(recorderFactory, "recorderFactory");
         this.activeTraceRepository = Objects.requireNonNull(activeTraceRepository, "activeTraceRepository");
-        this.exceptionContextFactory = Objects.requireNonNull(exceptionContextFactory, "exceptionContextFactory");
         this.uriStatStorage = Objects.requireNonNull(uriStatStorage, "uriStatStorage");
 
     }
@@ -136,9 +131,8 @@
 
         final SpanRecorder spanRecorder = recorderFactory.newTraceRootSpanRecorder(traceRoot);
         final WrappedSpanEventRecorder wrappedSpanEventRecorder = recorderFactory.newChildTraceSpanEventRecorder(traceRoot);
-        final ExceptionContext exceptionContext = exceptionContextFactory.newExceptionContext(traceRoot);
 
-        return new ChildTrace(traceRoot, callStack, storage, spanRecorder, wrappedSpanEventRecorder, exceptionContext, localAsyncId);
+        return new ChildTrace(traceRoot, callStack, storage, spanRecorder, wrappedSpanEventRecorder, localAsyncId);
     }
 
     @Override
@@ -202,11 +196,10 @@
 
         final SpanRecorder spanRecorder = recorderFactory.newSpanRecorder(span);
         final WrappedSpanEventRecorder wrappedSpanEventRecorder = recorderFactory.newWrappedSpanEventRecorder(traceRoot);
-        final ExceptionContext exceptionContext = exceptionContextFactory.newExceptionContext(traceRoot);
 
         final ActiveTraceHandle handle = registerActiveTrace(traceRoot);
         final CloseListener closeListener = new DefaultCloseListener(traceRoot, handle, uriStatStorage);
-        return new DefaultTrace(span, callStack, storage, spanRecorder, wrappedSpanEventRecorder, exceptionContext, closeListener);
+        return new DefaultTrace(span, callStack, storage, spanRecorder, wrappedSpanEventRecorder, closeListener);
     }
 
     private AsyncDefaultTrace newAsyncDefaultTrace(TraceRoot traceRoot) {
@@ -221,9 +214,8 @@
 
         final SpanRecorder spanRecorder = recorderFactory.newSpanRecorder(span);
         final WrappedSpanEventRecorder wrappedSpanEventRecorder = recorderFactory.newWrappedSpanEventRecorder(traceRoot, asyncState);
-        final ExceptionContext exceptionContext = exceptionContextFactory.newExceptionContext(traceRoot);
 
-        return new AsyncDefaultTrace(span, callStack, storage, spanRecorder, wrappedSpanEventRecorder, exceptionContext, asyncState);
+        return new AsyncDefaultTrace(span, callStack, storage, spanRecorder, wrappedSpanEventRecorder, asyncState);
     }
 
 

profiler/src/main/java/com/navercorp/pinpoint/profiler/context/DefaultTrace.java

@@ -23,7 +23,6 @@
 import com.navercorp.pinpoint.bootstrap.context.scope.TraceScope;
 import com.navercorp.pinpoint.common.annotations.VisibleForTesting;
 import com.navercorp.pinpoint.exception.PinpointException;
-import com.navercorp.pinpoint.profiler.context.exception.model.ExceptionContext;
 import com.navercorp.pinpoint.profiler.context.id.TraceRoot;
 import com.navercorp.pinpoint.profiler.context.recorder.WrappedSpanEventRecorder;
 import com.navercorp.pinpoint.profiler.context.scope.DefaultTraceScopePool;
@@ -50,8 +49,6 @@
     private final SpanRecorder spanRecorder;
     private final WrappedSpanEventRecorder wrappedSpanEventRecorder;
 
-    private final ExceptionContext exceptionContext;
-
     private boolean closed = false;
     // lazy initialize
     private DefaultTraceScopePool scopePool;
@@ -61,15 +58,13 @@
     private final CloseListener closeListener;
 
     public DefaultTrace(Span span, CallStack<SpanEvent> callStack, Storage storage,
-                        SpanRecorder spanRecorder, WrappedSpanEventRecorder wrappedSpanEventRecorder,
-                        ExceptionContext exceptionContext) {
-        this(span, callStack, storage, spanRecorder, wrappedSpanEventRecorder, exceptionContext, CloseListener.EMPTY);
+                        SpanRecorder spanRecorder, WrappedSpanEventRecorder wrappedSpanEventRecorder) {
+        this(span, callStack, storage, spanRecorder, wrappedSpanEventRecorder, CloseListener.EMPTY);
     }
 
     public DefaultTrace(Span span, CallStack<SpanEvent> callStack, Storage storage,
                         SpanRecorder spanRecorder,
                         WrappedSpanEventRecorder wrappedSpanEventRecorder,
-                        ExceptionContext exceptionContext,
                         CloseListener closeListener) {
 
         this.span = Objects.requireNonNull(span, "span");
@@ -78,7 +73,6 @@
 
         this.spanRecorder = Objects.requireNonNull(spanRecorder, "spanRecorder");
         this.wrappedSpanEventRecorder = Objects.requireNonNull(wrappedSpanEventRecorder, "wrappedSpanEventRecorder");
-        this.exceptionContext = Objects.requireNonNull(exceptionContext, "exceptionRecordingContext");
 
         this.closeListener = closeListener;
 
@@ -95,7 +89,7 @@
     }
 
     private SpanEventRecorder wrappedSpanEventRecorder(WrappedSpanEventRecorder wrappedSpanEventRecorder, SpanEvent spanEvent) {
-        wrappedSpanEventRecorder.setWrapped(spanEvent, this.exceptionContext);
+        wrappedSpanEventRecorder.setWrapped(spanEvent);
         return wrappedSpanEventRecorder;
     }
 
@@ -201,7 +195,7 @@
             logSpan();
         }
 
-        this.exceptionContext.flush();
+        this.wrappedSpanEventRecorder.close();
         this.storage.close();
         this.closeListener.close(afterTime);
     }

profiler/src/main/java/com/navercorp/pinpoint/profiler/context/exception/DefaultExceptionRecordingService.java

@@ -22,8 +22,6 @@
 import com.navercorp.pinpoint.profiler.context.exception.model.ExceptionContext;
 import com.navercorp.pinpoint.profiler.context.exception.model.ExceptionWrapperFactory;
 import com.navercorp.pinpoint.profiler.context.exception.sampler.ExceptionTraceSampler;
-import org.apache.logging.log4j.LogManager;
-import org.apache.logging.log4j.Logger;
 
 import java.util.Objects;
 
@@ -32,23 +30,21 @@
  */
 public class DefaultExceptionRecordingService implements ExceptionRecordingService {
 
-    private final Logger logger = LogManager.getLogger(getClass());
-
-    private final boolean IS_DEBUG = logger.isDebugEnabled();
-
     private final ExceptionTraceSampler exceptionTraceSampler;
     private final ExceptionWrapperFactory exceptionWrapperFactory;
+    private final ExceptionContext exceptionContext;
 
     public DefaultExceptionRecordingService(ExceptionTraceSampler exceptionTraceSampler,
-                                            ExceptionWrapperFactory exceptionWrapperFactory
+                                            ExceptionWrapperFactory exceptionWrapperFactory,
+                                            ExceptionContext exceptionContext
     ) {
-        this.exceptionTraceSampler = exceptionTraceSampler;
-        this.exceptionWrapperFactory = exceptionWrapperFactory;
+        this.exceptionTraceSampler = Objects.requireNonNull(exceptionTraceSampler, "exceptionTraceSampler");
+        this.exceptionWrapperFactory = Objects.requireNonNull(exceptionWrapperFactory, "exceptionWrapperFactory");
+        this.exceptionContext = Objects.requireNonNull(exceptionContext, "exceptionContext");
     }
 
-    public void recordException(ExceptionContext context, Throwable current, long startTime) {
-        Objects.requireNonNull(context);
-
+    public void recordException(Throwable current, long startTime) {
+        final ExceptionContext context = this.exceptionContext;
         ExceptionRecordingState state = context.stateOf(current);
         ExceptionTraceSampler.SamplingState samplingState = getSamplingState(state, context);
         state.checkAndApply(context, current, startTime, samplingState, exceptionWrapperFactory);
@@ -68,7 +64,8 @@
         return ExceptionTraceSampler.DISABLED;
     }
 
-    public void recordExceptionIdAnnotation(SpanEvent spanEvent, ExceptionContext context) {
+    public void recordExceptionIdAnnotation(SpanEvent spanEvent) {
+        final ExceptionContext context = this.exceptionContext;
         if (context.hasValidExceptionId()) {
             Annotation<Long> linkId = Annotations.of(AnnotationKey.EXCEPTION_CHAIN_ID.getCode(), context.getExceptionId());
             spanEvent.addAnnotation(linkId);
@@ -77,18 +74,18 @@
 
     @Override
     public void recordException(
-            ExceptionContext exceptionContext,
             SpanEvent spanEvent,
             Throwable throwable
     ) {
         this.recordException(
-                exceptionContext,
                 throwable,
                 spanEvent.getStartTime()
         );
-        this.recordExceptionIdAnnotation(
-                spanEvent,
-                exceptionContext
-        );
+        this.recordExceptionIdAnnotation(spanEvent);
+    }
+
+    @Override
+    public void close() {
+        this.exceptionContext.flush();
     }
 }

profiler/src/main/java/com/navercorp/pinpoint/profiler/context/exception/DefaultExceptionRecordingServiceFactory.java

@@ -0,0 +1,49 @@
+/*
+ * Copyright 2024 NAVER Corp.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+package com.navercorp.pinpoint.profiler.context.exception;
+
+import com.navercorp.pinpoint.profiler.context.exception.model.ExceptionContext;
+import com.navercorp.pinpoint.profiler.context.exception.model.ExceptionContextFactory;
+import com.navercorp.pinpoint.profiler.context.exception.model.ExceptionWrapperFactory;
+import com.navercorp.pinpoint.profiler.context.exception.sampler.ExceptionTraceSampler;
+import com.navercorp.pinpoint.profiler.context.id.TraceRoot;
+
+import java.util.Objects;
+
+public class DefaultExceptionRecordingServiceFactory implements ExceptionRecordingServiceFactory {
+
+    private final ExceptionTraceSampler exceptionTraceSampler;
+    private final ExceptionWrapperFactory exceptionWrapperFactory;
+    private final ExceptionContextFactory exceptionContextFactory;
+
+    public DefaultExceptionRecordingServiceFactory(ExceptionTraceSampler exceptionTraceSampler,
+                                                   ExceptionWrapperFactory exceptionWrapperFactory,
+                                                   ExceptionContextFactory exceptionContextFactory) {
+        this.exceptionTraceSampler = Objects.requireNonNull(exceptionTraceSampler, "exceptionTraceSampler");
+        this.exceptionWrapperFactory = Objects.requireNonNull(exceptionWrapperFactory, "exceptionWrapperFactory");
+        this.exceptionContextFactory = Objects.requireNonNull(exceptionContextFactory, "exceptionContextFactory");
+
+    }
+
+    @Override
+    public ExceptionRecordingService newService(TraceRoot traceRoot) {
+        Objects.requireNonNull(traceRoot, "traceRoot");
+        ExceptionContext exceptionContext = this.exceptionContextFactory.newExceptionContext(traceRoot);
+        return new DefaultExceptionRecordingService(exceptionTraceSampler, exceptionWrapperFactory, exceptionContext);
+    }
+}

profiler/src/main/java/com/navercorp/pinpoint/profiler/context/exception/DisabledExceptionRecordingServiceFactory.java

@@ -0,0 +1,34 @@
+/*
+ * Copyright 2024 NAVER Corp.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+package com.navercorp.pinpoint.profiler.context.exception;
+
+import com.navercorp.pinpoint.profiler.context.exception.disabled.DisabledExceptionRecordingService;
+import com.navercorp.pinpoint.profiler.context.id.TraceRoot;
+
+public class DisabledExceptionRecordingServiceFactory implements ExceptionRecordingServiceFactory {
+
+    public static final ExceptionRecordingServiceFactory INSTANCE = new DisabledExceptionRecordingServiceFactory();
+
+    public DisabledExceptionRecordingServiceFactory() {
+    }
+
+    @Override
+    public ExceptionRecordingService newService(TraceRoot traceRoot) {
+        return DisabledExceptionRecordingService.INSTANCE;
+    }
+}

profiler/src/main/java/com/navercorp/pinpoint/profiler/context/exception/ExceptionRecordingService.java

@@ -16,12 +16,13 @@
 package com.navercorp.pinpoint.profiler.context.exception;
 
 import com.navercorp.pinpoint.profiler.context.SpanEvent;
-import com.navercorp.pinpoint.profiler.context.exception.model.ExceptionContext;
 
 /**
  * @author intr3p1d
  */
-public interface ExceptionRecordingService {
+public interface ExceptionRecordingService extends AutoCloseable {
 
-    void recordException(ExceptionContext exceptionContext, SpanEvent spanEvent, Throwable throwable);
+    void recordException(SpanEvent spanEvent, Throwable throwable);
+
+    void close();
 }