OpenThread लॉग

GitHub पर सोर्स देखें

OpenThread लॉग को कई कंपाइल-टाइम कॉन्फ़िगरेशन कॉन्सटेंट से कंट्रोल किया जाता है. जब तक अलग से बताया न जाए, इन कॉन्सटेंट के बारे में इस फ़ाइल में बताया गया है:

openthread/src/core/config/logging.h

आउटपुट के तरीके

OpenThread में, अलग-अलग आउटपुट लॉगिंग तरीकों का इस्तेमाल किया जाता है, जिन्हें OPENTHREAD_CONFIG_LOG_OUTPUT के कंपाइल-टाइम कॉन्फ़िगरेशन कॉन्सटेंट के तौर पर परिभाषित किया जाता है. लॉग इन करने के तरीकों के विकल्प इस फ़ाइल में हैं:

openthread/src/core/config/logging.h

डिफ़ॉल्ट लॉग आउटपुट कॉन्फ़िगरेशन OPENTHREAD_CONFIG_LOG_OUTPUT_PLATFORM_DEFINED है.

आउटपुट का तरीका एक उदाहरण है, जिसमें आपको कोर कॉन्फ़िगरेशन के बजाय प्लैटफ़ॉर्म लेवल कॉन्फ़िगरेशन कॉन्सटेंट को अपडेट करना पड़ सकता है. उदाहरण के लिए, सिम्युलेशन के उदाहरण वाले ऐप्लिकेशन में आउटपुट का तरीका बदलने के लिए, openthread/src/core/config/logging.h के बजाय openthread/examples/platforms/simulation/openthread-core-simulation-config.h में बदलाव करें.

लॉग लेवल

लॉग में जानकारी के अलग-अलग लेवल हो सकते हैं, जिन्हें OPENTHREAD_CONFIG_LOG_LEVEL के कंपाइल-टाइम कॉन्फ़िगरेशन कॉन्सटेंट के तौर पर परिभाषित किया जाता है. लेवल के विकल्प इस फ़ाइल में तय किए गए हैं:

openthread/include/openthread/platform/logging.h

लॉग लेवल की सूची, प्लैटफ़ॉर्म मैक्रो एपीआई के रेफ़रंस में भी उपलब्ध है.

डिफ़ॉल्ट लॉग लेवल OT_LOG_LEVEL_CRIT है, जो सिर्फ़ सबसे ज़रूरी लॉग दिखाता है. ज़रूरत के मुताबिक ज़्यादा लॉग देखने के लिए लेवल बदलें. सभी OpenThread लॉग देखने के लिए, OT_LOG_LEVEL_DEBG का इस्तेमाल करें.

क्षेत्र लॉग करें

लॉग क्षेत्र यह तय करते हैं कि OpenThread कोड के कौन से क्षेत्र लॉगिंग के लिए सक्षम हैं. क्षेत्र के बारे में जानकारी, नीचे दी गई फ़ाइल में दी गई है:

openthread/include/openthread/platform/logging.h

लॉग क्षेत्र की सूची प्लैटफ़ॉर्म लॉगिंग गणना एपीआई के संदर्भ में भी उपलब्ध है.

आम तौर पर, लॉग फ़ंक्शन में लॉग क्षेत्रों का इस्तेमाल पैरामीटर के तौर पर किया जाता है. सभी क्षेत्र डिफ़ॉल्ट रूप से चालू होते हैं.

डिफ़ॉल्ट लॉगिंग फ़ंक्शन

OpenThread में लॉग इन करने के लिए डिफ़ॉल्ट फ़ंक्शन otPlatLog है. इसे OPENTHREAD_CONFIG_PLAT_LOG_FUNCTION के कंपाइल-टाइम कॉन्फ़िगरेशन कॉन्सटेंट के तौर पर परिभाषित किया गया है.

इस फ़ंक्शन पर ज़्यादा जानकारी के लिए, प्लैटफ़ॉर्म लॉगिंग एपीआई देखें.

इस फ़ंक्शन को सीधे OpenThread उदाहरण ऐप्लिकेशन में इस्तेमाल करने के लिए, OT_REFERENCE_DEVICE Cmake विकल्प का इस्तेमाल करें. उदाहरण के लिए, CC2538 के लिए CLI ऐप्लिकेशन के अंदर इसका इस्तेमाल करने के लिए:

./script/build -DOT_REFERENCE_DEVICE=ON

इसके अलावा, openthread/etc/cmake/options.cmake फ़ाइल बनाते समय, उसे डिफ़ॉल्ट रूप से चालू करने के लिए अपडेट करें.

लॉग चालू करने का तरीका

लॉग सक्षम करने से पहले, पक्का करें कि आपका परिवेश OpenThread को बनाने के लिए कॉन्फ़िगर किया गया है. ज़्यादा जानकारी के लिए, OpenThread बनाएं.

सभी लॉग चालू करें

सभी लॉग लेवल और इलाकों को तुरंत चालू करने के लिए, OT_FULL_LOGS cmake विकल्प का इस्तेमाल करें:

./script/build -DOT_FULL_LOGS=ON

यह स्विच, लॉग लेवल को OT_LOG_LEVEL_DEBG पर सेट करता है. साथ ही, उसे सभी इलाकों के फ़्लैग चालू करता है.

लॉग का खास लेवल चालू करें

लॉग का खास लेवल चालू करने के लिए, openthread/src/core/config/logging.h में बदलाव करें और अपनी पसंद के लेवल पर OPENTHREAD_CONFIG_LOG_LEVEL को अपडेट करें. इसके बाद, OpenThread बनाएं. उदाहरण के लिए, OT_LOG_LEVEL_INFO तक के लॉग चालू करने के लिए:

#define OPENTHREAD_CONFIG_LOG_LEVEL OT_LOG_LEVEL_INFO

./script/build

syslog में लॉग देखें

डिफ़ॉल्ट रूप से, लॉग syslog पर भेजे जाते हैं. Linux पर, यह /var/log/syslog. है

1. सभी लॉग चालू करके, सिम्युलेशन का उदाहरण बनाएं:

   cd openthread
   ./script/cmake-build simulation -DOT_FULL_LOGS=ON
   

2. सिम्युलेट किया गया नोड शुरू करें:

   ./build/simulation/examples/apps/cli/ot-cli-ftd 1
   

3. नई टर्मिनल विंडो में, OT लॉग का रीयल-टाइम आउटपुट सेट अप करें:

   tail -F /var/log/syslog | grep "ot-cli-ftd"
   

4. सिम्युलेट किए गए नोड में, थ्रेड लाएं:

dataset init new
Done
dataset
Active Timestamp: 1
Channel: 13
Channel Mask: 07fff800
Ext PAN ID: d63e8e3e495ebbc3
Mesh Local Prefix: fd3d:b50b:f96d:722d/64
Network Key: dfd34f0f05cad978ec4e32b0413038ff
Network Name: OpenThread-8f28
PAN ID: 0x8f28
PSKc: c23a76e98f1a6483639b1ac1271e2e27
Security Policy: 0, onrcb
Done
dataset commit active
Done
ifconfig up
Done
thread start
Done

tail कमांड रन करने वाली टर्मिनल विंडो पर वापस जाएं. लॉग सिम्युलेट किए गए नोड के लिए, रीयल टाइम में दिखने चाहिए. आउटपुट में लॉग टैग नोट करें: [INFO], [DEBG], [NOTE]. ये सभी लॉग लेवल से मेल खाते हैं. उदाहरण के लिए, अगर लॉग लेवल को OT_LOG_LEVEL_INFO में बदला जाता है, तो आउटपुट से DEBG लॉग गायब हो जाते हैं.

ot-cli-ftd[30055]: [1] [DEBG]-MAC-----: SrcAddrMatch - Cleared all entries
ot-cli-ftd[30055]: [1] [INFO]-CORE----: Non-volatile: Read NetworkInfo {rloc:0x9c00, extaddr:1a4aaf5e97c852de, role:Leader, mode:0x0f, keyseq:0x0, ...
ot-cli-ftd[30055]: [1] [INFO]-CORE----: Non-volatile: ... pid:0x8581bc9, mlecntr:0x3eb, maccntr:0x3e8, mliid:05e4b515e33746c8}
ot-cli-ftd[30055]: [1] [INFO]-CORE----: Notifier: StateChanged (0x7f133b) [Ip6+ Ip6- LLAddr MLAddr Rloc+ KeySeqCntr NetData Ip6Mult+ Channel PanId NetName ExtPanId MstrKey PSKc SecPolicy]
ot-cli-ftd[30055]: [1] [INFO]-CLI-----: execute command: dataset panid
ot-cli-ftd[30055]: [1] [INFO]-CLI-----: execute command: dataset commit active
ot-cli-ftd[30055]: [1] [INFO]-MESH-CP-: Active dataset set
ot-cli-ftd[30055]: [1] [DEBG]-MAC-----: Idle mode: Radio sleeping
ot-cli-ftd[30055]: [1] [DEBG]-MAC-----: RadioPanId: 0x8f28
ot-cli-ftd[30055]: [1] [INFO]-CORE----: Notifier: StateChanged (0x007f0100) [KeySeqCntr Channel PanId NetName ExtPanId MstrKey PSKc SecPolicy]
ot-cli-ftd[30055]: [1] [INFO]-CLI-----: execute command: ifconfig up
ot-cli-ftd[30055]: [1] [DEBG]-MAC-----: Idle mode: Radio receiving on channel 11
ot-cli-ftd[30055]: [1] [INFO]-CLI-----: execute command: thread start
ot-cli-ftd[30055]: [1] [NOTE]-MLE-----: Role Disabled -> Detached
ot-cli-ftd[30055]: [1] [INFO]-MLE-----: Attempt to become router
ot-cli-ftd[30055]: [1] [INFO]-CORE----: Non-volatile: Read NetworkInfo {rloc:0x9c00, extaddr:1a4aaf5e97c852de, role:Leader, mode:0x0f, keyseq:0x0, ...
ot-cli-ftd[30055]: [1] [INFO]-CORE----: Non-volatile: ... pid:0x8581bc9, mlecntr:0x3eb, maccntr:0x3e8, mliid:05e4b515e33746c8}
ot-cli-ftd[30055]: [1] [INFO]-CORE----: Non-volatile: Saved NetworkInfo {rloc:0x9c00, extaddr:1a4aaf5e97c852de, role:Leader, mode:0x0f, keyseq:0x0, ...
ot-cli-ftd[30055]: [1] [INFO]-CORE----: Non-volatile: ... pid:0x8581bc9, mlecntr:0x7d4, maccntr:0x7d0, mliid:05e4b515e33746c8}
ot-cli-ftd[30055]: [1] [DEBG]-MLE-----: Store Network Information
ot-cli-ftd[30055]: [1] [INFO]-MLE-----: Send Link Request (ff02:0:0:0:0:0:0:2)

सीएलआई ऐप्लिकेशन में लॉग देखें

लॉग सीधे OpenThread CLI उदाहरण ऐप्लिकेशन में देखे जा सकते हैं.

1. उदाहरण के तौर पर दिए गए प्लैटफ़ॉर्म की कॉन्फ़िगरेशन फ़ाइल में बदलाव करें और लॉग आउटपुट को ऐप्लिकेशन में बदलें. सिम्युलेशन के उदाहरण के लिए, यह openthread/examples/platforms/simulation/openthread-core-simulation-config.h है:

   #define OPENTHREAD_CONFIG_LOG_OUTPUT OPENTHREAD_CONFIG_LOG_OUTPUT_APP
   

2. लॉग के मनचाहे लेवल से सिम्युलेशन का उदाहरण बनाएं. सभी लॉग चालू करने के लिए:

   ./script/cmake-build simulation -DOT_FULL_LOGS=ON
   

3. सिम्युलेट किया गया नोड शुरू करें:

   ./build/simulation/examples/apps/cli/ot-cli-ftd 1
   

4. आपको उसी विंडो में लॉग आउटपुट देखना चाहिए जिसमें OpenThread सीएलआई प्रोसेस होते हैं.

अगर आपने कस्टम लॉग इन किया है और सभी लॉग चालू किए हैं, तो हो सकता है कि सीएलआई लाइन बफ़र या UART ट्रांसमिट बफ़र, अतिरिक्त कस्टम लॉग को हैंडल करने के लिए काफ़ी न हों. अगर कुछ लॉग सही समय पर नहीं दिख रहे हैं, तो सीएलआई लाइन बफ़र का साइज़ बढ़ाकर देखें. इसे /openthread/src/cli/cli_config.h में OPENTHREAD_CONFIG_CLI_MAX_LINE_LENGTH के तौर पर या प्लैटफ़ॉर्म की कॉन्फ़िगरेशन फ़ाइल में, OPENTHREAD_CONFIG_CLI_UART_TX_BUFFER_SIZE के तौर पर बताए गए UART ट्रांसमिट बफ़र का साइज़ बढ़ाकर/src/nrf52840/openthread-core-nrf52840-config.h देखें.

किसी NCP के लॉग देखें

किसी NCP के लॉग, होस्ट के syslog पर wpantund के ज़रिए भेजे जा सकते हैं. Linux होस्ट के लिए, यह /var/log/syslog. है

NCP लॉगिंग सक्षम करने के लिए OPENTHREAD_CONFIG_LOG_OUTPUT_APP के OPENTHREAD_CONFIG_LOG_OUTPUT मान का उपयोग करें. इसे प्लैटफ़ॉर्म की कॉन्फ़िगरेशन फ़ाइल में बदलें.

उदाहरण के लिए, किसी Linux होस्ट से कनेक्ट किए गए nrf52840 के लिए:

1. प्लैटफ़ॉर्म की कॉन्फ़िगरेशन फ़ाइल में बदलाव करें और लॉग आउटपुट को ऐप्लिकेशन में बदलें. nrf52840 के लिए, यह ot-nrf528xx डेटा स्टोर करने की जगह में ./src/nrf52840/openthread-core-nrf52840-config.h है:

   #define OPENTHREAD_CONFIG_LOG_OUTPUT OPENTHREAD_CONFIG_LOG_OUTPUT_APP
   

2. nrf52840 का उदाहरण बनाकर लॉग के मनमुताबिक लेवल और एनसीपी के खास फ़्लैग बनाएं. सभी लॉग के साथ जॉइनर बनाने के लिए:

   ./script/build nrf52840 UART_trans -DOT_JOINER=ON -DOT_FULL_LOGS=ON
   

3. एनसीपी फ़्लैश करें, इसे Linux होस्ट से कनेक्ट करें, और wpantund डेटा स्टोर करने की जगह में जानकारी के हिसाब से wpantund शुरू करें.

4. एनसीपी चलने के बाद, Linux मशीन पर syslog देखें:

   tail -F /var/log/syslog | grep "wpantund"
   

5. आपको एनसीपी के लिए, OpenThread लॉग रीयल टाइम में दिखेंगे. इन्हें wpantund आउटपुट में भी देखा जा सकता है.

रन टाइम के दौरान, लॉग लेवल में बदलाव करना

अगर डाइनैमिक लॉग लेवल कंट्रोल चालू है, तो रन टाइम पर लॉग लेवल बदले जा सकते हैं.

1. -DOT_LOG_LEVEL_DYNAMIC=ON विकल्प का इस्तेमाल करके ऐप्लिकेशन बनाएं. उदाहरण के लिए,

   ./script/build nrf52840 UART_trans -DOT_JOINER=ON -DOT_FULL_LOGS=ON -DOT_LOG_LEVEL_DYNAMIC=ON
   

2. लागू करने के तरीके के आधार पर लॉग लेवल बदलें:
   1. सिस्टम-ऑन-चिप (SoC) के लिए, अपने OpenThread ऐप्लिकेशन में लॉगिंग एपीआई का इस्तेमाल करें.
   2. एनसीपी के लिए, कमांड लाइन पर wpanctl का इस्तेमाल करें. wpanctl को दिखाने वाली सभी प्रॉपर्टी के लिए, wpantund डेटा स्टोर करने की जगह में wpan-properties.h और लॉग लेवल पर परिभाषाओं के लिए Spinel API देखें.

      wpanctl set OpenThread:LogLevel 5