This is an automated email from the ASF dual-hosted git repository.
albumenj pushed a commit to branch 3.2
in repository https://gitbox.apache.org/repos/asf/dubbo.git
The following commit(s) were added to refs/heads/3.2 by this push:
new 248449ada0 Add Javadoc of ErrorTypeAwareLogger. (#13032)
248449ada0 is described below
commit 248449ada045a64232be5ba9efd6fdaae6cdd9f8
Author: Andy Cheung <[email protected]>
AuthorDate: Mon Sep 11 16:00:55 2023 +0800
Add Javadoc of ErrorTypeAwareLogger. (#13032)
---
.../apache/dubbo/common/logger/ErrorTypeAwareLogger.java | 15 +++++++++++++++
1 file changed, 15 insertions(+)
diff --git
a/dubbo-common/src/main/java/org/apache/dubbo/common/logger/ErrorTypeAwareLogger.java
b/dubbo-common/src/main/java/org/apache/dubbo/common/logger/ErrorTypeAwareLogger.java
index fe9ebcc774..72db45e868 100644
---
a/dubbo-common/src/main/java/org/apache/dubbo/common/logger/ErrorTypeAwareLogger.java
+++
b/dubbo-common/src/main/java/org/apache/dubbo/common/logger/ErrorTypeAwareLogger.java
@@ -17,8 +17,23 @@
package org.apache.dubbo.common.logger;
+import org.apache.dubbo.common.constants.LoggerCodeConstants;
+
/**
* Logger interface with the ability of displaying solution of different types
of error.
+ *
+ * <p>
+ * This logger will log a message like this:
+ *
+ * <blockquote><pre>
+ * ... (original logging message) This may be caused by (... cause),
+ * go to https://dubbo.apache.org/faq/[Cat]/[X] to find instructions. (...
extendedInformation)
+ * </pre></blockquote>
+ *
+ * Where "[Cat]/[X]" is the error code ("code" in arguments). The link is
clickable, leading user to
+ * the "Error code and its corresponding solutions" page.
+ *
+ * @see LoggerCodeConstants Detailed Format of Error Code and Error Code
Constants
*/
public interface ErrorTypeAwareLogger extends Logger {
