Skip to content

JSON log format #611

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: develop
Choose a base branch
from
Draft

JSON log format #611

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
11d28f2
Add JSON log format
jelovirt May 1, 2025
9224cc4
Add logger option
jelovirt May 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions parameters/dita-command-arguments.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -375,6 +375,18 @@
<xref href="#./verbose"><parmname>--verbose</parmname></xref> option (or <parmname>-v</parmname>).</note>
</pd>
</plentry>
<plentry id="logger">
<pt>
<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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

log disabled colored output.</p>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
log disabled colored output.</p>
logging disables 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>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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>

</pd>
</plentry>
<plentry>
<pt>
<parmname>--no-color</parmname>
Expand Down
5 changes: 5 additions & 0 deletions topics/logging.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

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>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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>

</ul></dd>
</dlentry>
<dlentry>
Expand Down
Loading