From 08b44f1894ed6437f3da7779693a9c2ea3df685a Mon Sep 17 00:00:00 2001 From: Kurru Date: Thu, 21 Jul 2022 19:35:48 -0700 Subject: [PATCH] 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 https://github.com/aws/aws-xray-sdk-java/issues/318 for details. --- .../src/main/java/com/amazonaws/xray/entities/Subsegment.java | 4 ++-- 1 file changed, 2 insertions(+), 2 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 index 8276967c..9a9f38e8 100644 --- 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 @@ -87,7 +87,7 @@ static Subsegment noOp(Segment parent, AWSXRayRecorder recorder) { /** * Serializes the subsegment as a standalone String with enough information for the subsegment to be streamed on its own. * @return - * the string representation of the subsegment with enouogh information for it to be streamed + * the string representation of the subsegment with enough information for it to be streamed */ String streamSerialize(); @@ -96,7 +96,7 @@ static Subsegment noOp(Segment parent, AWSXRayRecorder recorder) { * own. Only used for debugging. * * @return - * the pretty string representation of the subsegment with enouogh information for it to be streamed + * the pretty string representation of the subsegment with enough information for it to be streamed */ String prettyStreamSerialize();