JSON log format #611
Draft
JSON log format #611
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
Signed-off-by: Jarno Elovirta <[email protected]>
Signed-off-by: Jarno Elovirta <[email protected]>
infotexture
reviewed
May 4, 2025
| <parmname>--logger</parmname>=<varname>json</varname> | ||
| </pt> | ||
| <pd> | ||
| <p>Generate a strucured log in JSON format. Each log message generated a JSON object on its own line. JSON |
There was a problem hiding this comment.
Suggested change
| <p>Generate a strucured log in JSON format. Each log message generated a JSON object on its own line. JSON | |
| <p>Generate a structured log in JSON format. Each log message generates a JSON object on its own line. JSON |
| @@ -56,6 +56,11 @@ | |||
| <parmname>--logfile</parmname>=<varname>file</varname> and specify the path to the log file.</p> | |||
| <p>Unless an absolute path is specified, the value will be interpreted relative to the current | |||
| directory.</p></li> | |||
| <li>Use <cmdname>dita</cmdname> | |||
| <parmname>--logger</parmname>=<varname>json</varname> to generate a strucured log in JSON format. Each log | |||
There was a problem hiding this comment.
Suggested change
| <parmname>--logger</parmname>=<varname>json</varname> to generate a strucured log in JSON format. Each log | |
| <parmname>--logger</parmname>=<varname>json</varname> to generate a structured log in JSON format. Each log |
| <parmname>--logger</parmname>=<varname>json</varname> to generate a strucured log in JSON format. Each log | ||
| message generates a JSON object on its own line. | ||
| <p>If log is written to a file with <parmname>--logfile</parmname>, the log will be generated as a JSON | ||
| array where each log message is JSON object as an array item.</p></li> |
There was a problem hiding this comment.
Suggested change
| array where each log message is JSON object as an array item.</p></li> | |
| array where each log message is a JSON object as an array item.</p></li> |
| log disabled colored output.</p> | ||
| <p>If log is written to a file with <parmname | ||
| >--logfile</parmname>, the log will be generated as a JSON array | ||
| where each log message is JSON object as an array item.</p> |
There was a problem hiding this comment.
Suggested change
| where each log message is JSON object as an array item.</p> | |
| where each log message is a JSON object as an array item.</p> |
| </pt> | ||
| <pd> | ||
| <p>Generate a strucured log in JSON format. Each log message generated a JSON object on its own line. JSON | ||
| log disabled colored output.</p> |
There was a problem hiding this comment.
Suggested change
| log disabled colored output.</p> | |
| logging disables colored output.</p> |
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.
Description
Document strucutured log (JSON).
Fields in every log message
level— log levelFATAL,ERROR,WARN,INFO,DEBUG, orTRACEtimestamp— message timestamp in ISO datatime formatOptional fields that are in some messages depending on message type
code— message IDduration— duration of build/target/task in millisecondsline— line number in the source documentlocation— source document that caused the log messagemsg— message textrow— row number in the source documentstacktrace— error Java stack tracetarget— Ant target nametask— Ant task nameMotivation and Context
Documents dita-ot/dita-ot#4581
How Has This Been Tested?
Type of Changes