wu-sheng commented on a change in pull request #5914:
URL: https://github.com/apache/skywalking/pull/5914#discussion_r536741558
##########
File path:
docs/en/setup/service-agent/java-agent/agent-optional-plugins/Logger-plugin.md
##########
@@ -0,0 +1,78 @@
+# Overview
+
+`logger-plugin` can store the logs generated by the program during the call,
such as the content of the error log, into the span log. Through the
configuration file, you can control the log source (log4j2, logback, log4j),
package name, and level.
+
+# Configuration file
+
+By default, the configuration file is in
`apache-skywalking-apm-bin/agent/config//logger-plugin/logconfig.properties`.Of
course, **If the file does not exist, the default configurations are as
following,**
+
+```properties
+log4j.packages=*
+log4j.level=error
+log4j2.packages=*
+log4j2.level=error
+logback.packages=*
+logback.level=error
+```
+
+The meaning of the above configuration is as follows:
+
+1. SkyWalking opened the adaptor(bridge) between tracing kernel and log
frameworks, including `log4j`, `log4j2`, `logback`.
+2. Only collect logs at the `error` level, others would be ignored, including
`trace`, `debug`, `info`, `warn`.
+3. Wouldn't filter the logs by the package name.
+
+# Property description
+
+## packages
+
+**package attribute**: Specify the package name of the log that needs log
conversion. **The default value is `*` , and it will match all packages.**
+
+packages value:
+
+* the name of package, eg: `org.apache.skywalking`
+* `*`:match all
+
+**Notice:**
+
+When matching multiple packages, the names of different packages should be
separated by the comma.
+
+## level
+
+**level attribute** : The level of the log for conversion. **By default it is
`error` level**.
+
+The hierarchy order of log levels from low to high is as follows:
+
+`trace` < `debug` < `info` <`warn`< `error` < `fatal`
+
+**Notice:**
+
+Because `logback` not support `fatal`, it will be an exception if you set
**logback.level=fatal**.
Review comment:
What would be the exception? Could you point me out? There is
`string-switch` in your codes only
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
