NLog: नियम और फ़िल्टर

पुष्टि में, हम अपने .NET अनुप्रयोगों में लॉगिंग के लिए NLog लाइब्रेरी का उपयोग करते हैं। हालाँकि इस लाइब्रेरी के लिए प्रलेखन मौजूद है, लेकिन मेरे लिए यह समझना मुश्किल था कि यह सब कैसे काम करता है। इस लेख में, मैं यह बताने की कोशिश करूंगा कि NLog में नियम और फ़िल्टर कैसे लागू होते हैं। चलिए शुरू करते हैं।

NLog को कैसे कॉन्फ़िगर करें

और हम NLog कॉन्फ़िगरेशन के साथ क्या कर सकते हैं, इसकी थोड़ी याद दिलाते हुए शुरुआत करेंगे। सरलतम स्थिति में, यह कॉन्फ़िगरेशन एक XML फ़ाइल है (उदाहरण के लिए, NLog.config):

<?xml version="1.0" encoding="utf-8" ?> <nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <targets> <target name="target1" xsi:type="ColoredConsole" layout="Access Log|${level:uppercase=true}|${logger}|${message}"> <highlight-row condition="true" foregroundColor="red"/> </target> <target name="target2" xsi:type="ColoredConsole" layout="Common Log|${level:uppercase=true}|${logger}|${message}"> <highlight-row condition="true" foregroundColor="green"/> </target> <target name="target3" xsi:type="ColoredConsole" layout="Yellow Log|${level:uppercase=true}|${logger}|${message}"> <highlight-row condition="true" foregroundColor="yellow"/> </target> </targets> <rules> <logger name="*" minlevel="Warn" writeTo="target1,target2,target3" /> </rules> </nlog> 

आप इस फ़ाइल को कोड की एक पंक्ति के साथ डाउनलोड कर सकते हैं:

 LogManager.Configuration = new XmlLoggingConfiguration("NLog.config"); 

हम इसके साथ क्या कर सकते हैं? हम नियम के लिए कई संदेश रिसीवर (लक्ष्य) निर्धारित कर सकते हैं:

 <rules> <logger name="*" minlevel="Warn" writeTo="target1,target2,target3" /> </rules> 

हम यह निर्धारित कर सकते हैं कि इस नियम को लागू करने के कौन से स्तर लागू हैं:

 <rules> <logger name="*" minlevel="Warn" writeTo="target1" /> <logger name="*" levels="Debug,Warn,Info" writeTo="target2" /> </rules> 

हम प्रत्येक नियम के लिए फ़िल्टर सेट कर सकते हैं:

 <rules> <logger name="*" minlevel="Info" writeTo="target1"> <filters defaultAction='Log'> <when condition="contains('${message}','Common')" action="Ignore" /> </filters> </logger> </rules> 

और अंत में, हम नेस्टेड नियमों को परिभाषित कर सकते हैं:

 <rules> <logger name="*" minlevel="Info" writeTo="target1"> <logger name="*" minlevel="Warn" writeTo="target2" /> </logger> </rules> 

यह पता लगाने का समय है कि यह सब कैसे काम करता है।

लकड़हारा विन्यास बनाना

जब आप एक लकड़हारा उदाहरण का अनुरोध करते हैं,

 var commonLogger = LogManager.GetLogger("Common"); 

NLog या तो कैश से एक मौजूदा लेता है या एक नया बनाता है ( यहां देखें)। बाद के मामले में, लॉगर के लिए दिए गए नाम के साथ एक कॉन्फ़िगरेशन भी बनाया गया है। आइए इसे बनाने की प्रक्रिया को देखें।

संक्षेप में, लकड़हारा विन्यास रिसीवर्स की एक अलग श्रृंखला है और प्रत्येक लॉगिंग स्तर ( Trace , Debug , Info , Warn , Error , Fatal ) के लिए संबंधित फ़िल्टर ( यहां देखें)। अब मैं आपको दिखाऊंगा कि ये श्रृंखलाएं कैसे बनाई जाती हैं।

इन श्रृंखलाओं को बनाने के लिए जिम्मेदार मुख्य विधि LogFactory वर्ग का GetTargetsByLevelForLogger है । यह इसी तरह काम करता है। NLog कॉन्फ़िगरेशन में निर्दिष्ट सभी नियम बदले में चुने गए हैं। सबसे पहले, यह देखने के लिए जांचता है कि नियम नाम लकड़हारे के नाम से मेल खाता है या नहीं। नियम में वाइल्डकार्ड शामिल हो सकते हैं, जैसे कि हम फ़ाइल सिस्टम ऑब्जेक्ट के लिए उपयोग करते हैं:

• * - पात्रों का एक मनमाना क्रम
• ? - कोई एकल चरित्र

इस प्रकार, नियम नाम ' * ' किसी भी लकड़हारे के नाम से मेल खाता है, और ' Common* ' उन सभी लकड़हारे से मेल खाता है, जिनके नाम ' Common ' से शुरू होते हैं।

यदि नियम का नाम लकड़हारे के नाम से मेल नहीं खाता है, तो यह नियम इसमें दिए गए सभी नियमों को छोड़ दिया गया है। अन्यथा, GetTargetsByLevelForLogger विधि उन सभी लॉगिंग स्तरों को प्राप्त करती है जिनके लिए यह नियम सक्षम है। इस तरह के प्रत्येक स्तर के लिए, NLog इस नियम के लिए फिल्टर के साथ संबंधित रिसीवर श्रृंखला में नियम में निर्दिष्ट सभी संदेश रिसीवर जोड़ता है।

रिसीवर श्रृंखलाओं के निर्माण में एक और महत्वपूर्ण विशेषता है। यदि वर्तमान नियम final रूप से चिह्नित है और इसका नाम लकड़हारे के नाम से मेल खाता है, तो NLog इस नियम के लिए शामिल सभी लॉगिंग स्तरों के लिए जंजीरों का निर्माण पूरा करता है। इसका मतलब है कि न तो नेस्टेड नियम और न ही बाद के नियम इन रिसीवर चेन में कुछ भी जोड़ते हैं। उनकी रचना पूरी तरह से हो चुकी है और वे नहीं बदलेंगे। यह इस प्रकार है कि इस तरह से कुछ लिखने का कोई मतलब नहीं है:

 <rules> <logger name="*" minlevel="Info" writeTo="target1" final="true"> <logger name="*" minlevel="Warn" writeTo="target2" /> </logger> </rules> 

कोई संदेश target2 तक नहीं target2 । लेकिन ऐसा कुछ लिखना संभव है:

 <rules> <logger name="*" minlevel="Warn" writeTo="target1" final="true"> <logger name="*" minlevel="Info" writeTo="target2" /> </logger> </rules> 

चूंकि बाहरी नियम Info स्तर के लिए सक्षम नहीं है, इसलिए इस स्तर के लिए रिसीवर की श्रृंखला बाहरी नियम पर समाप्त नहीं होगी। इसलिए, Info स्तर वाले सभी संदेश target2 में गिर target2 ।

इस नियम से सभी रिसीवर्स को संबंधित चेन में जोड़ दिए जाने के बाद, विधि एक ही एल्गोरिदम के अनुसार वर्तमान नियम के सभी नेस्टेड नियमों की पुनरावृत्ति करता है। यह मूल नियम के लिए सक्षम लॉगिंग स्तरों की परवाह किए बिना होता है।

कुल मिलाकर, लकड़हारा के लिए कॉन्फ़िगरेशन तैयार है। इसमें लॉगिंग के प्रत्येक संभावित स्तर के लिए फ़िल्टर के साथ रिसीवर की श्रृंखलाएं शामिल हैं:

यह देखने का समय है कि इस कॉन्फ़िगरेशन का उपयोग कैसे किया जाता है।

लकड़हारा विन्यास का उपयोग करना

आइए शुरू करते हैं साधारण बातों से। Logger वर्ग एक IsEnabled विधि और संबद्ध IsXXXEnabled गुण ( IsDebugEnabled , IsInfoEnabled , ...) है। वे कैसे काम करते हैं? वास्तव में, वे बस जांचते हैं कि लॉगिंग के दिए गए स्तर के लिए रिसीवर चेन में कम से कम एक लिंक होता है ( यहां देखें)। इसका मतलब है कि फ़िल्टर कभी भी इन गुणों के मूल्यों को प्रभावित नहीं करते हैं।

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

यहां बताया गया है कि फ़िल्टर कैसे कॉन्फ़िगर किए जाते हैं:

 <rules> <logger name="*" minlevel="Info" writeTo="target1"> <filters defaultAction='Log'> <when condition="contains('${message}','Common')" action="Ignore" /> </filters> </logger> </rules> 

आमतौर पर एक फिल्टर में कुछ बूलियन स्थिति होती है। यहां आप तय कर सकते हैं कि फ़िल्टर प्रत्येक संदेश के लिए true या false । लेकिन ऐसा है नहीं। उनके काम का परिणाम FilterResult प्रकार का एक मूल्य है। यदि फ़िल्टर स्थिति true जाती true , तो फ़िल्टर का परिणाम action विशेषता में निर्दिष्ट मान बन जाता है (हमारे उदाहरण में, यह Ignore )। यदि स्थिति false , तो फ़िल्टर का परिणाम Neutral होगा। इसका मतलब है कि फ़िल्टर यह तय नहीं करना चाहता है कि संदेश के साथ क्या करना है।

आप देख सकते हैं कि यहां रिसीवर श्रृंखला कैसे संसाधित होती है । प्रत्येक रिसीवर के लिए, GetFilterResult विधि में संबंधित फ़िल्टर के परिणाम की GetFilterResult की GetFilterResult । यह पहले फिल्टर के परिणाम के बराबर है जो कि Neutral नहीं लौटा। इसका मतलब यह है कि यदि कुछ फ़िल्टर Neutral अलावा कोई मान लौटाते हैं, तो बाद के सभी फ़िल्टर निष्पादित नहीं किए जाते हैं।

लेकिन क्या होगा यदि सभी फ़िल्टर Neutral वापस कर दें? इस स्थिति में, डिफ़ॉल्ट मान का उपयोग किया जाएगा। यह मान नियम के लिए filters तत्व के defaultAction विशेषता का उपयोग करके सेट किया गया है। आपको क्या लगता है कि defaultAction का डिफ़ॉल्ट मान क्या है? आप सही हैं अगर आपको लगता है कि यह Neutral । यही है, संपूर्ण फ़िल्टर श्रृंखला परिणाम के रूप में Neutral वापस कर सकती है। इस मामले में, NLog Log प्राप्त करने के समान व्यवहार करता है। संदेश रिसीवर को लिखा जाएगा ( यहां देखें)।

जैसा कि आपने अनुमान लगाया होगा, यदि कोई फ़िल्टर Ignore या IgnoreFinal , तो संदेश रिसीवर को नहीं लिखा जाएगा। यदि फ़िल्टर का परिणाम Log या Log LogFinal , तो संदेश रिकॉर्ड किया जाएगा। लेकिन Ignore और IgnoreFinal बीच और Log या LogFinal बीच क्या अंतर है? यह सरल है। IgnoreFinal और LogFinal के मामले में LogFinal NLog रिसीवर श्रृंखला को संसाधित करना बंद कर देता है और बाद के लिंक में निहित रिसीवरों को कुछ भी नहीं लिखता है।

निष्कर्ष

NLog कोड का विश्लेषण करने से मुझे यह समझने में मदद मिली कि नियम और फ़िल्टर कैसे काम करते हैं। मुझे उम्मीद है कि यह लेख आपके लिए उपयोगी होगा। सौभाग्य है