लॉगिंग को समझना

यह आलेख लॉग मानकों, स्तर दिशानिर्देशों, कक्षाओं, उद्देश्यों और मल्टीस्टैक अनुमानों सहित लॉगिंग की प्रक्रिया को शामिल करता है।

लॉग मानक

logcat में संयुक्त उपयोग किए गए मानकों के मिश्रण के कारण एंड्रॉइड में लॉगिंग जटिल है। उपयोग किए जाने वाले मुख्य मानकों का विवरण नीचे दिया गया है:

स्रोत उदाहरण स्टैक स्तर मार्गदर्शन
RFC 5424 ( syslog मानक) लिनक्स कर्नेल, कई यूनिक्स अनुप्रयोग कर्नेल, सिस्टम डिमन्स
android.util.Log एंड्रॉइड फ्रेमवर्क + एप्लिकेशन लॉगिंग एंड्रॉइड फ्रेमवर्क और सिस्टम एप्लीकेशन
java.util.logging.Level जावा में सामान्य लॉगिंग गैर-प्रणाली अनुप्रयोग

चित्रा 1: लॉग स्तर मानकों।

हालांकि इन मानकों में से प्रत्येक में समान स्तर का निर्माण होता है, लेकिन वे ग्रैन्युलैरिटी में भिन्न होते हैं। मानकों में लगभग समकक्ष इस प्रकार हैं:

आरएफसी 5424 स्तर आरएफसी 5424 गंभीरता आरएफसी 5424 विवरण android.util.log java.util.logging.Level
0 आपातकालीन सिस्टम अनुपयोगी है Log.e / Log.wtf SEVERE
1 चेतावनी तुरंत कार्रवाई होनी चाहिए Log.e / Log.wtf SEVERE
2 नाजुक गंभीर स्थितियां Log.e / Log.wtf SEVERE
3 त्रुटि त्रुटि की स्थिति Log.e SEVERE
4 चेतावनी चेतावनी की स्थिति Log.w WARNING
5 सूचना सामान्य लेकिन महत्वपूर्ण Log.w WARNING
6 जानकारी सूचना संदेश Log.i INFO
7 डिबग डिबग-स्तरीय संदेश Log.d CONFIG , FINE
- - वर्बोज़ मैसेजिंग Log.v FINER / FINEST

चित्र 2: syslog , Android और Java लॉगिंग स्तर।

लॉग स्तर दिशानिर्देश

प्रत्येक लॉग मानक के लिए मौजूदा दिशानिर्देश दिए गए हैं। चुना गया लॉग स्तर उपयोग किए जा रहे उपयुक्त मानक का अनुसरण करता है, जैसे कर्नेल विकास के लिए syslog मानक का उपयोग करना।

लॉग स्तर के आदेश, कम से कम से लेकर अधिकतम तक, नीचे दिए गए तीन आंकड़ों में दिखाए गए हैं:

ERROR ये लॉग हमेशा रखे जाते हैं।
WARN ये लॉग हमेशा रखे जाते हैं।
INFO ये लॉग हमेशा रखे जाते हैं।
DEBUG ये लॉग संकलित किए जाते हैं लेकिन रनटाइम पर छीन लिए जाते हैं।
VERBOSE इन लॉग को विकास के दौरान छोड़कर किसी एप्लिकेशन में संकलित नहीं किया जाता है।

चित्र 3: android.util.Log

CONFIG स्थिर कॉन्फ़िगरेशन संदेशों के लिए संदेश स्तर
FINE ट्रेसिंग जानकारी प्रदान करने वाला संदेश स्तर
FINER काफी विस्तृत अनुरेखण संदेश इंगित करता है
FINEST अत्यधिक विस्तृत अनुरेखण संदेश इंगित करता है
INFO सूचनात्मक संदेशों के लिए संदेश स्तर
SEVERE संदेश का स्तर गंभीर विफलता का संकेत देता है
WARNING संभावित समस्या का संकेत देने वाला संदेश स्तर

चित्र 4: java.util.Logging.Level

0 आपातकालीन सिस्टम अनुपयोगी है
1 चेतावनी तुरंत कार्रवाई होनी चाहिए
2 नाजुक गंभीर स्थितियां
3 त्रुटि त्रुटि की स्थिति
4 चेतावनी चेतावनी की स्थिति
5 सूचना सामान्य लेकिन महत्वपूर्ण स्थिति
6 सूचना सूचनात्मक संदेश
7 डिबग डिबग-स्तरीय संदेश

चित्र 5: RFC 5424 - खंड 6.2.1

आवेदन लॉगिंग

चुनिंदा लॉगिंग को android.util.Log क्लास द्वारा Log#isLoggable का उपयोग करके TAG के साथ किया जाता है, जैसा कि नीचे दिखाया गया है:

if (Log.isLoggable("FOO_TAG", Log.VERBOSE)) {
 Log.v("FOO_TAG", "Message for logging.");
}

लॉगिंग का एक चुनिंदा स्तर प्रदान करने के लिए लॉग को रनटाइम पर ट्यून किया जा सकता है जैसा कि नीचे दिखाया गया है:

adb shell setprop log.tag.FOO_TAG VERBOSE

log.tag.* गुण रिबूट पर रीसेट हो जाते हैं। लगातार वेरिएंट हैं जो रिबूट में भी बने रहते हैं। नीचे देखें:

adb shell setprop persist.log.tag.FOO_TAG VERBOSE

Log#isLoggable चेक एप्लिकेशन कोड में लॉग ट्रेस छोड़ देते हैं। बूलियन DEBUG कंपाइलर ऑप्टिमाइज़ेशन का उपयोग करके लॉग ट्रेस को बायपास करते हैं जो कि false पर सेट होते हैं, जैसा कि नीचे दिखाया गया है:

private final static boolean DEBUG = false;

… If (DEBUG) { Log.v("FOO_TAG", "Extra debug logging."); }

संकलन समय पर R8 द्वारा ProGuard नियमों के माध्यम से प्रति-APK आधार पर लॉगिंग को हटाया जा सकता है। निम्न उदाहरण android.util.Log के लिए INFO स्तर लॉगिंग के नीचे सब कुछ हटा देता है:

# This allows proguard to strip isLoggable() blocks containing only <=INFO log
# code from release builds.
-assumenosideeffects class android.util.Log {
  static *** i(...);
  static *** d(...);
  static *** v(...);
  static *** isLoggable(...);
}
-maximumremovedandroidloglevel 4

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

एंड्रॉइड रनटाइम (एआरटी) में सिस्टम लॉगिंग

कई उपलब्ध वर्ग हैं जो सिस्टम अनुप्रयोगों और सेवाओं के लिए उपलब्ध हैं:

कक्षा प्रयोजन
android.telephony.Rlog रेडियो लॉगिंग
android.util.Log सामान्य आवेदन लॉगिंग
android.util.EventLog सिस्टम इंटीग्रेटर डायग्नोस्टिक इवेंट लॉगिंग
android.util.Slog प्लेटफ़ॉर्म फ्रेमवर्क लॉगिंग

चित्र 6: उपलब्ध सिस्टम लॉग कक्षाएं और उद्देश्य।

हालांकि android.util.Log और android.util.Slog समान लॉग स्तर मानकों का उपयोग करते हैं, Slog एक @hide क्लास है जिसका उपयोग केवल प्लेटफॉर्म द्वारा किया जा सकता है। EventLog स्तरों को /system/etc/event-log-tags में event.logtags फ़ाइल में प्रविष्टियों के लिए मैप किया जाता है।

मूल लॉगिंग

C/C++ में लॉगिंग syslog मानक का अनुसरण करता है जिसमें syslog (2) Linux कर्नेल syslog के अनुरूप होता है जो printk बफ़र को नियंत्रित करता है, और syslog (3) सामान्य सिस्टम लकड़हारे के अनुरूप होता है। एंड्रॉइड सामान्य सिस्टम लॉगिंग के लिए liblog लाइब्रेरी का उपयोग करता है।

liblog निम्नलिखित मैक्रो फॉर्म का उपयोग करके सबलॉग समूहों के लिए रैपर प्रदान करता है:

[Sublog Buffer ID] LOG [Log Level ID]

RLOGD , उदाहरण के लिए, [Radio log buffer ID] LOG [Debug Level] से मेल खाती है। प्रमुख liblog रैपर इस प्रकार हैं:

आवरण वर्ग उदाहरण कार्य
log_main.h ALOGV , ALOGW
log_radio.h RLOGD , RLOGE
log_system.h SLOGI , SLOGW

चित्र 7: liblog रैपर।

एंड्रॉइड में लॉगिंग के लिए उच्च स्तर के इंटरफेस हैं जो सीधे liblog उपयोग के पक्ष में हैं, जैसा कि नीचे देखा गया है:

पुस्तकालय प्रयोग
async_safe लाइब्रेरी केवल एसिंक-सिग्नल-सुरक्षित वातावरण से लॉगिंग के लिए
libbase लॉगिंग लाइब्रेरी जो लॉगिंग के लिए C++ स्ट्रीम इंटरफ़ेस प्रदान करती है, Google-शैली (glog) लॉगिंग के समान। libbase दोनों बाहरी परियोजनाओं में प्रयोग करने योग्य है और libbase_ndk का उपयोग करने वाले अनुप्रयोगों में उपलब्ध है।

चित्र 8: उच्च स्तरीय लॉग लाइब्रेरी।

मल्टीस्टैक अनुमान

ग्रैन्युलैरिटी और लेवल इंटेंट में अंतर के कारण, विभिन्न लॉगिंग मानकों का कोई स्पष्ट या सटीक मिलान नहीं है। उदाहरण के लिए, java.util.logging.Level और android.util.Log स्तर त्रुटि लॉग के लिए 1:1 मैच नहीं हैं:

java.util.Logging.Level android.util.log
गंभीर Log.wtf
गंभीर Log.e

चित्र 9: मानक जावा लॉगिंग बनाम एंड्रॉइड लॉगिंग में त्रुटि स्तर।

इस तरह के मामलों में, यह निर्धारित करने के लिए कि किस स्तर पर आवेदन करना है, व्यक्तिगत मानक का उपयोग करें।

एकाधिक स्टैक स्तर घटकों के साथ सिस्टम विकास के दौरान, प्रति-घटक का उपयोग करने के लिए कौन सा मानक निर्धारित करने के लिए चित्र 1 का पालन करें। टियर मैसेजिंग के लिए अनुमानित गाइड के लिए, चित्र 2 का पालन करें।

सुरक्षा और गोपनीयता

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

  • ईमेल पता
  • टेलीफ़ोन नंबर
  • नाम

इसी तरह, कुछ विवरणों को संवेदनशील माना जाता है, भले ही वे स्पष्ट रूप से व्यक्तिगत रूप से पहचाने जाने योग्य न हों।

उदाहरण के लिए, हालांकि समय क्षेत्र की जानकारी को व्यक्तिगत रूप से पहचान योग्य नहीं माना जाता है, यह उपयोगकर्ता के अनुमानित स्थान का संकेत देता है।

रिलीज से पहले सुरक्षा और गोपनीयता समीक्षा के हिस्से के रूप में लॉग नीति और स्वीकार्य विवरण को संभाला जाना चाहिए।