[JENKINS-72579] Adjust heap dump file name for compatibility with OpenJDK file suffix requirements #8881

balaji-sivasakthi · 2024-01-19T22:39:38Z

See JENKINS-72579

Testing done

Done

Proposed changelog entries

Adjust heap dump file name for compatibility with OpenJDK file suffix requirements.

Proposed upgrade guidelines

N/A

Submitter checklist

Give feedback

The Jira issue, if it exists, is well-described.

The Jira issue, if it exists, is well-described.
Options
Successfully updated the issue's project

There was an error updating the issue's project
The changelog entries and upgrade guidelines are appropriate for the audience affected by the change (users or developers, depending on the change) and are in the imperative mood (see [examples](https://github.com/jenkins-infra/jenkins.io/blob/master/content/_data/changelogs/weekly.yml)). Fill in the **Proposed upgrade guidelines** section only if there are breaking changes or changes that may require extra steps from users during upgrade.

The changelog entries and upgrade guidelines are appropriate for the audience affected by the change (users or developers, depending on the change) and are in the imperative mood (see examples). Fill in the Proposed upgrade guidelines section only if there are breaking changes or changes that may require extra steps from users during upgrade.
Options
Successfully updated the issue's project

There was an error updating the issue's project
There is automated testing or an explanation as to why this change has no tests.

There is automated testing or an explanation as to why this change has no tests.
Options
Successfully updated the issue's project

There was an error updating the issue's project
New public classes, fields, and methods are annotated with `@Restricted` or have `@since TODO` Javadocs, as appropriate.

New public classes, fields, and methods are annotated with @Restricted or have @since TODO Javadocs, as appropriate.
Options
Successfully updated the issue's project

There was an error updating the issue's project
New deprecations are annotated with `@Deprecated(since = "TODO")` or `@Deprecated(forRemoval = true, since = "TODO")`, if applicable.

New deprecations are annotated with @Deprecated(since = "TODO") or @Deprecated(forRemoval = true, since = "TODO"), if applicable.
Options
Successfully updated the issue's project

There was an error updating the issue's project
New or substantially changed JavaScript is not defined inline and does not call `eval` to ease future introduction of Content Security Policy (CSP) directives (see [documentation](https://www.jenkins.io/doc/developer/security/csp/)).

New or substantially changed JavaScript is not defined inline and does not call eval to ease future introduction of Content Security Policy (CSP) directives (see documentation).
Options
Successfully updated the issue's project

There was an error updating the issue's project
For dependency updates, there are links to external changelogs and, if possible, full differentials.

For dependency updates, there are links to external changelogs and, if possible, full differentials.
Options
Successfully updated the issue's project

There was an error updating the issue's project
For new APIs and extension points, there is a link to at least one consumer.

For new APIs and extension points, there is a link to at least one consumer.
Options
Successfully updated the issue's project

There was an error updating the issue's project
Options

Desired reviewers

@mention

Before the changes are marked as ready-for-merge:

Maintainer checklist

Give feedback

There are at least two (2) approvals for the pull request and no outstanding requests for change.

There are at least two (2) approvals for the pull request and no outstanding requests for change.
Options
Successfully updated the issue's project

There was an error updating the issue's project
Conversations in the pull request are over, or it is explicit that a reviewer is not blocking the change.

Conversations in the pull request are over, or it is explicit that a reviewer is not blocking the change.
Options
Successfully updated the issue's project

There was an error updating the issue's project
Changelog entries in the pull request title and/or **Proposed changelog entries** are accurate, human-readable, and in the imperative mood.

Changelog entries in the pull request title and/or Proposed changelog entries are accurate, human-readable, and in the imperative mood.
Options
Successfully updated the issue's project

There was an error updating the issue's project
Proper changelog labels are set so that the changelog can be generated automatically.

Proper changelog labels are set so that the changelog can be generated automatically.
Options
Successfully updated the issue's project

There was an error updating the issue's project
If the change needs additional upgrade steps from users, the `upgrade-guide-needed` label is set and there is a **Proposed upgrade guidelines** section in the pull request title (see [example](https://github.com/jenkinsci/jenkins/pull/4387)).

If the change needs additional upgrade steps from users, the upgrade-guide-needed label is set and there is a Proposed upgrade guidelines section in the pull request title (see example).
Options
Successfully updated the issue's project

There was an error updating the issue's project
If it would make sense to backport the change to LTS, a Jira issue must exist, be a _Bug_ or _Improvement_, and be labeled as `lts-candidate` to be considered (see [query](https://issues.jenkins.io/issues/?filter=12146)).

If it would make sense to backport the change to LTS, a Jira issue must exist, be a Bug or Improvement, and be labeled as lts-candidate to be considered (see query).
Options
Successfully updated the issue's project

There was an error updating the issue's project
Options

welcome · 2024-01-19T22:39:42Z

Yay, your first pull request towards Jenkins core was created successfully! Thank you so much!

A contributor will provide feedback soon. Meanwhile, you can join the chats and community forums to connect with other Jenkins users, developers, and maintainers.

mawinter69 · 2024-01-19T23:24:04Z

core/src/main/java/hudson/util/RemotingDiagnostics.java

@@ -215,6 +215,8 @@ public void doIndex(StaplerResponse rsp) throws IOException {
        @WebMethod(name = "heapdump.hprof")
        public void doHeapDump(StaplerRequest req, StaplerResponse rsp) throws IOException, InterruptedException {
            owner.checkPermission(Jenkins.ADMINISTER);
+            String propertyName = "jdk.management.heapdump.allowAnyFileSuffix";


wouldn't it be easier to just change the suffix to .hprof in line 179?

ok, I changed it.

basil · 2024-01-20T00:41:46Z

Software testing is necessary to identify and fix any errors or bugs and to ensure the software functions as expected, providing a reliable and user-friendly experience. For this reason, the Testing Done section of the PR template is mandatory, not optional. Can you please confirm that you can start Jenkins with java -jar jenkins.war, complete the setup wizard, and visit http://${JENKINS_URL}/heapDump before and after this change. Before this PR you should get an error, and after this PR your browser should download an hprof heap dump which you should be able to open with e.g. VisualVM. If you can complete all this testing as expected then please update the Testing Done section with the results.

balaji-sivasakthi · 2024-01-20T05:48:58Z

@basil

Before without .

java.lang.IllegalArgumentException: heapdump file must have .hprof extension
        at jdk.management/com.sun.management.internal.HotSpotDiagnostic.dumpHeap(HotSpotDiagnostic.java:60)
        at java.base/jdk.internal.reflect.DirectMethodHandleAccessor.invoke(DirectMethodHandleAccessor.java:103)
        at java.base/java.lang.reflect.Method.invoke(Method.java:580)
        at sun.reflect.misc.Trampoline.invoke(MethodUtil.java:64)
        at java.base/jdk.internal.reflect.DirectMethodHandleAccessor.invoke(DirectMethodHandleAccessor.java:103)
        at java.base/java.lang.reflect.Method.invoke(Method.java:580)
        at java.base/sun.reflect.misc.MethodUtil.invoke(MethodUtil.java:97)
        at java.management/com.sun.jmx.mbeanserver.ConvertingMethod.invokeWithOpenReturn(ConvertingMethod.java:193)
        at java.management/com.sun.jmx.mbeanserver.ConvertingMethod.invokeWithOpenReturn(ConvertingMethod.java:175)
        at java.management/com.sun.jmx.mbeanserver.MXBeanIntrospector.invokeM2(MXBeanIntrospector.java:115)
        at java.management/com.sun.jmx.mbeanserver.MXBeanIntrospector.invokeM2(MXBeanIntrospector.java:52)
        at java.management/com.sun.jmx.mbeanserver.MBeanIntrospector.invokeM(MBeanIntrospector.java:236)
        at java.management/com.sun.jmx.mbeanserver.PerInterface.invoke(PerInterface.java:138)
        at java.management/com.sun.jmx.mbeanserver.MBeanSupport.invoke(MBeanSupport.java:252)
        at java.management/javax.management.StandardMBean.invoke(StandardMBean.java:405)
        at

After including .

basil

Looks good. Should include a changelog entry I think.

balaji-sivasakthi · 2024-01-23T18:20:20Z

@basil, should I add it, or will the core team add it? If I should add it, how do I do so?

basil · 2024-01-23T18:21:57Z

If I should add it, how do I do so?

You can edit the PR description to fill in the "Proposed changelog entries" section.

basil · 2024-01-23T18:57:41Z

@jenkinsci/core-security-review It's been a while since this feature worked. During the intervening years, are there any new security requirements that would inhibit the reintroduction of this feature?

balaji-sivasakthi · 2024-01-24T02:28:36Z

@basil I have updated the changelog.

basil · 2024-01-24T15:59:09Z

This PR is now ready for merge. We will merge it after approximately 24 hours if there is no negative feedback. Please see the merge process documentation for more information about the merge process. Thanks!

welcome · 2024-01-24T21:36:53Z

Congratulations on getting your very first Jenkins core pull request merged 🎉🥳

This is a fantastic achievement, and we're thrilled to have you as part of our community! Thank you for your valuable input, and we look forward to seeing more of your contributions in the future!

We would like to invite you to join the community chats and forums to meet other Jenkins contributors 😊
Don't forget to check out the participation page to learn more about how to contribute to Jenkins.

mawinter69 reviewed Jan 19, 2024

View reviewed changes

fix: heap dump suffix allow .hprof

0364622

balaji-sivasakthi force-pushed the fix/heapdump branch from 58817f8 to 0364622 Compare January 19, 2024 23:38

basil self-assigned this Jan 20, 2024

balaji-sivasakthi requested a review from mawinter69 January 20, 2024 06:17

mawinter69 approved these changes Jan 20, 2024

View reviewed changes

NotMyFault changed the title ~~fix: heap dump suffix allow .hprof~~ [JENKINS-72579] Fix generation of heap dumps Jan 21, 2024

NotMyFault requested a review from a team January 21, 2024 15:13

NotMyFault added the bug For changelog: Minor bug. Will be listed after features label Jan 21, 2024

basil approved these changes Jan 22, 2024

View reviewed changes

daniel-beck added squash-merge-me Unclean or useless commit history, should be merged only with squash-merge and removed squash-merge-me Unclean or useless commit history, should be merged only with squash-merge labels Jan 22, 2024

basil added the needs-security-review Awaiting review by a security team member label Jan 23, 2024

balaji-sivasakthi requested a review from basil January 24, 2024 02:26

Kevin-CB added security-approved @jenkinsci/core-security-review reviewed this PR for security issues and removed needs-security-review Awaiting review by a security team member labels Jan 24, 2024

basil added the ready-for-merge The PR is ready to go, and it will be merged soon if there is no negative feedback label Jan 24, 2024

basil changed the title ~~[JENKINS-72579] Fix generation of heap dumps~~ [JENKINS-72579] Adjust heap dump file name for compatibility with OpenJDK file suffix requirements Jan 24, 2024

basil merged commit a32f24c into jenkinsci:master Jan 24, 2024
17 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[JENKINS-72579] Adjust heap dump file name for compatibility with OpenJDK file suffix requirements #8881

[JENKINS-72579] Adjust heap dump file name for compatibility with OpenJDK file suffix requirements #8881

balaji-sivasakthi commented Jan 19, 2024 •

edited by MarkEWaite

Submitter checklist

Maintainer checklist

welcome bot commented Jan 19, 2024

mawinter69 Jan 19, 2024

balaji-sivasakthi Jan 19, 2024

basil commented Jan 20, 2024

balaji-sivasakthi commented Jan 20, 2024 •

edited

basil left a comment

balaji-sivasakthi commented Jan 23, 2024

basil commented Jan 23, 2024

basil commented Jan 23, 2024

balaji-sivasakthi commented Jan 24, 2024

basil commented Jan 24, 2024

welcome bot commented Jan 24, 2024

[JENKINS-72579] Adjust heap dump file name for compatibility with OpenJDK file suffix requirements #8881

[JENKINS-72579] Adjust heap dump file name for compatibility with OpenJDK file suffix requirements #8881

Conversation

balaji-sivasakthi commented Jan 19, 2024 • edited by MarkEWaite

Testing done

Proposed changelog entries

Proposed upgrade guidelines

Submitter checklist

Desired reviewers

Maintainer checklist

welcome bot commented Jan 19, 2024

mawinter69 Jan 19, 2024

Choose a reason for hiding this comment

balaji-sivasakthi Jan 19, 2024

Choose a reason for hiding this comment

basil commented Jan 20, 2024

balaji-sivasakthi commented Jan 20, 2024 • edited

basil left a comment

Choose a reason for hiding this comment

balaji-sivasakthi commented Jan 23, 2024

basil commented Jan 23, 2024

basil commented Jan 23, 2024

balaji-sivasakthi commented Jan 24, 2024

basil commented Jan 24, 2024

welcome bot commented Jan 24, 2024

balaji-sivasakthi commented Jan 19, 2024 •

edited by MarkEWaite

balaji-sivasakthi commented Jan 20, 2024 •

edited