Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add javadoc to Subsegment.close() method. #342

Merged
merged 1 commit into from
Jul 28, 2022

Conversation

Kurru
Copy link
Contributor

@Kurru Kurru commented Jul 22, 2022

Issue #, if available:
#318

Description of changes:
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.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@Kurru Kurru requested a review from a team as a code owner July 22, 2022 02:37
@codecov-commenter
Copy link

Codecov Report

Merging #342 (fe0bdec) into master (7e7d732) will decrease coverage by 0.01%.
The diff coverage is 0.00%.

@@             Coverage Diff              @@
##             master     #342      +/-   ##
============================================
- Coverage     58.96%   58.95%   -0.02%     
  Complexity     1207     1207              
============================================
  Files           131      131              
  Lines          5064     5065       +1     
  Branches        592      592              
============================================
  Hits           2986     2986              
- Misses         1805     1806       +1     
  Partials        273      273              
Impacted Files Coverage Δ
...n/java/com/amazonaws/xray/emitters/UDPEmitter.java 30.55% <0.00%> (-0.88%) ⬇️
...n/java/com/amazonaws/xray/entities/Subsegment.java 100.00% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7e7d732...fe0bdec. Read the comment docs.

@Kurru Kurru force-pushed the subsegment-close-doc branch 2 times, most recently from 08b44f1 to 00a0723 Compare July 27, 2022 00:16
@jj22ee
Copy link
Contributor

jj22ee commented Jul 27, 2022

Hi @Kurru, could you change your javadoc as the .close() method is not designed for external use and should not be used externally in general, rather than for a specific use case?

@Kurru Kurru force-pushed the subsegment-close-doc branch 2 times, most recently from 402fefd to 31147a9 Compare July 27, 2022 23:50
@Kurru
Copy link
Contributor Author

Kurru commented Jul 27, 2022

I have updated the javadoc as requested. Let me know if this new wording is insufficient.

This method should not be used to end subsegments for segments using multiple threads as this can result in a deadlock. See aws#318 for details.
@Kurru Kurru force-pushed the subsegment-close-doc branch from 31147a9 to ba7a37b Compare July 28, 2022 00:09
@jj22ee jj22ee merged commit 5981f27 into aws:master Jul 28, 2022
@Kurru Kurru deleted the subsegment-close-doc branch July 28, 2022 00:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants