EasyLogger

EasyLogger

---

1. บทนำ

EasyLogger เป็นน้ำหนักเบาพิเศษ (ROM <1.6K, RAM <0.3K), ห้องสมุดบันทึก C/C ++ ประสิทธิภาพสูงซึ่งเหมาะสำหรับโครงการซอฟต์แวร์ที่ไวต่อทรัพยากรเช่น: ผลิตภัณฑ์ IoT, อุปกรณ์ที่สวมใส่ได้, บ้านอัจฉริยะและอื่น ๆ เมื่อเปรียบเทียบกับไลบรารีบันทึก C/C ++ ที่รู้จักกันดีเช่น Log4c และ Zlog, EasyLogger มีฟังก์ชั่นที่ง่ายกว่าและให้อินเทอร์เฟซน้อยลงให้กับผู้ใช้ แต่จะเริ่มต้นใช้งานได้อย่างรวดเร็ว

1.1 คุณสมบัติหลัก

• รองรับวิธีการส่งออกที่ผู้ใช้กำหนด (ตัวอย่างเช่น: เทอร์มินัลไฟล์ฐานข้อมูลพอร์ตอนุกรม 485, แฟลช ... );
• เนื้อหาบันทึกอาจรวมถึงระดับการประทับเวลาข้อมูลเธรดข้อมูลกระบวนการ ฯลฯ ;
• เอาต์พุตบันทึกได้รับการออกแบบเป็นวิธีการแบบเธรดที่ปลอดภัยและรองรับ เอาต์พุตแบบอะซิงโครนัส และโหมด เอาต์พุตบัฟเฟอร์
• รองรับระบบปฏิบัติการหลายระบบ (RT-Thread, UCOS, Linux, Windows, Nuttx ... ) และยังรองรับแพลตฟอร์มโลหะเปลือย
• บันทึกสนับสนุน รูปแบบดิบ และการสนับสนุน hexdump ;
• รองรับการกรองแบบไดนามิกโดย แท็ก ระดับ และ คำหลัก
• บันทึกในทุกระดับรองรับสีที่แตกต่างกันเพื่อแสดง
• ขยายได้อย่างมากรองรับการขยายฟังก์ชั่นใหม่ในรูปแบบของปลั๊กอิน

คำอธิบายของคำนาม:

• 1. รูปแบบดิบ: บันทึกต้นฉบับที่ไม่ได้ฟอร์แมต
• 2. แท็ก: ในซอฟต์แวร์คุณสามารถตั้งค่าแท็กสำหรับบันทึกที่ต้องพิมพ์ตามไฟล์โมดูลฟังก์ชั่น ฯลฯ เพื่อตระหนักถึงการจำแนกประเภทบันทึก

1.2 ปลั๊กอิน

• 1. แฟลช: ใช้อินเทอร์เฟซการทำงานของแฟลชที่จัดทำโดยไลบรารี EasyFlash และจัดเก็บบันทึกโดยตรงในแฟลชโดยไม่จำเป็นต้องใช้ระบบไฟล์
• 2. ไฟล์: รองรับการถ่ายโอนไฟล์การบันทึกการวนรอบไฟล์และฟังก์ชั่นอื่น ๆ ที่เกี่ยวข้องกับเอาต์พุตบันทึกไฟล์
• 3. คอยติดตาม ...

1.3 Star & Fork

ฉันจะให้ปลั๊กอินเพิ่มเติมในภายหลัง นอกจากนี้เรายังยินดีเป็นอย่างยิ่งในการออกแบบและพัฒนาปลั๊กอินและฟังก์ชั่นที่ใช้งานได้จริงเพื่อปรับปรุง EasyLogger (GitHub | Oschina | การเข้ารหัส) หากคุณคิดว่าโครงการโอเพ่นซอร์สนี้ยอดเยี่ยมคุณสามารถคลิก ดาว ที่มุมบนขวาของหน้าแรกของโครงการและแนะนำให้เพื่อนที่ต้องการมากขึ้น

2. ใช้

2.1 การกำหนดค่าพารามิเตอร์

EasyLogger มีคุณสมบัติเช่นวิธีการกรองรูปแบบเอาต์พุตและสวิตช์เอาต์พุต

• วิธีการกรองรองรับการกรองตามป้ายกำกับระดับและคำหลัก
• เอาต์พุตบันทึกสามารถเปิด/ปิดแบบไดนามิก;
• ระดับเอาต์พุตแบบไดนามิกและคงที่
  • คงที่: สวิตช์ระดับแรกที่กำหนดโดยมาโครใช้ในขั้นตอนการรวบรวม;
  • ไดนามิก: สวิตช์ทุติยภูมิถูกใช้ในระหว่างขั้นตอนการทำงานผ่านอินเตอร์เฟส API

หมายเหตุ: ปัจจุบันวิธีการกำหนดค่าพารามิเตอร์และเอาต์พุตเป็นโหมดซิงเกิลตันนั่นคือวิธีการกำหนดค่าเพียงวิธีเดียวเท่านั้นที่ได้รับการสนับสนุนทั่วโลก ในโหมดนี้ซอฟต์แวร์จะง่ายขึ้น แต่ไม่สามารถรองรับวิธีการส่งออกที่ซับซ้อนได้

2.2 ระดับเอาต์พุต

อ้างถึง Android Logcat ระดับสูงสุดคือ 0 (ยืนยัน) และระดับต่ำสุดคือ 5 (verbose)

 0.[A]：断言(Assert)
1.[E]：错误(Error)
2.[W]：警告(Warn)
3.[I]：信息(Info)
4.[D]：调试(Debug)
5.[V]：详细(Verbose)

2.2.1 เอาต์พุตบันทึกสีสันสดใส

เอฟเฟกต์สีเริ่มต้นของบันทึกในแต่ละระดับมีดังนี้ ผู้ใช้ยังสามารถตั้งค่าสีและรูปแบบตัวอักษรของบันทึกได้ที่ elog_cfg.h ตามการตั้งค่าของพวกเขา

2.3 การกรองเอาต์พุต

สนับสนุนการกรองตาม ระดับป้ายกำกับและคำหลัก เมื่อมีเนื้อหาบันทึกจำนวนมากฟังก์ชั่นการกรองสามารถใช้เพื่อค้นหาบันทึกได้เร็วขึ้นเพื่อให้แน่ใจว่าสามารถอ่านบันทึกได้ สำหรับการตั้งค่าฟังก์ชั่นตัวกรองเพิ่มเติมโปรดอ่านเอกสาร docszhapikernel.md

หมายเหตุ: รูปแบบ RAW และบันทึกรูปแบบ hexdump ไม่รองรับแท็กและการกรองคำหลัก

2.4 รูปแบบเอาต์พุต

รูปแบบเอาต์พุตรองรับ: ระดับ, เวลา, ฉลาก, ข้อมูลกระบวนการ, ข้อมูลเธรด, เส้นทางไฟล์, หมายเลขบรรทัด, ชื่อวิธี แต่ละระดับลำดับความสำคัญสามารถตั้งค่ารูปแบบผลลัพธ์ได้อย่างอิสระ

2.5 วิธีเอาต์พุต

ผ่านการพอร์ตของผู้ใช้วิธีการส่งออกใด ๆ สามารถรองรับได้ อย่างไรก็ตามสำหรับฟังก์ชั่นใหม่ที่อาจนำมาใช้ในวิธีการส่งออกบางอย่างจะต้องมีการใช้งานผ่านปลั๊กอินเช่นการถ่ายโอนไฟล์การดึงบันทึกแฟลช ฯลฯ ฯลฯ ปลั๊กอินเพิ่มเติมจะเป็นโอเพ่นซอร์สในภายหลัง ต่อไปนี้เป็นการเปรียบเทียบสั้น ๆ ของสถานการณ์การใช้งานผลลัพธ์บางอย่าง:

• เทอร์มินัล: สะดวกสำหรับผู้ใช้ในการดูแบบไดนามิกและไม่มีฟังก์ชั่นการจัดเก็บ
• ไฟล์และแฟลช: ทั้งคู่มีฟังก์ชั่นการจัดเก็บและผู้ใช้สามารถดูบันทึกประวัติ อย่างไรก็ตามวิธีการไฟล์ต้องการการสนับสนุนของระบบไฟล์และวิธีการแฟลชเหมาะสำหรับอุปกรณ์ฝังตัวขนาดเล็กที่ไม่มีระบบไฟล์

2.6 การสาธิต

2.6.1 ฟังก์ชั่นหลัก

รูปต่อไปนี้แสดงคำสั่งอินพุตในเทอร์มินัลเพื่อควบคุมเอาต์พุตบันทึกและการตั้งค่าตัวกรองซึ่งแสดงให้เห็นถึงฟังก์ชั่นหลักของ EasyLogger

• เส้นทางการสาธิต: demoosrt-threadstm32f10x
• เอกสาร API: docszhapikernel.md
• เอกสารการโยกย้าย: docszhportkernel.md

2.6.2 บันทึกแฟลช (บันทึกบันทึกเป็นแฟลช)

กระบวนการต่อไปนี้คือการบันทึกเอาต์พุตผ่านคอนโซลและจัดเก็บบันทึกเอาต์พุตลงในแฟลช รีสตาร์ทและอ่านบันทึกล่าสุดที่บันทึกไว้และในที่สุดก็ล้างบันทึกแฟลช

• เส้นทางการสาธิต: demoosrt-threadstm32f10x
• เอกสาร API: docszhapiflash.md
• เอกสารการโยกย้าย: docszhportflash.md

2.6.2 บันทึกไฟล์ (บันทึกบันทึกไปยังไฟล์)

ปลั๊กอินไฟล์ช่วยให้คุณสามารถบันทึกบันทึกไปยังไฟล์โดยอัตโนมัติ แต่ละไฟล์สามารถปรับขนาดได้

3. เอกสาร

สำหรับเนื้อหาเฉพาะโปรดดูไฟล์ภายใต้ docszh ให้แน่ใจว่าได้ใช้หลังจาก อ่านเอกสาร

4. ภายหลัง

• ที่เก็บแฟลช: เพิ่มที่เก็บข้อมูลบันทึกและฟังก์ชั่นการอ่านลงใน EasyFlash ทำให้ EasyLogger สามารถเชื่อมต่อได้อย่างราบรื่น ทำให้บันทึกง่ายขึ้นในการจัดเก็บใน ระบบที่ไม่ใช่ไฟล์ และมีฟังก์ชั่นของการดึงบันทึกในอดีต
• ไฟล์การกำหนดค่า: ไฟล์การกำหนดค่าภายใต้ระบบไฟล์;
• การถ่ายโอนไฟล์: การถ่ายโอนไฟล์ได้รับการสนับสนุนโดยความจุและเวลาในระบบไฟล์
• ผู้ช่วยบันทึก: พัฒนาผู้ช่วยบันทึกข้ามแพลตฟอร์มที่เข้ากันได้กับระบบ Linux, Windows และ Mac Front-end: HTML5 + Bootstrap + AngularJS + NW.JS, back-end: Rust + Iron + Rust-Websocket + Serial-RS;
• เอาต์พุตแบบอะซิงโครนัส: ปัจจุบันเอาต์พุตบันทึกและรหัสผู้ใช้ถูกซิงโครไนซ์ อย่างไรก็ตามบนแพลตฟอร์มที่มีความเร็วเอาต์พุตต่ำความเร็วการทำงานของซอฟต์แวร์จะลดลงเนื่องจากการเพิ่มฟังก์ชั่นการบันทึก ดังนั้นจะมีการเพิ่ม เอาต์พุตแบบอะซิงโครนัส ในภายหลังและการกรองคำหลักสามารถวางในเอาต์พุตแบบอะซิงโครนัส;
• Arduino: เพิ่ม Arduino Lib และให้การสาธิต;

5. ใบอนุญาต

MIT Copyright (c) [email protected]