บันทึก 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/examples/platforms/simulation/openthread-core-simulation-config.h แทน openthread/src/core/config/logging.h

ระดับการบันทึก

บันทึกอาจแสดงข้อมูลในระดับต่างๆ โดยกําหนดเป็นค่าคงที่เวลาคอมไพเลอร์ OPENTHREAD_CONFIG_LOG_LEVEL ตัวเลือกระดับจะแสดงอยู่ในไฟล์ต่อไปนี้

openthread/include/openthread/platform/logging.h

คุณสามารถดูรายการระดับบันทึกได้ในการอ้างอิง API ของแพลตฟอร์มการบันทึกแพลตฟอร์ม

ระดับบันทึกเริ่มต้นคือ OT_LOG_LEVEL_CRIT ซึ่งจะแสดงผลเฉพาะบันทึกที่สําคัญที่สุดเท่านั้น เปลี่ยนระดับเพื่อดูบันทึกเพิ่มเติมตามต้องการ หากต้องการดูบันทึก OpenThread ทั้งหมด ให้ใช้ OT_LOG_LEVEL_DEBG

ภูมิภาคของบันทึก

ภูมิภาคของบันทึกจะกําหนดพื้นที่ของโค้ด OpenThread ที่เปิดใช้สําหรับการบันทึก การแจกแจงภูมิภาคจะอยู่ในไฟล์ต่อไปนี้

openthread/include/openthread/platform/logging.h

นอกจากนี้ ยังระบุภูมิภาคของบันทึกได้ในการอ้างอิง Enumerations API ของแพลตฟอร์ม

โดยทั่วไปแล้วจะใช้ภูมิภาคบันทึกเป็นพารามิเตอร์ในฟังก์ชันบันทึก ทุกภูมิภาคจะ เปิดใช้โดยค่าเริ่มต้น

ฟังก์ชันการบันทึกเริ่มต้น

ฟังก์ชันเริ่มต้นสําหรับการบันทึกภายใน OpenThread คือ otPlatLog ซึ่งกําหนดเป็นค่าคงที่เวลาคอมไพล์ของ OPENTHREAD_CONFIG_PLAT_LOG_FUNCTION

ดูข้อมูลเพิ่มเติมเกี่ยวกับฟังก์ชันนี้ได้ที่การอ้างอิง Platform Logging API

หากต้องการใช้ฟังก์ชันนี้ในแอปตัวอย่าง OpenThread โดยตรง ให้ใช้ตัวเลือก OT_REFERENCE_DEVICE cmake เช่น หากต้องการใช้ในแอป CLI สําหรับตัวอย่าง CC2538 ให้ทําดังนี้

./script/build -DOT_REFERENCE_DEVICE=ON

หรืออัปเดตไฟล์ openthread/etc/cmake/options.cmake เพื่อเปิดใช้โดยค่าเริ่มต้นเมื่อสร้าง

วิธีเปิดใช้บันทึก

ก่อนเปิดใช้บันทึก โปรดตรวจสอบว่าได้กําหนดค่าสภาพแวดล้อมสําหรับการสร้าง OpenThread แล้ว โปรดดูข้อมูลเพิ่มเติมที่สร้าง OpenThread

เปิดใช้บันทึกทั้งหมด

หากต้องการเปิดใช้ระดับและภูมิภาคของบันทึกทั้งหมดอย่างรวดเร็ว ให้ใช้ตัวเลือก cmake ของ OT_FULL_LOGS ดังนี้

./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)

ดูบันทึกในแอป CLI

ดูบันทึกได้โดยตรงในแอปตัวอย่าง 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 CLI ที่ระบบจะประมวลผลคําสั่ง

หากคุณเพิ่มการบันทึกที่กําหนดเองและเปิดใช้บันทึกทั้งหมด การบัฟเฟอร์บรรทัด CLI หรือ UART อาจบัฟเฟอร์ไม่มากพอที่จะรองรับบันทึกที่กําหนดเองเพิ่มเติม หากบันทึกบางรายการไม่ปรากฏขึ้นเมื่อปกติ ให้ลองเพิ่มขนาดบัฟเฟอร์ของบรรทัด CLI ซึ่งกําหนดเป็น OPENTHREAD_CONFIG_CLI_MAX_LINE_LENGTH ใน /openthread/src/cli/cli_config.h หรือเพิ่มขนาดของบัฟเฟอร์การส่ง UART ที่กําหนดเป็น OPENTHREAD_CONFIG_CLI_UART_TX_BUFFER_SIZE ในไฟล์การกําหนดค่าของแพลตฟอร์ม เช่น /src/nrf52840/openthread-core-nrf52840-config.h

ดูบันทึกสําหรับ NCP

บันทึกสําหรับ NCP อาจส่งผ่าน wpantund ไปยัง syslog ของโฮสต์ สําหรับโฮสต์ Linux นี่คือ /var/log/syslog.

ใช้ค่า OPENTHREAD_CONFIG_LOG_OUTPUT ของ OPENTHREAD_CONFIG_LOG_OUTPUT_APP เพื่อเปิดใช้การบันทึก NCP เปลี่ยนตัวเลือกนี้ในไฟล์การกําหนดค่าของแพลตฟอร์ม

เช่น หากต้องการเปิดใช้สําหรับ nrf52840 ที่เชื่อมต่อกับโฮสต์ Linux ให้ทําดังนี้

1. แก้ไขไฟล์การกําหนดค่าสําหรับแพลตฟอร์มและเปลี่ยนเอาต์พุตบันทึกไปยังแอป สําหรับ nrf52840 นี่คือ ./src/nrf52840/openthread-core-nrf52840-config.h ในที่เก็บ ot-nrf528xx

   #define OPENTHREAD_CONFIG_LOG_OUTPUT OPENTHREAD_CONFIG_LOG_OUTPUT_APP
   

2. สร้างตัวอย่าง nrf52840 ที่มีระดับของบันทึกที่ต้องการและแฟล็กเฉพาะ NCP วิธีสร้างตัวเชื่อมโดยเปิดใช้บันทึกทั้งหมดมีดังนี้

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

3. แฟลช NCP, เชื่อมต่อกับโฮสต์ Linux และเริ่มต้น wpantund ตามรายละเอียดในที่เก็บ wpantund

4. เมื่อ NCP ทํางานอยู่ ให้ตรวจสอบ syslog บนเครื่อง Linux ดังนี้

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

5. คุณจะเห็นบันทึก OpenThread แบบเรียลไทม์สําหรับ NCP นอกจากนี้ คุณยังอาจเห็นเอาต์พุตนี้ในเอาต์พุต 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. สําหรับ system-on-chip (SoC) ให้ใช้ Loging API ภายในแอปพลิเคชัน OpenThread ของคุณ
   2. สําหรับ NCP ให้ใช้ wpanctl ในบรรทัดคําสั่ง ดู wpan-properties.h ในที่เก็บ wpantund สําหรับพร็อพเพอร์ตี้ทั้งหมดที่เปิดเผยใน wpanctl และ Ssprl API สําหรับคําจํากัดความระดับบันทึก

      wpanctl set OpenThread:LogLevel 5