8350689: Turn on timestamp and thread metadata by default for java.security.debug #25528

coffeys · 2025-05-29T19:06:15Z

Removal of the +thread and +timestamp options that were used to control the logging behavior of output from the java.security.debug system property.

To enhance the security debug logs, the thread and timestamp data should always be present. This brings it to a par with another important security debug system property, the TLS debug property: javax.net.debug. Output from the TLS javax.net.debug logs always contains thread and timestamp data.

This patch remove the +thread and +timestamp support code and print thread and timestamp data by default. This enancement is only proposed for the JDK feature release. Update releases can continue to opt into such data.

Debug output data from use of the java.security.debug property will now resemble something like the following:

properties[0x10|main|Security.java:122|2025-05-01 14:59:42.859 UTC]: Initial security property: package.definition=sun.misc.,sun.reflect.
properties[0x10|main|Security.java:122|2025-05-01 14:59:42.859 UTC]: Initial security property: krb5.kdc.bad.policy=tryLast

I've also trimmed back on some of the test case coverage since use of +thread and +timestamp options is now redundant with this patch.

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
Change requires CSR request JDK-8358090 to be approved

Issues

JDK-8350689: Turn on timestamp and thread metadata by default for java.security.debug (Enhancement - P4)
JDK-8358090: Turn on timestamp and thread details by default for java.security.debug (CSR)

Reviewers

Sean Mullan (@seanjmullan - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 25528

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

Using diff file

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

Using Webrev

Link to Webrev Comment

bridgekeeper · 2025-05-29T19:06:56Z

👋 Welcome back coffeys! 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 · 2025-05-29T19:06:59Z

@coffeys 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:

8350689: Turn on timestamp and thread metadata by default for java.security.debug

Reviewed-by: mullan

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 21 new commits pushed to the master branch:

da49fa5: 8354460: Streaming output for attach API should be turned on by default
704b599: 8358534: Bailout in Conv2B::Ideal when type of cmp input is not supported
e235b61: 8357987: [JVMCI] Add support for retrieving all methods of a ResolvedJavaType
... and 18 more: https://git.openjdk.org/jdk/compare/4618374269e8636c772d921ad0c2c2d9e5e3e643...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.

openjdk · 2025-05-29T19:07:46Z

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

security

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.

mlbridge · 2025-05-29T19:11:25Z

Webrevs

mcpowers

You might need to append 8350689 to @bug in a few test programs.

mcpowers · 2025-05-29T21:30:49Z

test/jdk/sun/security/krb5/auto/LoginModuleDebug.java

                        "",
                        "krb5loginmodule"),
-                // thread info only
+                // thread and timestamp on by default now


"now" will be confusing ten years from now.

mcpowers · 2025-05-29T21:36:16Z

test/jdk/sun/security/util/Debug/DebugOptions.java

    private static Stream<Arguments> patternMatches() {
        return Stream.of(
-                // no extra info present
+                // thread and timestamp info on by default now


remove "now"

mcpowers · 2025-05-29T21:37:14Z

test/jdk/sun/security/util/Debug/DebugOptions.java

-                // thread info only
+                        EXPECTED_PROP_REGEX,
+                        "properties:"),
+                // thread and timestamp info on by default now


remove "now"

wangweij · 2025-05-29T22:36:38Z

Looks great. Do you need a CSR?

coffeys · 2025-05-30T09:38:15Z

Looks great. Do you need a CSR?

Yes - need a reviewer for CSR: https://bugs.openjdk.org/browse/JDK-8358090

Thanks.

I've taken Mark's comments on board. I removed the comment referring to default "on" also since there is no concept of on/off for this option anymore.

wangweij · 2025-05-30T13:08:31Z

I added my name as a reviewer to the CSR. The Summary section currently has "This CSR proposes to turn that data on by default". You may just say "turn that data on always".

seanjmullan · 2025-05-30T14:21:14Z

src/java.base/share/classes/java/security/doc-files/debug-system-property.html

 <p> To monitor security access, you can set the <code>java.security.debug</code>
    system property, which determines what trace messages are printed during
    execution. The value of the property is one or more options separated by a
    comma.


I suggest we add a sentence to this paragraph noting that each trace message also includes the thread id, timestamp, and caller information.

Thanks. Added

"Each trace message includes the thread id, timestamp and caller information." to this paragraph

seanjmullan · 2025-05-30T14:26:14Z

What is the behavior if someone had added these options in JDK 23 and is now debugging the same code with JDK 25? Are they ignored? The CSR should also note the behavior.

coffeys · 2025-05-30T14:45:00Z

What is the behavior if someone had added these options in JDK 23 and is now debugging the same code with JDK 25? Are they ignored? The CSR should also note the behavior.

I've added this clarification to the CSR:

Continued use of the +thread and +timestamp options will no longer have impact. The thread and timestamp data is always printed and valid security components used in the java.security.debug property will continue to be logged.

seanjmullan · 2025-06-02T19:27:19Z

src/java.base/share/classes/java/security/doc-files/debug-system-property.html

+    comma. Each trace message includes the thread id, timestamp and caller
+    information.


Small comment, but I would list this in the order they are printed: "thread id, caller information, and timestamp".

coffeys · 2025-06-04T09:41:27Z

/integrate

openjdk · 2025-06-04T09:41:53Z

Going to push as commit 42f48a3.
Since your change was applied there have been 36 commits pushed to the master branch:

cd16b68: 8357155: [asan] ZGC does not work (x86_64 and ppc64)
ab23500: 8354636: [PPC64] Clean up comments regarding frame manager
f141674: 8347491: IllegalArgumentationException thrown by ThreadPoolExecutor doesn't have a useful message
... and 33 more: https://git.openjdk.org/jdk/compare/4618374269e8636c772d921ad0c2c2d9e5e3e643...master

Your commit was automatically rebased without conflicts.

openjdk · 2025-06-04T09:42:00Z

@coffeys Pushed as commit 42f48a3.

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

coffeys added 3 commits May 22, 2025 14:15

8350689

076ed41

update system property doc

2691e1e

Merge branch 'master' into 8350689-default-timestamps

f07a7ff

openjdk bot changed the title ~~8350689~~ 8350689: Turn on timestamp and thread metadata by default for java.security.debug May 29, 2025

openjdk bot added csr Pull request needs approved CSR before integration rfr Pull request is ready for review labels May 29, 2025

openjdk bot added the security security-dev@openjdk.org label May 29, 2025

mcpowers reviewed May 29, 2025

View reviewed changes

Incorporate review comments from Mark

0d766cc

openjdk bot removed the rfr Pull request is ready for review label May 30, 2025

seanjmullan reviewed May 30, 2025

View reviewed changes

Update property doc as per Sean Mullan comment

85babe8

openjdk bot added the rfr Pull request is ready for review label May 30, 2025

seanjmullan reviewed Jun 2, 2025

View reviewed changes

coffeys added 2 commits June 3, 2025 12:57

Merge branch 'master' into 8350689-default-timestamps

4c49a59

tweak sentence in debug-system-property.html

0e5c0da

seanjmullan approved these changes Jun 3, 2025

View reviewed changes

openjdk bot added ready Pull request is ready to be integrated and removed csr Pull request needs approved CSR before integration labels Jun 3, 2025

openjdk bot added the integrated Pull request has been integrated label Jun 4, 2025

openjdk bot closed this Jun 4, 2025

openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Jun 4, 2025

		comma. Each trace message includes the thread id, timestamp and caller
		information.

8350689: Turn on timestamp and thread metadata by default for java.security.debug #25528

8350689: Turn on timestamp and thread metadata by default for java.security.debug #25528

Uh oh!

Conversation

coffeys commented May 29, 2025 • edited by openjdk bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Progress

Issues

Reviewers

Reviewing

Uh oh!

bridgekeeper bot commented May 29, 2025

Uh oh!

openjdk bot commented May 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openjdk bot commented May 29, 2025

Uh oh!

mlbridge bot commented May 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Webrevs

Uh oh!

mcpowers left a comment

Choose a reason for hiding this comment

Uh oh!

mcpowers May 29, 2025

Choose a reason for hiding this comment

Uh oh!

mcpowers May 29, 2025

Choose a reason for hiding this comment

Uh oh!

mcpowers May 29, 2025

Choose a reason for hiding this comment

Uh oh!

wangweij commented May 29, 2025

Uh oh!

coffeys commented May 30, 2025

Uh oh!

wangweij commented May 30, 2025

Uh oh!

seanjmullan May 30, 2025

Choose a reason for hiding this comment

Uh oh!

coffeys May 30, 2025

Choose a reason for hiding this comment

Uh oh!

seanjmullan commented May 30, 2025

Uh oh!

coffeys commented May 30, 2025

Uh oh!

seanjmullan Jun 2, 2025

Choose a reason for hiding this comment

Uh oh!

coffeys commented Jun 4, 2025

Uh oh!

openjdk bot commented Jun 4, 2025

Uh oh!

openjdk bot commented Jun 4, 2025

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

4 participants

coffeys commented May 29, 2025 •

edited by openjdk bot

Loading

openjdk bot commented May 29, 2025 •

edited

Loading

mlbridge bot commented May 29, 2025 •

edited

Loading