🐴 👎🏾 📰 संदेश आसान लॉगिंग के साथ ++ 🚊 🈺 🏬

लॉगिंग सिस्टम अनुप्रयोगों को लॉग करने के लिए एक अनिवार्य उपकरण है। उन लोगों के लिए जो इसे स्वयं लागू नहीं करना चाहते हैं, C ++ में पहले से ही अनगिनत तैयार लाइब्रेरी (Log4cplus, Apache log4cxx, Boost.Log, आदि) हैं, हालांकि Easylogging ++ का उपयोग करना आसान है और कॉम्पैक्ट है, इसके लिए तीसरे पक्ष के लाइब्रेरी या इंस्टॉलेशन की आवश्यकता नहीं है। इसका सभी कोड एक ही हेडर फाइल में समाहित है, जिसे बस एप्लीकेशन कोड में शामिल करना है।

यह आलेख इस लाइब्रेरी का उपयोग करने के इजीलॉगिंग ++ कार्यक्षमता और उदाहरणों का एक संक्षिप्त अवलोकन प्रदान करता है।

आइए एक छोटे उदाहरण से शुरू करते हैं जो यह प्रदर्शित करना चाहिए कि ईजीलॉगिंग ++ का उपयोग शुरू करना कितना आसान है:

#include "easylogging++.h" _INITIALIZE_EASYLOGGINGPP int main(int argv, char* argc[]) { LOG(INFO) << " Habrahabr"; return 0; }

पुस्तकालय एक हेडर के साथ जुड़ा हुआ है, किसी भी लिबास की आवश्यकता नहीं है।

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

पूछे जाने वाले प्रश्न:

लाइब्रेरी साइट: easylogging.org
लाइसेंस: MIT
भाषा: C ++ 11
पर निर्भर करता है: -
प्लेटफ़ॉर्म: विंडोज, मैक OSX, डेबियन (उबंटू, मिंट), फेडोरा
कंपाइलर: जीसीसी 4.7+, विज़ुअल सी ++ 11.0+, इंटेल सी ++ 13.0+, मिनगव, साइगविन

क्यों:

पुस्तकालय की सादगी और सहजता लुभावना है। हम अन्य शीर्षकों को खोजने में असमर्थ थे जो एक ही हेडर फ़ाइल में फिट होते हैं (जो प्रोजेक्ट से प्रोजेक्ट में उपयोग करना आसान है) और क्षमताओं का एक बहुत पूरा सेट दे रहा है:

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

प्रारूप सेटिंग

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

 11/06/2014 11:23:29,218 INFO [default] Simple info message 11/06/2014 11:23:29,218 ERROR [default] Simple error message 11/06/2014 11:23:29,218 WARN [default] This is just a warning

शुरुआत के लिए, ईज़ीलॉगिंग डेवलपर को अपने आदेश के साथ-साथ प्रदर्शित फ़ील्ड के सेट को अनुकूलित करने की क्षमता प्रदान करता है।

नीचे दिए गए उदाहरण से पता चलता है कि आप शुरुआत में एक संदेश प्रकार कैसे डाल सकते हैं, फिर एक संशोधित प्रारूप में एक तारीख, फिर उस पद्धति का हस्ताक्षर जिसमें से कॉल किया गया था और संदेश स्वयं:

क्षेत्र अनुकूलन

 el::Loggers::reconfigureAllLoggers(el::ConfigurationType::Format, "%level %datetime{%H:%m:%s} (%func): %msg"); LOG(INFO) << "  ";

स्क्रीन पर परिणाम इस तरह दिखेगा:

 INFO 11:33:58 (int main(int, char**)):

प्रारूप विवरण में मानक चीजों के अलावा, जैसे संदेश प्रकार, दिनांक या फ़ाइल नाम (सीपीपी), आप लॉग को अतिरिक्त जानकारी प्रदान करने के लिए अपने स्वयं के मैक्रो का उपयोग कर सकते हैं। उदाहरण के लिए, इस तरह:

खुद के खेत

 const char* getMode(void) { switch(mode) { case 1: return "Service"; default: return "App"; } return ""; // just in case } int main(int argv, char* argc[]) { el::Helpers::installCustomFormatSpecifier(el::CustomFormatSpecifier("%mode", getMode)); el::Loggers::reconfigureAllLoggers(el::ConfigurationType::Format, "%level %mode: %msg"); LOG(INFO) << "  "; return 0; }

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

झंडे सेट करें

 int main(int argv, char* argc[]) { /*     (   ) */ el::Loggers::reconfigureAllLoggers(el::ConfigurationType::ToStandardOutput, "true"); /*     */ el::Loggers::addFlag(el::LoggingFlag::ColoredTerminalOutput); LOG(INFO) << " "; LOG(ERROR) << "   "; LOG(WARNING) << "  "; return 0; }

स्क्रीन पर परिणाम इस तरह दिखेगा:

किसी भी सेटिंग को न केवल कोड से बदला जा सकता है: इसके अलावा, लाइब्रेरी अपने स्वयं के प्रारूप (टैब के साथ नियमित रूप से कॉन्फ़िगर) में कॉन्फ़िगरेशन फ़ाइलों का समर्थन करती है, जिसे एप्लिकेशन लॉन्च या संचालन के दौरान लोड किया जा सकता है। इसके अलावा, लाइब्रेरी कमांड लाइन से पैरामीटर पढ़ सकती है: ऐसा करने के लिए, उपयुक्त कॉल को मुख्य रूप से रखें:

कमांड लाइन पढ़ें

 int main(int argv, char* argc[]) { _START_EASYLOGGINGPP(argc, argv); }

कस्टम प्रकार

पुस्तकालय आपको किसी भी प्रकार की वस्तुओं की सामग्री को लॉग करने की अनुमति देता है। ऐसा करने के दो तरीके हैं:

एक निश्चित el :: Loggable से अपनी ऑब्जेक्ट को इनहेरिट करें और संबंधित वर्चुअल विधि को लागू करें
अपनी ऑब्जेक्ट को लॉग में भेजने के लिए एक स्थिर विधि (ऑपरेटर) को लागू करें

दूसरा विकल्प हमारे लिए अधिक सुविधाजनक लगता है, क्योंकि हमें अस्पष्ट पूर्वजों के साथ हमारी कक्षाओं को "गंदा" करने की आवश्यकता नहीं है और इसके अलावा, यदि आप लॉगिंग को हटाने का निर्णय लेते हैं, तो आपको सभी वर्गों को साफ नहीं करना होगा। हम दिखाते हैं कि कार्यान्वयन दूसरे तरीके से कैसे दिखेगा:

कस्टम प्रकार

 /*    */ class Dummy { public: Dummy(int i, std::string s) : m_Int(i), m_String(s){} int getInt() const{return m_Int;} std::string const& getString() const {return m_String;} private: int m_Int; std::string m_String; }; /*    ,     operator<< */ inline MAKE_LOGGABLE(Dummy, obj, os) { /*        */ os << "{i:"<<obj.getInt()<<", s:"<<obj.getString()<<"}"; return os; } int main(void) { Dummy object(1, "Habrahabr"); LOG(INFO) << "Dummy: " << object; return 0; } /* : 11:03:27 INFO Dummy: {i:1, s:Habrahabr} */

फ़ाइलों को लॉग करें

डिफ़ॉल्ट रूप से, लॉग फ़ाइल एप्लिकेशन की कार्यशील निर्देशिका में स्थित होगी और इसमें पथ होगा ../logs/myeasylog.log।

आप किसी भी समय लॉग फ़ाइल का नाम या उसका स्थान बदल सकते हैं। यह उपयोगी हो सकता है यदि आपको जरूरत है, उदाहरण के लिए, हर दिन एक नई फ़ाइल पर स्विच करें। यहां लॉग फ़ाइल को मैन्युअल रूप से स्विच करने का एक उदाहरण दिया गया है:

मैनुअल स्विच

 int main(void) { LOG(INFO) << "     "; el::Loggers::reconfigureAllLoggers(el::ConfigurationType::Filename, "logs/20140205.log"); LOG(INFO) << "    "; return 0; }

इसे पूरा करने के बाद, लॉग फ़ोल्डर में दो फाइलें दिखाई देंगी: myeasylog.log और 20140205.log। प्रत्येक संदेश अपनी फ़ाइल में होगा। यह देखना आसान है कि "मैनुअल" मोड में दिए गए एल्गोरिथम के अनुसार लॉग को स्विच करना समान रूप से संभव है (उदाहरण के लिए, दैनिक लॉग बनाने के लिए या प्रत्येक फ़ाइल के लिए रिकॉर्ड की एक निश्चित संख्या आवंटित करने के लिए)

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

छिपा हुआ पाठ

 /*   .     *    timestamp.*/ int log_sequence = 1; /* Callback       fname  */ void LogsRollout(const char* fname, size_t fsize) { /*        ( ) */ string fileName = fname; size_t position = fileName.find("."); string extractName = (string::npos == position)? fileName : fileName.substr(0, position); extractName = extractName + to_string(log_sequence++) + ".log"; /*     ,   */ int status = rename(fname, extractName.c_str()); if(status) { /*    */ } } int main(void) { /*         */ el::Loggers::addFlag(el::LoggingFlag::StrictLogFileSizeCheck); /*        1 */ el::Loggers::reconfigureAllLoggers(el::ConfigurationType::MaxLogFileSize, "1024"); /*  callback    */ el::Helpers::installPreRollOutCallback(LogsRollout); /*    */ for(int i=0; i<1024; i++) { LOG(INFO) << "Message #"<< i+1; } return 0; }

सशर्त और आवधिक जारी करना

लाइब्रेरी में मैक्रो LOG_IF घोषित किया गया है कि केवल लॉग को एक संदेश जारी करने के लिए यदि निर्दिष्ट शर्त पूरी की जाती है:

छिपा हुआ पाठ

 LOG_IF(true, INFO) << " "; LOG_IF(false, WARNING) << "  ";

आवधिक जारी करना कई मामलों में भी उपयोगी हो सकता है। इस पद्धति का अर्थ है कि प्रत्येक संदेश लॉग नहीं किया जाएगा, लेकिन, उदाहरण के लिए, प्रत्येक 10 वीं या 100 वीं। इस मामले में, दो संभावनाएँ कार्यान्वित की जाती हैं:

LOG_EVERY_N (n, LEVEL) - प्रत्येक nth संदेश प्रदर्शित करता है
LOG_AFTER_N (n, LEVEL) - केवल n संचालन के बाद एक संदेश प्रदर्शित करता है

प्रोग्राम क्रैश की जाँच और हैंडलिंग

लाइब्रेरी में लॉग और असामान्य समाप्ति के लिए एक संदेश जारी करने के लिए मैक्रों की एक संख्या घोषित की जाती है, केवल तभी जब कुछ महत्वपूर्ण स्थिति पूरी नहीं होती है: CHECK, CHECK_EQ, CHECK_NE, CHECK_NOTNULL , आदि। ये मैक्रोज़ मुखर के समान हैं, लेकिन लॉगिंग के साथ।

उनका उपयोग करना काफी सुविधाजनक है:

छिपा हुआ पाठ

 CHECK(true) << "  "; CHECK_LE(2, 1) << "2 < 1 ???"; CHECK_STREQ(argv[3], "1") << "    1";

यह इस तरह से पड़ता है जब स्थिति पूरी नहीं होती है:

 07:12:51,375 FATAL Check failed: [2 <= 1] 2 < 1 ??? 07:12:51,375 WARN Aborting application. Reason: Fatal log at [/home/borg/Temp/App/main.cpp:34] Aborted

यदि आप डिफ़ॉल्ट सेटिंग्स को नहीं बदलते हैं, तो यदि शर्त पूरी नहीं होती है, तो कार्यक्रम बाधित हो जाएगा और संदेश लॉग में FATAL स्तर के साथ दिखाई देगा।

इसके अतिरिक्त, लाइब्रेरी डिफ़ॉल्ट रूप से एप्लिकेशन क्रैश को संभालती है। यह व्यवहार, ज़ाहिर है, बंद किया जा सकता है, लेकिन कभी-कभी यह कई संकेतों के लिए लॉग प्राप्त करने के लिए सुविधाजनक हो सकता है, उदाहरण के लिए: SIGFPE, SIGILL, SIGSEGV, आदि। जीसीसी के लिए, आप कॉल स्टैक लॉग भी जारी कर सकते हैं।

छिपा हुआ पाठ

 #include "easylogging++.h" _INITIALIZE_EASYLOGGINGPP void CustomCrashHandler(int signal) { LOG(ERROR) << " !!"; /*     */ el::Helpers::crashAbort(signal); } int main(int argv, char* argc[]) { /*    */ el::Helpers::setCrashHandler(CustomCrashHandler); /*   0 */ int a = 0; a = 1/a; return 0; }

यह इस प्रकार है:

 17:46:53,074 ERROR  !! Aborted

निष्कर्ष

ईज़ीलॉगिंग ++ लाइब्रेरी कार्यक्षमता का अधिक या कम पूरा सेट प्रस्तुत करता है जो कि ऐसे उत्पाद में देखने की उम्मीद करेगा।

निस्संदेह फायदे में शामिल हैं: इसकी कॉम्पैक्टनेस, ऑपरेशन में आसानी और क्रॉस-प्लेटफॉर्म।

एकमात्र दोष C ++ 11 का उपयोग करने की आवश्यकता होगी, हालांकि, शायद, लेखक "साधारण" C ++ के साथ मिल सकते हैं।

संदेश आसान लॉगिंग के साथ ++

पूछे जाने वाले प्रश्न:

क्यों:

प्रारूप सेटिंग

कस्टम प्रकार

फ़ाइलों को लॉग करें

सशर्त और आवधिक जारी करना

प्रोग्राम क्रैश की जाँच और हैंडलिंग

निष्कर्ष

More articles: