Log at debug when completeSpan methods are used with no active trace (

#1016) Log at debug when `completeSpan` methods are used with no active trace
palantir · Mar 15, 2023 · ee89d8e · ee89d8e
1 parent 3dacba3
commit ee89d8e
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/changelog/@unreleased/pr-1016.v2.yml b/changelog/@unreleased/pr-1016.v2.yml
@@ -0,0 +1,5 @@
+type: improvement
+improvement:
+  description: Log at debug when `completeSpan` methods are used with no active trace
+  links:
+  - https://github.com/palantir/tracing-java/pull/1016
diff --git a/tracing/src/main/java/com/palantir/tracing/Tracer.java b/tracing/src/main/java/com/palantir/tracing/Tracer.java
@@ -640,6 +640,11 @@ public static <T> void fastCompleteSpan(TagTranslator<? super T> tag, T state) {
             if (trace.isObservable()) {
                 completeSpanAndNotifyObservers(span, tag, state, trace.getTraceId());
             }
+        } else if (log.isDebugEnabled()) {
+            log.debug(
+                    "Attempted to complete spans when there is no active Trace. This may be the "
+                            + "result of calling completeSpan more times than startSpan",
+                    new SafeRuntimeException("not a real exception"));
         }
     }
 
@@ -671,6 +676,12 @@ public static Optional<Span> completeSpan() {
     public static Optional<Span> completeSpan(@Safe Map<String, String> metadata) {
         Trace trace = currentTrace.get();
         if (trace == null) {
+            if (log.isDebugEnabled()) {
+                log.debug(
+                        "Attempted to complete spans when there is no active Trace. This may be the "
+                                + "result of calling completeSpan more times than startSpan",
+                        new SafeRuntimeException("not a real exception"));
+            }
             return Optional.empty();
         }
         Optional<Span> maybeSpan = popCurrentSpan(trace)