Update StructuredDataMessage Javadoc for RFC 5424 compliance#4103
Open
DrDrunkenstien-10 wants to merge 1 commit intoapache:2.xfrom
Open
Update StructuredDataMessage Javadoc for RFC 5424 compliance#4103DrDrunkenstien-10 wants to merge 1 commit intoapache:2.xfrom
DrDrunkenstien-10 wants to merge 1 commit intoapache:2.xfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #4051
This pull request improves the Javadoc of StructuredDataMessage constructors by clarifying
the expected format and usage of the
id(SD-ID) andtype(MSGID) parameters.Specifically:
This change is documentation-only and does not modify runtime behavior.
This improvement is based on feedback from the YesWeHack bug bounty report (#YWH-PGM10209-37),
which identified a lack of clarity in the existing documentation.
Checklist
Base your changes on
2.xbranch if you are targeting Log4j 2; usemainotherwise2.x)./mvnw verifysucceeds (the build instructions)Non-trivial changes contain an entry file in the
src/changelog/.2.x.xdirectoryTests are provided