NodeJS लॉगिंग आसान बना दिया

आपने कितनी बार logger.info('ServiceName.methodName.') और logger.info('ServiceName.methodName -> done.') अपनी सेवा के प्रत्येक और हर तरीके के लिए जिसे आप लॉग इन करना चाहते थे? क्या आप यह पसंद करेंगे कि वह स्वचालित हो और आपके पूरे ऐप में एक ही स्थिर हस्ताक्षर हो? यदि ऐसा है, तो हम बहुत अधिक एक जैसे हैं, हमने एक ही दर्द को कई बार सहन किया है, और अब हम अंत में इसे हल करने की कोशिश कर सकते हैं। साथ में। देवियों और सज्जनों, मुझे परिचय दें ... वर्ग-लकड़हारा !

वर्ग-लकड़हारा का "क्यों"

इंजीनियर अक्सर पूर्णतावादी होते हैं। चरम के लिए पूर्णतावादी। हमें साफ-सुथरा अमूर्त पसंद है। हमें क्लीन कोड पसंद है। हम कृत्रिम भाषाओं में सौंदर्य देखते हैं अन्य लोग भी नहीं पढ़ सकते हैं। हम छोटे डिजिटल ब्रह्माण्डों का निर्माण करना पसंद करते हैं, हमारे द्वारा निर्धारित नियमों के अनुसार। हमें वह सब पसंद है, शायद, क्योंकि हम बहुत आलसी हैं। नहीं, हम काम से डरते नहीं हैं, लेकिन हम ऐसे किसी भी काम को करने से नफरत करते हैं जो स्वचालित हो सकता है।

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

जल्दी शुरू करो

चलिए मैदान को हिट करें और देखें कि वास्तविक कोड क्या दिखता है।

 import { LogClass, Log } from 'class-logger' @LogClass() class ServiceCats { @Log() eat(food: string) { return 'purr' } } 

यह सेवा तीन बार लॉग इन करने जा रही है:

• इसके निर्माण पर तर्क की एक सूची के साथ निर्माणकर्ता को पारित कर दिया।
• eat से पहले उसके तर्कों की एक सूची के साथ निष्पादित किया जाता है।
• eat बाद उसके तर्कों और उसके परिणाम की सूची के साथ निष्पादित किया जाता है।

कोड के शब्दों में:

 // Logs before the actual call to the constructor // `ServiceCats.construct. Args: [].` const serviceCats = new ServiceCats() // Logs before the actual call to `eat` // `ServiceCats.eat. Args: [milk].` serviceCats.eat('milk') // Logs after the actual call to `eat` // `ServiceCats.eat -> done. Args: [milk]. Res: purr.` 

लाइव डेमो ।

हम और क्या लॉग कर सकते हैं? यहाँ घटनाओं की पूरी सूची है:

• वर्ग निर्माण से पहले।
• तुल्यकालिक और अतुल्यकालिक स्थिर और गैर-स्थिर तरीकों और कार्यात्मक गुणों से पहले।
• तुल्यकालिक और अतुल्यकालिक स्थिर और गैर-स्थिर तरीकों और कार्यात्मक गुणों के बाद।
• तुल्यकालिक और अतुल्यकालिक स्थिर और गैर-स्थिर तरीकों और कार्यात्मक गुणों की त्रुटियां।

फ़ंक्शनल प्रॉपर्टी एक एरो फंक्शन है जो किसी प्रॉपर्टी ( class ServiceCats { private meow = () => null } ) को सौंपा जाता है।

इसे हमारी आवश्यकताओं के अनुसार समायोजित करना

अब तक तो अच्छा है, लेकिन हमें "अनुकूलन" का वादा किया गया है, है ना? तो हम इसे कैसे ट्विस्ट कर सकते हैं?

वर्ग-लकड़हारा पदानुक्रमित विन्यास की तीन परतें प्रदान करता है:

• वैश्विक
• वर्ग
• विधि

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

वैश्विक विन्यास

यह ऐप-वाइड कॉन्फिग है। setConfig कॉल के साथ सेट किया जा सकता है।

 import { setConfig } from 'class-logger' setConfig({ log: console.info, }) 

वर्ग विन्यास

यह आपकी कक्षा के हर तरीके पर प्रभाव डालता है। यह वैश्विक कॉन्फ़िगरेशन को ओवरराइड कर सकता है।

 import { LogClass } from 'class-logger' setConfig({ log: console.info, }) @LogClass({ // It overrides global config for this service log: console.debug, }) class ServiceCats {} 

विधि विन्यास

यह केवल विधि को ही प्रभावित करता है। वर्ग विन्यास को ओवरराइड करता है और इसलिए, वैश्विक कॉन्फ़िगरेशन।

 import { LogClass } from 'class-logger' setConfig({ log: console.info, }) @LogClass({ // It overrides global config for this service log: console.debug, }) class ServiceCats { private energy = 100 @Log({ // It overrides class config for this method only log: console.warn, }) eat(food: string) { return 'purr' } // This method stil uses `console.debug` provided by class config sleep() { this.energy += 100 } } 

लाइव डेमो

कॉन्फ़िगरेशन विकल्प

ठीक है, हमने सीखा है कि चूक को कैसे बदलना है, फिर भी यह कवर करने के लिए चोट नहीं पहुंचाएगा कि क्या कॉन्फ़िगर करना है, हुह?

यहां आप बहुत सारे उपयोगी कॉन्फिगर ओवरड्राइड पा सकते हैं ।

यदि आप टाइपस्क्रिप्ट अंग्रेज़ी से बेहतर बोलते हैं, तो यहाँ पर डिस्क ऑब्जेक्ट के इंटरफ़ेस का लिंक दिया गया है :)

कॉन्फ़िगरेशन ऑब्जेक्ट में ये गुण हैं:

लॉग

यह एक ऐसा कार्य है जो अंतिम स्वरूपित संदेश की वास्तविक लॉगिंग करता है। इसका उपयोग इन घटनाओं को लॉग करने के लिए किया जाता है:

• वर्ग निर्माण से पहले।
• तुल्यकालिक और अतुल्यकालिक स्थिर और गैर-स्थिर तरीकों और कार्यात्मक गुणों से पहले।
• तुल्यकालिक और अतुल्यकालिक स्थिर और गैर-स्थिर तरीकों और कार्यात्मक गुणों के बाद।

डिफ़ॉल्ट: console.log

logError

यह एक ऐसा कार्य है जो अंतिम स्वरूपित त्रुटि संदेश की वास्तविक लॉगिंग करता है। इसका उपयोग केवल एक और केवल ईवेंट लॉग करने के लिए किया जाता है:

• तुल्यकालिक और अतुल्यकालिक स्थिर और गैर-स्थिर तरीकों और कार्यात्मक गुणों की त्रुटियां।

डिफ़ॉल्ट: console.error

फ़ॉर्मेटर

यह दो तरीकों के साथ एक वस्तु है: start और end । यह डेटा को अंतिम स्ट्रिंग में लॉगिंग करता है।

इन घटनाओं के लिए प्रारूप संदेश start :

• वर्ग निर्माण से पहले।
• तुल्यकालिक और अतुल्यकालिक स्थिर और गैर-स्थिर तरीकों और कार्यात्मक गुणों से पहले।

इन घटनाओं के लिए प्रारूप संदेश:

• तुल्यकालिक और अतुल्यकालिक स्थिर और गैर-स्थिर तरीकों और कार्यात्मक गुणों के बाद।
• तुल्यकालिक और अतुल्यकालिक स्थिर और गैर-स्थिर तरीकों और कार्यात्मक गुणों की त्रुटियां।

डिफ़ॉल्ट: new ClassLoggerFormatterService()

शामिल

संदेश में क्या शामिल होना चाहिए, इसका विन्यास।

आर्ग

यह या तो एक बूलियन या एक वस्तु हो सकती है।

यदि यह एक बूलियन है, तो यह निर्धारित करता है कि क्या तर्कों की सूची को शामिल करें (याद रखें कि Args: [milk] ?) दोनों में, शुरू करें (निर्माण से पहले और विधि कॉल से पहले) और अंत (विधि कॉल, त्रुटि विधि कॉल के बाद), संदेश।

यदि यह एक वस्तु है, तो इसमें दो बूलियन गुण होने चाहिए: start और end । start में संदेशों को शुरू करने के लिए तर्कों की सूची शामिल है / शामिल है, end संदेशों के लिए समान है।

डिफ़ॉल्ट: true

निर्माण

वर्ग निर्माण या नहीं लॉग करने के लिए बूलियन ध्वज सेटिंग।

डिफ़ॉल्ट: true

परिणाम

एक अन्य बुलियन फ्लैग सेटिंग जिसमें विधि कॉल का रिटर्न मान या उसके द्वारा फेंकी गई त्रुटि शामिल है। याद रखें Res: purr ? यदि आप इस ध्वज को false सेट false तो कोई Res: purr नहीं होगा Res: purr

डिफ़ॉल्ट: true

classInstance

एक बार फिर, एक बूलियन या एक वस्तु।
यदि आप इसे सक्षम करते हैं, तो लॉग में आपके वर्ग उदाहरण का एक कड़ा प्रतिनिधित्व जोड़ा जाएगा। दूसरे शब्दों में, यदि आपके वर्ग के उदाहरण में कुछ गुण हैं, तो उन्हें JSON स्ट्रिंग में बदल दिया जाएगा और लॉग संदेश में जोड़ दिया जाएगा।

सभी संपत्तियों को नहीं जोड़ा जाएगा। वर्ग-लकड़हारा इस तर्क का अनुसरण करता है:

• एक उदाहरण के स्वयं (गैर-प्रोटोटाइप) गुणों को लें।
  
  • क्यों? यह एक दुर्लभ मामला है जब आपका प्रोटोटाइप गतिशील रूप से बदलता है, इसलिए इसे लॉग करने के लिए शायद ही कोई मतलब है।
• उनमें से कोई भी ड्रॉप करें जिसमें function प्रकार है।
  
  • क्यों? अधिकांश समय function गुण this संदर्भ को संरक्षित करने के लिए नियमित वर्ग विधियों के बजाय उपयोग किए जाने वाले अपरिवर्तनीय तीर फ़ंक्शन हैं। यह उन कार्यों के कड़े शरीर के साथ अपने लॉग को खिलने के लिए बहुत मायने नहीं रखता है।
• उनमें से किसी को भी गिराएं जो सादे वस्तु नहीं हैं।
  
  • कौन सी वस्तुएं सादी हैं? ClassLoggerFormatterService एक वस्तु को एक सादी वस्तु मानता है यदि इसका प्रोटोटाइप Object.prototype बराबर है।
  • क्यों? अक्सर हम अन्य वर्गों के उदाहरणों को गुणों के रूप में शामिल करते हैं (उन्हें निर्भरता के रूप में इंजेक्ट करें)। यदि हम इन निर्भरताओं के कठोर संस्करणों को शामिल करते हैं तो हमारे लॉग बेहद मोटे हो जाएंगे।
• स्ट्रिंग जो बचा है।

 class ServiceA {} @LogClass({ include: { classInstance: true, }, }) class Test { private serviceA = new ServiceA() private prop1 = 42 private prop2 = { test: 42 } private method1 = () => null @Log() public method2() { return 42 } } // Logs to the console before the class' construction: // 'Test.construct. Args: []. Class instance: {"prop1":42,"prop2":{"test":42}}.' const test = new Test() // Logs to the console before the method call: // 'Test.method2. Args: []. Class instance: {"prop1":42,"prop2":{"test":42}}.' test.method2() // Logs to the console after the method call: // 'Test.method2 -> done. Args: []. Class instance: {"prop1":42,"prop2":{"test":42}}. Res: 42.' 

डिफ़ॉल्ट: false

स्वरूपण पर नियंत्रण रखना

तो क्या हुआ अगर आप समग्र विचार पसंद करते हैं, लेकिन क्या आपके संदेश अलग तरह से देखना चाहेंगे? आप अपने स्वयं के कस्टम फ़ॉर्मेटर पास करने पर पूर्ण नियंत्रण ले सकते हैं।

आप स्क्रैच से अपना स्वयं का फॉर्मेटर लिख सकते हैं। पूरी तरह से। फिर भी हम इस विकल्प को यहां नहीं ले जा रहे हैं (यदि आप वास्तव में इसमें रुचि रखते हैं, तो README के "स्वरूपण" अनुभाग को संबोधित करें)।

सबसे तेज़ और, शायद, सबसे आसान काम एक अंतर्निहित डिफ़ॉल्ट ClassLoggerFormatterService को उप-वर्ग करना है - ClassLoggerFormatterService ।

ClassLoggerFormatterService में ये संरक्षित तरीके हैं, जो अंतिम संदेश के निर्माण खंड के रूप में कार्य कर रहे हैं:

• base
  
  • विधि नाम के साथ वर्ग नाम देता है। उदाहरण: ServiceCats.eat ।
• operation
  
  • रिटर्न -> done या -> error आधार पर कि क्या यह एक विधि का सफल निष्पादन था या एक त्रुटि।
• args
  
  • तर्कों की एक कड़ी सूची लौटाता है। उदाहरण: . Args: [milk] . Args: [milk] । यह हुड के तहत वस्तुओं के लिए तेज-सुरक्षित-स्ट्रिंग का उपयोग करता है।
• classInstance
  
  • एक कड़े वर्ग उदाहरण देता है। उदाहरण: . Class instance: {"prop1":42,"prop2":{"test":42}} . Class instance: {"prop1":42,"prop2":{"test":42}} । यदि आप क्लास इंस्टेंस को शामिल करना चुनते हैं, लेकिन यह उपलब्ध नहीं है (यही कारण है कि यह स्टैटिक तरीकों और क्लास कंस्ट्रक्शन के लिए है), तो यह N/A रिटर्न करता है N/A
• result
  
  • निष्पादन का एक कठोर परिणाम देता है (भले ही यह एक त्रुटि थी)। वस्तुओं को क्रमबद्ध करने के लिए तेज़-सुरक्षित-स्ट्रिंग का उपयोग करता है। एक कठोर त्रुटि निम्नलिखित गुणों से बनी होगी:
  • कक्षा का नाम (फ़ंक्शन) त्रुटि के साथ बनाया गया था ( error.constructor.name )।
  • त्रुटि कोड ( error.code )।
  • त्रुटि संदेश ( error.message )।
  • त्रुटि नाम ( error.name )।
  • स्टैक ट्रेस ( error.stack )।
• final
  
  • रिटर्न . । बस . ।

start संदेश में निम्न शामिल हैं:

• base
• args
• classInstance
• final

end संदेश में निम्न शामिल हैं:

• base
• operation
• args
• classInstance
• result
• final

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

 import { ClassLoggerFormatterService, IClassLoggerFormatterStartData, setConfig, } from 'class-logger' class ClassLoggerTimestampFormatterService extends ClassLoggerFormatterService { protected base(data: IClassLoggerFormatterStartData) { const baseSuper = super.base(data) const timestamp = Date.now() const baseWithTimestamp = `${timestamp}:${baseSuper}` return baseWithTimestamp } } setConfig({ formatter: new ClassLoggerTimestampFormatterService(), }) 

लाइव डेमो

निष्कर्ष

कृपया, इस लाइब्रेरी का उपयोग करने का निर्णय लेने से पहले स्थापना चरणों का पालन करना और आवश्यकताओं से परिचित होना न भूलें।

उम्मीद है, आपने अपनी परियोजना के लिए कुछ उपयोगी पाया है। अपनी प्रतिक्रिया मुझसे संवाद करने के लिए स्वतंत्र महसूस करें! मैं निश्चित रूप से किसी भी आलोचना और सवालों की सराहना करता हूं।