8308475: Make the thread dump files generated by jcmd Thread.dump_to_file jtreg failure handler action easily accessible

[jaikiran]

Can I please get a review of this change which proposes to improve the accessibility of the thread dump files that are generated by the jcmd Thread.dump_to_file command configured in the failure handler configurations? This addresses https://bugs.openjdk.org/browse/JDK-8308475.

The changes in this PR include:

• Enhancement to GatherProcessInfoTimeoutHandler to allow configuring a successArtifacts action parameter which can be used to generate links to files that are generated by the failure handler commands.
• Introduction of a %iterCount token to allow ability to refer to the current iteration when the command is repeated
• The jcmd Thread.dump_to_file is now configured to create the thread dumps in json format. Additionally, it has now been configured to create the thread dumps 6 times, just like the jstack command.

Detailed explanation of the successArtifacts parameter and the %iterCount token is provided in the JBS comment here https://bugs.openjdk.org/browse/JDK-8308475?focusedCommentId=14583072&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-14583072

Tests have been run locally with this change and tier1, tier2 and tier3 tests on CI system to verify this change works and doesn't cause regression.

---

Progress

• Change must be properly reviewed (1 review required, with at least 1 Reviewer)
• Change must not contain extraneous whitespace
• Commit message must refer to an issue

Issue

• JDK-8308475: Make the thread dump files generated by jcmd Thread.dump_to_file jtreg failure handler action easily accessible

Reviewers

• Leonid Mesnik (@lmesnik - Reviewer)

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk.git pull/14071/head:pull/14071
$ git checkout pull/14071

Update a local copy of the PR:
$ git checkout pull/14071
$ git pull https://git.openjdk.org/jdk.git pull/14071/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 14071

View PR using the GUI difftool:
$ git pr show -t 14071

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/14071.diff

Webrev

Link to Webrev Comment

[bridgekeeper]

👋 Welcome back jpai! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

[openjdk]

@jaikiran The following label will be automatically applied to this pull request:

• core-libs

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing list. If you would like to change these labels, use the /label pull request command.

[jaikiran]

Here's how the link to the thread dump file will look like with these current changes, in the processes.html:

[mlbridge]

Webrevs

• 00: Full (0cd74c79)

[AlanBateman]

/add label hotspot

[openjdk]

@AlanBateman Unknown command add - for a list of valid commands use /help.

[AlanBateman]

/label add hotspot

[openjdk]

@AlanBateman
The hotspot label was successfully added.

[AlanBateman]

@lmesnik Do you have cycles to look at this?

[lmesnik]

Cool!

[openjdk]

@jaikiran This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

8308475: Make the thread dump files generated by jcmd Thread.dump_to_file jtreg failure handler action easily accessible

Reviewed-by: lmesnik

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been 71 new commits pushed to the master branch:

• 1451ac1: 8307652: sealed class hierarchy graph doesn't distinguish non-sealed classes
• 207fbcb: 8299414: JVMTI FollowReferences should support references from VirtualThread stack
• b44fa36: 8308040: Evaluate new public types in non-public classes
• ac89e30: 8308291: compiler/jvmci/meta/ProfilingInfoTest.java fails with -XX:TieredStopAtLevel=1
• bacf652: 8297887: Update Siphash
• 89f2d45: 8308237: add JDWP and JDI virtual thread support for ThreadReference.PopFrames
• d10467e: 8307738: JFR: EventStream.openRepository() drops events
• 736b90d: 8308310: HttpClient: Avoid logging or locking from within synchronized blocks
• 7764f46: 8308761: New test TestHFA needs adaptation for JDK-8308276
• d7245f7: 8305578: X11GraphicsDevice.pGetBounds() is slow in remote X11 sessions
• ... and 61 more: https://git.openjdk.org/jdk/compare/5ccc9629424c802a5c676553776ee5d2fb2ca3e3...master

As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

[jaikiran]

Thank you Leonid for the review.

Since this is tagged hotspot, can I please get a second Reviewer to review this please?

[dholmes-ora]

@jaikiran I don't know why @AlanBateman tagged this as Hotspot as there are no hotspot related changes. Perhaps it was just for visibility of shared failure handler changes? But I don't think you need a Hotspot review here.

[AlanBateman]

@jaikiran I don't know why @AlanBateman tagged this as Hotspot as there are no hotspot related changes. Perhaps it was just for visibility of shared failure handler changes?

config/mailinglist/rules/jdk.json (in the skara repo) maps changes to test/failure_handler/ to core-libs but changes to the jtreg failure handler are of wider interest. It looks like changes to the handler have previously been cc'ed to the hotspot list too.

[jaikiran]

Thank you all for the help. I'll go ahead and integrate this.

[jaikiran]

/integrate

[openjdk]

Going to push as commit 426ebf4.
Since your change was applied there have been 81 commits pushed to the master branch:

• 8d8153e: 8307958: Metaspace verification is slow causing extreme class unloading times
• d877134: 8144891: ToolBox should use java.nio.file.Path internally, instead of java.io.File
• aaa6189: 8308506: Reduce testing time by removing combinations tested
• 4500bb7: 8308727: Compiler should accept final unnamed variables in try-with-resources
• 3272e25: 8305710: Line breaks in search tags cause invalid JSON in index file
• 3f4abff: 8305958: Use links instead of buttons for auto-generated header links
• bfcae68: 8308549: Classfile API should fail to generate over-sized Code attribute
• 2a18e53: 8308656: RISC-V: vstring_compare doesnt manifest usage of all vector registers
• a291f00: 8288619: Unexpected parsing for @see
• 89b9914: 8308400: add ForceEarlyReturn support for virtual threads
• ... and 71 more: https://git.openjdk.org/jdk/compare/5ccc9629424c802a5c676553776ee5d2fb2ca3e3...master

Your commit was automatically rebased without conflicts.

[openjdk]

@jaikiran Pushed as commit 426ebf4.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.