บันทึก 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

รายการระดับบันทึกยังอยู่ในเอกสารอ้างอิง Platform Logging Macros API ด้วย

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

หมายเหตุ: ขนาดโค้ดที่คอมไพล์จะเพิ่มขึ้นเมื่อเปิดใช้บันทึกมากขึ้น

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

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

openthread/include/openthread/platform/logging.h

รายการภูมิภาคของบันทึกยังอยู่ในเอกสารอ้างอิง API ของ Platform Logging Enumerations ด้วย

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

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

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

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

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

./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. ในโหนดจำลอง ให้เปิด Thread โดยทำดังนี้

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

เปลี่ยนระดับการบันทึกในขณะรันไทม์

ระดับบันทึกอาจเปลี่ยนแปลงได้ในขณะรันหากเปิดใช้การควบคุมระดับบันทึกแบบไดนามิก

1. สร้างแอปด้วยตัวเลือก -DOT_LOG_LEVEL_DYNAMIC=ON ตัวอย่างเช่น

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

2. ใช้ Logging API ภายในแอปพลิเคชัน OpenThread