SpringBoot + Log4j2 + मावेन में सुविधाजनक लॉगिंग

नमस्कार, प्रिय खब्रोवित्स।

लेख में प्रस्तुत सामग्री शुरुआती लोगों के लिए अभिप्रेत है और, शायद, यह मुझे एक सुविधाजनक लॉगिंग सिस्टम प्राप्त करने के लिए StackOverFlow और अन्य साइटों पर खोज करने के कई घंटे बचाएगा, जो खुद समझ जाएगा कि कहां लॉग इन करना है - कंसोल, फ़ाइल या लॉगस्टैश में।

परियोजना की शुरुआत में, कार्य हमेशा सही तरीके से लॉगिंग को कॉन्फ़िगर करने से उत्पन्न होता है, जबकि स्थानीय परिवेश पर लॉग को कंसोल में और डिबगिंग के दौरान सुविधा के लिए फ़ाइल में प्रदर्शित किया जाना चाहिए, और रिमोट सर्वर पर लॉग को कंसोल में आउटपुट करना बेहद अवांछनीय है, लेकिन इसके बजाय उन्हें फ़ाइल में लिखा जाना चाहिए। logstash या डेटाबेस में। और अगर आपके पास स्थानीय रूप से और एक दूरस्थ लिनक्स मशीन पर विंडोज है, तो इस लॉग फ़ाइल का स्थान पता अलग है।

इस प्रकार, कई परिस्थितियां हैं जिनमें आपको बाहरी परिस्थितियों के आधार पर अपने हाथों से लॉगिंग सिस्टम के कॉन्फ़िगरेशन को लगातार ठीक करने की आवश्यकता होती है।

मैं लगातार याद रखने और अपेंडिक्स पर टिप्पणी करने से थक गया था, और मैंने Log4j2 को कॉन्फ़िगर करने का एक तरीका विकसित किया ताकि, चयनित मावेन प्रोफाइल के आधार पर, केवल सही ऐपेंडर्स स्वचालित रूप से चालू हो जाएं।

नीचे स्प्रिंग बूट + मावेन + लॉग 4 जे 2 का उपयोग करके एक परियोजना स्थापित करने के लिए एक निर्देश दिया गया है, जिसके परिणामस्वरूप एक कॉन्फ़िगर लॉगिंग सिस्टम और दो परिशिष्ट होंगे: CONSOLE और SOCKET।

सबसे पहले, हम मावेन विन्यास (pom.xml) में परिवर्तन करेंगे:
संपूर्ण pom.xml स्तर पर चर में, logstash-appender के लिए होस्ट पता जोड़ें:

<properties> <logstash.host>logstashcsm.example.ru</logstash.host> </properties> 

कार्य के लिए आवश्यक निर्भरताएँ जोड़ें:

 <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> <exclusions> <exclusion> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-logging</artifactId> </exclusion> </exclusions> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-log4j2</artifactId> </dependency> </dependencies> 

ध्यान दें कि हम स्प्रिंग-बूट-स्टार्टर-लॉगिंग निर्भरता को स्प्रिंग-बूट-स्टार्टर-वेब से बाहर करते हैं।

जुड़े हुए ऐपेंडरों को गतिशील रूप से प्रबंधित करने के लिए मावेन प्रोफाइल सेट करें। प्रत्येक प्रोफ़ाइल के स्तर पर, हम चर logstash.port, logger.console.tresholdFilter, logger.socket.tresholdFilter सेट करते हैं।

 <profiles> <profile> <id>local</id> <properties> <logstash.port>10000</logstash.port> <logger.console.tresholdFilter>ALL</logger.console.tresholdFilter> <logger.socket.tresholdFilter>OFF</logger.socket.tresholdFilter> </properties> </profile> <profile> <id>dev</id> <properties> <logstash.port>10001</logstash.port> <logger.console.tresholdFilter>OFF</logger.console.tresholdFilter> <logger.socket.tresholdFilter>ALL</logger.socket.tresholdFilter> </properties> </profile> </profiles> 

logstash.port - जिस पोर्ट में लॉग भेजा जाना है।
logger.console.tresholdFilter - मान कंसोल पर प्रदर्शित लॉग के फ़िल्टरिंग स्तर को निर्धारित करता है। हमारे मामले में, सभी का अर्थ है कि सभी स्तरों के लॉग रिकॉर्ड कंसोल ऐपेंडर में प्रदर्शित किए जाएंगे।
logger.socket.tresholdFilter - मान लॉग के फ़िल्टरिंग स्तर को सेट करता है जो लॉगस्टैश को भेजा जाता है। उतर - का अर्थ है कि इस उपाधीक्षक को भेजा गया कोई भी अभिलेख पास नहीं होगा।

अब हमें application.properties में परिवर्तन करने की आवश्यकता है ताकि Log4j2.xml फ़ाइल से हम pom.xml में निर्दिष्ट चर के मान तक पहुँच सकें:

logstash.host=@logstash.host@
logstash.port=@logstash.port@
logger.console.tresholdFilter=@logger.console.tresholdFilter@
logger.socket.tresholdFilter=@logger.socket.tresholdFilter@

और अंत में, हम Log4j2.xml फ़ाइल में स्वयं Log4j2 के कॉन्फ़िगरेशन को कॉन्फ़िगर करते हैं:

 <?xml version="1.0" encoding="UTF-8"?> <Configuration> <Properties> <Property name="socket.host">${bundle:application:logstash.host}</Property> <Property name="socket.port">${bundle:application:logstash.port}</Property> <Property name="console.thresholdFilter">${bundle:application:logger.console.tresholdFilter}</Property> <Property name="socket.thresholdFilter">${bundle:application:logger.socket.tresholdFilter}</Property> </Properties> <Appenders> <Console name="CONSOLE" target="SYSTEM_OUT"> <ThresholdFilter level="${console.thresholdFilter}"/> <PatternLayout pattern="%d %-5p [%t] %c{10} - %m%n"/> </Console> <Socket name="SOCKET" host="${socket.host}" port="${socket.port}" immediateFlush="true"> <ThresholdFilter level="${socket.thresholdFilter}"/> <JSONLayout eventEol="true" compact="true"/> </Socket> <Async name="ASYNC"> <AppenderRef ref="CONSOLE"/> <AppenderRef ref="SOCKET"/> </Async> </Appenders> <Loggers> <Logger name="ru.example" level="debug" additivity="false"> <AppenderRef ref="ASYNC"/> </Logger> <Root level="error"> <AppenderRef ref="ASYNC"/> </Root> </Loggers> </Configuration> 

अब, अपनी कक्षा में लकड़हारे को बुलाने के लिए, आपको उसका एक उदाहरण बनाने की आवश्यकता है:

 private static Logger logger = LoggerFactory.getLogger(YourClass.class); 

और उसकी ओर मुड़ें:

 logger.info("   "); 

वह सब है। अब लॉगिंग प्रोजेक्ट में सक्रिय मावेन प्रोफाइल को ध्यान में रखते हुए काम करेगा।
कृपया ध्यान दें कि log4j2.xml फ़ाइल की लिस्टिंग में, दो लॉगर्स को ru.example - ru.example और root , और उनके पास इवेंट लॉगिंग के विभिन्न स्तर हैं। पहला ru.example.* से कक्षाओं द्वारा उत्पन्न सभी घटनाओं पर काम करेगा ru.example.* पैकेज और DEBUG स्तर से सब कुछ ru.example.* , और root लकड़हारा बिल्कुल सभी वर्गों से घटनाओं को रिकॉर्ड करेगा, लेकिन ERROR स्तर से।
उसी समय, ताकि प्रविष्टियों को लॉग में डुप्लिकेट न किया जाए, additivity="false" सेटिंग का उपयोग किया जाता है।