Skip to content
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

Change the example to use the JSONTemplateLayout since JSONLayout is … #26959

Merged
merged 3 commits into from
Jan 6, 2025
Merged

Change the example to use the JSONTemplateLayout since JSONLayout is … #26959

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
59375de
Change the example to use the JSONTemplateLayout since JSONLayout is …
estherk15 Jan 3, 2025
fab892c
Apply suggestions from code review
estherk15 Jan 3, 2025
4ad3093
Apply suggestions from code review
estherk15 Jan 3, 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
78 changes: 37 additions & 41 deletions content/en/logs/log_collection/java.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,47 +115,42 @@ For Log4j, log in JSON format by using the SLF4J module [log4j-over-slf4j][1] co

Log4j 2 includes a JSON layout.

1. Configure an appender using the JSON layout in `log4j2.xml`. See the following example configurations for file and console appender.

For a file appender:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<Configuration>
<Appenders>
<File name="FILE" fileName="logs/app.log" >
<JSONLayout compact="true" eventEol="true" properties="true" stacktraceAsString="true" />
</File>
</Appenders>

<Loggers>
<Root level="INFO">
<AppenderRef ref="FILE"/>
</Root>
</Loggers>
</Configuration>
```

For a console appender:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<Configuration>

<Appenders>
<Console name="console" target="SYSTEM_OUT">
<JSONLayout compact="true" eventEol="true" properties="true" stacktraceAsString="true" />
</Console>
</Appenders>

<Loggers>
<Root level="INFO">
<AppenderRef ref="console"/>
</Root>

</Loggers>
</Configuration>
```
1. Configure an appender using the JSON layout in `log4j2.xml`. See the following example configurations for file and console appender. For a comprehensive description of Log4j plugins, see the [Log4j Plugin reference][1].
{{% collapse-content title="File appender" level="h4" %}}
{{< code-block lang="xml" filename="log4j2.xml" >}}
<?xml version="1.0" encoding="UTF-8"?>
<Configuration>
<Appenders>
<File name="FILE" fileName="logs/app.log" >
<JsonTemplateLayout eventTemplateUri="classpath:MyLayout.json"/>
</File>
</Appenders>
<Loggers>
<Root level="INFO">
<AppenderRef ref="FILE"/>
</Root>
</Loggers>
</Configuration>
{{< /code-block >}}
{{% /collapse-content %}}

{{% collapse-content title="Console appender" level="h4" %}}
{{< code-block lang="xml" filename="log4j2.xml" >}}
<?xml version="1.0" encoding="UTF-8"?>
<Configuration>
<Appenders>
<Console name="console" target="SYSTEM_OUT">
<JsonTemplateLayout eventTemplateUri="classpath:MyLayout.json"/>
</Console>
</Appenders>
<Loggers>
<Root level="INFO">
<AppenderRef ref="console"/>
</Root>
</Loggers>
</Configuration>
{{< /code-block >}}
{{% /collapse-content %}}

2. Add the JSON layout dependencies to your `pom.xml`. For example:
```xml
Expand All @@ -181,6 +176,7 @@ Log4j 2 includes a JSON layout.
</dependency>
```

[1]: https://logging.apache.org/log4j/2.x/plugin-reference.html
{{% /tab %}}
{{% tab "Logback" %}}

Expand Down
Loading