Add Javadoc of ErrorTypeAwareLogger. (#13032)

This commit is contained in:
Andy Cheung 2023-09-11 16:00:55 +08:00 committed by GitHub
parent 4c4bcb7a25
commit 248449ada0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 0 deletions

View File

@ -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 {