Add javadoc to Subsegment.close() method.

This method should not be used to end subsegments for segments using multiple threads as this can result in a deadlock. See #318 for details.
aws · Jul 27, 2022 · 6f25e12 · 6f25e12
1 parent 6f29232
commit 6f25e12
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/aws-xray-recorder-sdk-core/src/main/java/com/amazonaws/xray/entities/Subsegment.java b/aws-xray-recorder-sdk-core/src/main/java/com/amazonaws/xray/entities/Subsegment.java
@@ -100,6 +100,12 @@ static Subsegment noOp(Segment parent, AWSXRayRecorder recorder) {
      */
     String prettyStreamSerialize();
 
+    /**
+     * Implements the {@link AutoCloseable} interface.
+     *
+     * <p>Warning. Avoid using this to end subsegments in asynchronous methods or other threads as this can cause
+     * deadlocks. Instead, use {@link com.amazonaws.xray.AWSXRay#endSubsegment(Subsegment)}.
+     */
     @Override
     void close();
 }