Shulou(Shulou.com)06/02 Report--

This article mainly introduces how to write a log without configuration format in programming development, which has a certain reference value. Interested friends can refer to it. I hope you will gain a lot after reading this article. Let's take a look at it.

I. background

A large number of projects are using logback to keep a log, and some projects use logs in confusion and inconsistent format, and most people do not understand the configuration file, resulting in configuration errors. Now it is necessary to develop a set of unified and less configured log components to facilitate use.

Second, design ideas

Try to use 0 configuration without logback.xml

Uniform log format to facilitate follow-up log analysis system

There are only two log levels, one is the normal log and the other is the exception log

Provide log4j, jcl, logback, commons-log and other bridging solutions and version compatibility solutions

Convenient log output methods such as fetch child thread, json format output, map format, array format, request response parameters (for time-consuming), etc.

Support redis, db, http automatic switch configuration *

New log type (logger)

Api uses a streaming structure, similar to StringBuffer

Outline design 1. Zero configuration

Research code

Javastatic LoggerContext lc; static {lc = (LoggerContext) LoggerFactory.getILoggerFactory (); / / appender ConsoleAppender ca = new ConsoleAppender () in the corresponding configuration; ca.setContext (lc); ca.setName ("console"); / / format PatternLayoutEncoder pl = new PatternLayoutEncoder (); pl.setContext (lc) Pl.setPattern ("% d {MMddHHmmss.SSS} [% thread]%-5level% logger {36} -% msg%n"); pl.start (); ca.setEncoder (pl); ca.start (); / / logger ch.qos.logback.classic.Logger rootLogger = lc.getLogger ("com.test") in the corresponding configuration; rootLogger.addAppender (ca);}

The above code is equivalent to the following xml

% d {MMddHHmmss.SSS} [% thread]%-5level% logger {36} -% msg%n

As a result, the contents of the configuration file can be written in code form at will, and the theory can already achieve zero configuration.

2. Output path

It is agreed that the log is output to the relative path log/xxx.yyyy-MM-dd-HH.log, where xxx is the name of logger.

3. Log format is fixed: MMddHHmmss.SSS | | id | | [transaction name ★ substep] | | context | | [level] [thread number] example: 150000.311 | | N-XrUTQzIc1531897200311 | | [CiTeeFilter ★ ci interceptor] | | the complete parameters of the ci interceptor request are: {"merchantId": ["0012444"], "userId": ["13112341232"]} | | [INFO] [http-8091-7] |

Fixed format of the core code, intercept log requests, assemble according to the format, the main method is to inherit ThrowableProxyConverter and MessageConverter to achieve the interception of logs, and modify to the desired format, in which the use of such as id into local variables, the core is the use of MDC

4. Basic logger

All logs are output here by default. When the logger name:service system initializes, define the Logger and appender, that is, the Logger is root log.

5. Custom logger

Provide addLogger method, parameter packageName package name, for example: com.test required parameter if name is not set, name defaults to the last package name. The following character name name, which determines whether the log file name is optional, path log path is optional, and whether additivity is output to root log.

6. Special log

Provide log configuration for special components, for example: redis default ERROR http default ERROR db connection pool default ERROR kafka default ERROR schedul default ERROR spring default ERROR

7. Exception and newline log processing

Provide exception exception stack format printing provide formatted print code ideas with line breaks: inherit ThrowableProxyConverter, get the exception stack, and insert fixed format text in front of each line

8. Normal log api (VirgoLog) method description setUniqKey (id) sets the current thread id, which can be set at the beginning of the thread, and then there is no need to set updateStep (trade, step) to update the current id step information log (msg, param) records the normal log, msg replacement rule is generally replaced with {}, if you want to replace it with the format in the business log api Use ``to replace logErr (msg, e) to record exception logs log (trade, step, msg, param) to record normal logs. This method automatically updates id, trade, step. It is not recommended to use logErr (trade, step, msg, e) to record exception logs log (cid, trade, step, msg, param) to record general logs. This method automatically updates id, trade, step. It is not recommended to use logErr (cid, trade, step, msg, e) to log exception debug (msg, param) to log debug level, and is not recommended to use

Business log api (VirgoLog)

When keeping a log, if a class does not have time for the toString method, it will not be able to print the data correctly. Provide an alternative method at this time, and directly replace object with json printing. The core code idea is

MessageFormatter is a class that handles {} replacement. Write a new class, support {} and ``with a little change, and determine whether to replace it with json or toString.

Api is as follows

Method description: begin (msg) records start end (msg) records are completed, and the time-consuming logJson (json, format) records json format logs from the last begin in this thread will be printed. Format indicates whether to wrap line logMap (map, format) records map format logs logCollection (list, format) records set format logs logArray (array, format) records array format logs logObjct (obj, format) records Object format logs

System api (LoggerHelper)

Method description: getLogger () get logger, used for logging getLogger (name) get loggeraddLogger () reference custom Logger through name, if logger has been created, it will not be created again, generally not used, unless you want to customize the log name and other consoleOpen () to open the console log. When the system starts, the default components of console log commonOpen (name, level) are error level. This method can change the log level. For example, redis http et al. 9, special formatting

Map: convert to json, and then format

Collection: ditto

Array: same as above

Object: ditto

10. Question

Is it necessary to extract password desensitization, encryption and decryption separately?

Provide parent thread print switch

11. Maven depends on com.cdc.ecliptic virgo 1.5_1.6-SNAPSHOT12, demopublic static void main (String [] args) throws InterruptedException {/ / launch VirgoLancher.start ("", "com.cdc.virgo", "D:/test/h.log"); LoggerHelper.commonOpen ("", LogLevel.DEBUG); Logger logger1 = LoggerFactory.getLogger ("druid") / / VirgoLancher.commonStart ("abc", "com.cdc.virgo"); / / Open the console LoggerHelper.consoleOpen (); / / set cid VirgoLog.setUniqKey (null); / / set the step name and transaction name VirgoLog.updateStep ("adfa", "saf"); / / get Logger VirgoLog logger = VirgoLog.getLogger () / / Open the debug level (can only be opened during the development phase) / / logger.changeLevel (LogLevel.DEBUG); / / record newline logger.log ("a"); logger1.info ("dddddddddd"); logger1.error ("dddddddddd") / / logger1.info ("sfdasfaf" + / "\ nafafdasfd" + / / "\ nasfdasf"); logger.log ("sfdasfaf" + "\ nafafdasfd" + "\ nasfdasf"); / / logger1.info ("b"); / / normal log / / logger.log ("I only have one line") Map map = new HashMap (); map.put ("asdf", "1"); map.put ("asdf2", "2"); map.put ("asdf3", "13"); map.put ("asdf4", "14"); map.put ("asdf5", "15"); map.put ("asdf6", "16") / / exception logs also support formatting / / logger.logErr ("I was wrong: {}, you are right: ~ ~", new Exception ("asdfsaflk"), "ah", map); / / logger.log ("-") / {} replace ordinary objects, call toString () ~ ~ convert objects to json and format output ``convert objects to json unformatted output logger.log ("Hello {}, who are you ~``, sd~xx {}", map, "tttt"); VirgoLog.updateStep ("saf2") / convert objects to json output / / logger.logJson (map, false); / / update step name and transaction name / / VirgoLog.updateStep ("bbbbb", "ccccc"); / time-consuming log print logger.begin ("process content"); logger.begin ("process second") Logger.begin ("handle the third"); Thread.sleep (3000L); logger.end (); Thread.sleep (1000L); logger.end (); VirgoLog.updateStep ("saf3"); logger.end (); / record debug logs, general debugging / / logger.logDebug ("jajajajaja"); / / List l = new ArrayList () / / B b = new B (); / / try {/ / b.b (); / /} catch (Exception e) {/ / logger.logErr ("woqu", e) Thank you for reading this article carefully. I hope the article "how to write a unified log without configuration format" shared by the editor will be helpful to everyone. At the same time, I also hope that you will support it and pay attention to the industry information channel. More related knowledge is waiting for you to learn!

Welcome to subscribe "Shulou Technology Information " to get latest news, interesting things and hot topics in the IT industry, and controls the hottest and latest Internet news, technology news and IT industry trends.