fix: Log4j configurations and wording (#11395)

vy · ppkarwasz · adinauer · web-flow · commit 74099cc04d93 · 2024-11-07T05:01:45.000+01:00
* Fix Log4j configurations and improve wording

* Remove Log4j schema

Co-authored-by: Piotr P. Karwasz &lt;piotr@github.copernik.eu&gt;

* Remove Log4j schema

Co-authored-by: Piotr P. Karwasz &lt;piotr@github.copernik.eu&gt;

* Remove Log4j schema

Co-authored-by: Piotr P. Karwasz &lt;piotr@github.copernik.eu&gt;

* Apply suggestions from code review

---------

Co-authored-by: Piotr P. Karwasz &lt;piotr@github.copernik.eu&gt;
Co-authored-by: Alexander Dinauer &lt;adinauer@users.noreply.github.com&gt;
Co-authored-by: Alexander Dinauer &lt;alexander.dinauer@sentry.io&gt;
diff --git a/docs/platforms/java/common/legacy/log4j2/index.mdx b/docs/platforms/java/common/legacy/log4j2/index.mdx
@@ -9,7 +9,7 @@ An [updated Java SDK](/platforms/java/) SDK supersedes this deprecated version.
 
 </Alert>
 
-The `sentry-log4j2` library provides [Log4j 2.x](https://logging.apache.org/log4j/2.x/) support for Sentry via an [Appender](https://logging.apache.org/log4j/2.x/log4j-core/apidocs/org/apache/logging/log4j/core/Appender.html) that sends logged exceptions to Sentry. Once this integration is configured you can _also_ use Sentry’s static API, [as shown on the usage page](/platforms/java/legacy/usage), in order to do things like record breadcrumbs, set the current user, or manually send events.
+The `sentry-log4j2` library provides [Log4j 2](https://logging.apache.org/log4j/2.x/) support for Sentry via an [Appender](https://logging.apache.org/log4j/2.x/log4j-core/apidocs/org/apache/logging/log4j/core/Appender.html) that sends logged exceptions to Sentry. Once this integration is configured you can _also_ use Sentry’s static API, [as shown on the usage page](/platforms/java/legacy/usage), in order to do things like record breadcrumbs, set the current user, or manually send events.
 
 The source can be found [on GitHub](https://github.com/getsentry/sentry-java/tree/master/sentry-log4j2).
 
@@ -41,23 +41,24 @@ Example configuration using the `log4j2.xml` format:
 
 ```xml
 <?xml version="1.0" encoding="UTF-8"?>
-<configuration status="warn" packages="org.apache.logging.log4j.core,io.sentry.log4j2">
-    <appenders>
-        <Console name="Console" target="SYSTEM_OUT">
-            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />
-        </Console>
-
-        <Sentry name="Sentry" />
-    </appenders>
-
-    <loggers>
-        <root level="INFO">
-            <appender-ref ref="Console" />
-            <!-- Note that the Sentry logging threshold is overridden to the WARN level -->
-            <appender-ref ref="Sentry" level="WARN" />
-        </root>
-    </loggers>
-</configuration>
+<Configuration>
+
+  <Appenders>
+    <Console name="CONSOLE" target="SYSTEM_OUT">
+      <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
+    </Console>
+    <Sentry name="SENTRY"/>
+  </Appenders>
+
+  <Loggers>
+    <Root level="INFO">
+      <AppenderRef ref="CONSOLE"/>
+      <!-- Note that the Sentry logging threshold is overridden to the WARN level -->
+      <AppenderRef ref="SENTRY" level="WARN"/>
+    </Root>
+  </Loggers>
+
+</Configuration>
 ```
 
 Next, **you’ll need to configure your DSN** (client key) and optionally other values such as `environment` and `release`. [See the configuration page](/platforms/java/legacy/configuration/#setting-the-dsn) for ways you can do this.
diff --git a/docs/platforms/java/guides/spring-boot/logging-frameworks.mdx b/docs/platforms/java/guides/spring-boot/logging-frameworks.mdx
@@ -65,9 +65,9 @@ However, if errors that may appear during startup should to be sent to Sentry, t
 
 </Note>
 
-### Log4j2
+### Log4j 2
 
-To use Sentry's Log4j2 integration in Spring Boot application, you must include a dependency to the `sentry-log4j2` module:
+To use Sentry's Log4j 2 integration in Spring Boot application, you must include a dependency to the `sentry-log4j2` module:
 
 ```xml {tabTitle:Maven}
 <dependency>
@@ -87,30 +87,33 @@ libraryDependencies += "io.sentry" % "sentry-log4j2" % "{{@inject packages.versi
 
 For other dependency managers see the [central Maven repository](https://search.maven.org/artifact/io.sentry/sentry-log4j2).
 
-Then [follow the guide on configuring Log4j2 with Spring Boot](https://docs.spring.io/spring-boot/docs/current/reference/html/howto.html#howto-configure-log4j-for-logging) and configure `SentryAppender` in the `log4j2.xml` file:
+Then [follow the guide on configuring Log4j 2 with Spring Boot](https://docs.spring.io/spring-boot/docs/current/reference/html/howto.html#howto-configure-log4j-for-logging) and configure `SentryAppender` in the `log4j2.xml` file:
 
 ```xml
 <?xml version="1.0" encoding="UTF-8"?>
-<Configuration status="warn" packages="org.apache.logging.log4j.core,io.sentry.log4j2">
-    <Appenders>
-        <Console name="Console" target="SYSTEM_OUT">
-            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
-        </Console>
-        <Sentry name="Sentry" />
-    </Appenders>
-    <Loggers>
-        <Root level="info">
-            <AppenderRef ref="Sentry"/>
-            <AppenderRef ref="Console"/>
-        </Root>
-    </Loggers>
+<Configuration>
+
+  <Appenders>
+    <Console name="CONSOLE" target="SYSTEM_OUT">
+      <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
+    </Console>
+    <Sentry name="SENTRY"/>
+  </Appenders>
+
+  <Loggers>
+    <Root level="INFO">
+      <AppenderRef ref="CONSOLE"/>
+      <AppenderRef ref="SENTRY"/>
+    </Root>
+  </Loggers>
+
 </Configuration>
 ```
 
 <Note>
 
-You do not need to configure your DSN in the Log4j2 configuration file since Sentry is configured from the Spring Boot integration.
+You do not need to configure your DSN in the Log4j 2 configuration file since Sentry is configured from the Spring Boot integration.
 
-However, if errors that may appear during startup should to be sent to Sentry, the DSN must be provided to <i>both</i> the Log4j2 and Spring Boot configurations.
+However, if errors that may appear during startup should to be sent to Sentry, the DSN must be provided to <i>both</i> the Log4j 2 and Spring Boot configurations.
 
 </Note>
diff --git a/platform-includes/configuration/decluttering/java.mdx b/platform-includes/configuration/decluttering/java.mdx
@@ -1 +1 @@
-When used together with one of the logging framework integrations, the Java SDK captures all error logs as events. If you see a particular kind of error very often that has a `logger` tag, you can ignore that particular logger entirely. For more information see our <Link to="/platforms/java/guides/logback/">Logback</Link> or <Link to="/platforms/java/guides/log4j2/">Log4j 2.x</Link> integration.
+When used together with one of the logging framework integrations, the Java SDK captures all error logs as events. If you see a particular kind of error very often that has a `logger` tag, you can ignore that particular logger entirely. For more information see our <Link to="/platforms/java/guides/logback/">Logback</Link> or <Link to="/platforms/java/guides/log4j2/">Log4j 2</Link> integration.
diff --git a/platform-includes/getting-started-config/java.log4j2.mdx b/platform-includes/getting-started-config/java.log4j2.mdx
@@ -6,36 +6,35 @@ The `ConsoleAppender` is provided only as an example of a non-Sentry appender se
 
 </Note>
 
-
 ```xml
 <?xml version="1.0" encoding="UTF-8"?>
-<Configuration status="warn" packages="org.apache.logging.log4j.core,io.sentry.log4j2">
-    <Appenders>
-        <Console name="Console" target="SYSTEM_OUT">
-            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
-        </Console>
-        <Sentry name="Sentry"
-                dsn="___PUBLIC_DSN___" />
-    </Appenders>
-    <Loggers>
-        <Root level="info">
-            <AppenderRef ref="Sentry"/>
-            <AppenderRef ref="Console"/>
-        </Root>
-    </Loggers>
+<Configuration>
+
+  <Appenders>
+    <Console name="CONSOLE" target="SYSTEM_OUT">
+      <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
+    </Console>
+    <Sentry name="SENTRY" dsn="___PUBLIC_DSN___"/>
+  </Appenders>
+
+  <Loggers>
+    <Root level="INFO">
+      <AppenderRef ref="CONSOLE"/>
+      <AppenderRef ref="SENTRY" level="ERROR"/>
+    </Root>
+  </Loggers>
+
 </Configuration>
 ```
 
-`SentryAppender` does not support Log4j2's [async mode](https://logging.apache.org/log4j/2.x/manual/async.html). The Sentry Java SDK itself is already asynchronous and does not perform any blocking operation on the calling thread.
+`SentryAppender` does not support [Log4j's asynchronous loggers](https://logging.apache.org/log4j/2.x/manual/async.html). The Sentry Java SDK itself is already asynchronous and does not perform any blocking operation on the calling thread.
 
 ### DSN Configuration
 
-Note that **you need to configure your DSN** (client key) only if you wish to initialize the SDK through the log4j2 integration. If you're planning to use `Sentry.init` to provide configuration, such as by using the `beforeSend` callback, you **should not** provide the DSN in both `Sentry.init` and the appender configuration; just leave it out of the appender configuration in this case.
-
+Note that **you need to configure your DSN** (client key) only if you wish to initialize the SDK through the Log4j 2 integration. If you're planning to use `Sentry.init` to provide configuration, such as by using the `beforeSend` callback, you **should not** provide the DSN in both `Sentry.init` and the appender configuration; just leave it out of the appender configuration in this case.
 
 ```xml
-<Sentry name="Sentry"
-        dsn="___PUBLIC_DSN___" />
+<Sentry name="SENTRY" dsn="___PUBLIC_DSN___" />
 ```
 
 If the DSN is not present in the `log4j2.xml` configuration, Sentry will attempt to read it from the system property `sentry.dsn`, environment variable `SENTRY_DSN` or the `dsn` property in `sentry.properties` file. [See the configuration page](/platforms/java/configuration/) for more details on external configuration.
@@ -59,9 +58,8 @@ Breadcrumbs are kept in memory (by default the last 100 records) and are sent wi
 ```xml
 <!-- Setting minimumBreadcrumbLevel modifies the default minimum level to add breadcrumbs from INFO to DEBUG  -->
 <!-- Setting minimumEventLevel the default minimum level to capture an event from ERROR to WARN  -->
-<Sentry name="Sentry"
+<Sentry name="SENTRY"
         dsn="___PUBLIC_DSN___"
         minimumBreadcrumbLevel="DEBUG"
-        minimumEventLevel="WARN"
-/>
+        minimumEventLevel="WARN"/>
 ```
diff --git a/public/_platforms/java.json b/public/_platforms/java.json
diff --git a/public/_platforms/kotlin.json b/public/_platforms/kotlin.json

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		-When used together with one of the logging framework integrations, the Java SDK captures all error logs as events. If you see a particular kind of error very often that has a `logger` tag, you can ignore that particular logger entirely. For more information see our <Link to="/platforms/java/guides/logback/">Logback</Link> or <Link to="/platforms/java/guides/log4j2/">Log4j 2.x</Link> integration.
	`1`	+When used together with one of the logging framework integrations, the Java SDK captures all error logs as events. If you see a particular kind of error very often that has a `logger` tag, you can ignore that particular logger entirely. For more information see our <Link to="/platforms/java/guides/logback/">Logback</Link> or <Link to="/platforms/java/guides/log4j2/">Log4j 2</Link> integration.