EasyLogger

Easylogger

---

1. Pendahuluan

Easylogger adalah kelas sangat ringan (ROM <1,6k, RAM <0,3k), Perpustakaan Log C/C ++ berkinerja tinggi, yang sangat ideal untuk proyek perangkat lunak yang peka terhadap sumber daya, seperti: Produk IoT, perangkat yang dapat dikenakan, rumah pintar, dan banyak lagi. Dibandingkan dengan perpustakaan log C/C ++ yang terkenal seperti Log4c dan Zlog, EasyLogger memiliki fungsi yang lebih sederhana dan menyediakan lebih sedikit antarmuka untuk pengguna, tetapi akan cepat untuk memulai.

1.1 Fitur Utama

• Mendukung metode output yang ditentukan pengguna (misalnya: terminal, file, basis data, port serial, 485, flash ...);
• Konten log dapat mencakup level, cap waktu, informasi utas, informasi proses, dll.;
• Output log dirancang sebagai metode yang aman-utas dan mendukung output asinkron dan mode output buffered ;
• Mendukung beberapa sistem operasi (RT-Thread, UCOS, Linux, Windows, Nuttx ...), dan juga mendukung platform logam telanjang;
• Log mendukung format mentah dan mendukung hexdump ;
• Mendukung penyaringan dinamis berdasarkan tag , level , dan kata kunci ;
• Log di semua tingkatan mendukung berbagai warna untuk ditampilkan;
• Sangat dapat diperluas, mendukung perluasan fungsi baru dalam bentuk plug-in.

Penjelasan Kata benda:

• 1. Format RAW: Log asli yang tidak diformat.
• 2. Tag: Dalam perangkat lunak, Anda dapat mengatur tag untuk log yang perlu dicetak sesuai dengan file, modul, fungsi, dll. Untuk mewujudkan klasifikasi log.

1.2 Plug-in

• 1. Flash: Gunakan antarmuka operasi flash yang disediakan oleh perpustakaan EasyFlash, dan langsung menyimpan log di flash tanpa perlu sistem file.
• 2. File: Mendukung transfer file, penghematan loop file dan fungsi lain yang terkait dengan output log file.
• 3. Tetap disini ...

1.3 Star & Fork

Saya akan menyediakan lebih banyak plugin nanti. Kami juga sangat disambut untuk merancang dan mengembangkan plug-in dan fungsi yang lebih praktis untuk meningkatkan EasyLogger (GitHub | Oschina | Coding) . Jika Anda berpikir proyek open source ini hebat, Anda dapat mengklik Star di sudut kanan atas beranda proyek dan merekomendasikannya kepada lebih banyak teman yang membutuhkan.

2. Gunakan

2.1 Konfigurasi Parameter

EasyLogger memiliki properti seperti metode penyaringan, format output, dan sakelar output.

• Metode penyaringan mendukung penyaringan sesuai dengan label, level, dan kata kunci;
• Output log dapat dinyalakan/dimatikan secara dinamis;
• Tingkat output dinamis dan statis dapat diatur
  • Statis: sakelar tingkat pertama, ditentukan oleh makro, digunakan pada tahap kompilasi;
  • Dinamis: Sakelar sekunder digunakan selama tahap operasi melalui antarmuka API.

Catatan: Saat ini, metode konfigurasi parameter dan output adalah mode singleton, yaitu, hanya satu metode konfigurasi yang didukung secara global. Dalam mode ini, perangkat lunak akan lebih sederhana, tetapi tidak dapat mendukung metode output yang kompleks.

2.2 Level Output

Lihat Android Logcat, level tertinggi adalah 0 (menegaskan) dan level terendah adalah 5 (verbose).

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

2.2.1 output log warna -warni

Efek warna default log di setiap level adalah sebagai berikut. Pengguna juga dapat mengatur warna dan gaya log log di elog_cfg.h sesuai dengan preferensi mereka.

2.3 Penyaringan Output

Dukungan penyaringan berdasarkan level, label, dan kata kunci . Ketika ada banyak konten log, fungsi penyaringan dapat digunakan untuk menemukan log lebih cepat untuk memastikan keterbacaan log. Untuk lebih banyak pengaturan dan detail fungsi filter, silakan baca dokumen docszhapikernel.md

Catatan: Format RAW dan HEXDUMP Format Log tidak mendukung tag dan penyaringan kata kunci.

2.4 Format Output

Format output mendukung: level, waktu, label, informasi proses, informasi utas, jalur file, nomor baris, nama metode. Setiap level prioritas dapat mengatur format output secara independen.

2.5 Metode Output

Melalui porting pengguna, metode output apa pun dapat didukung. Namun, untuk fungsi baru yang dapat diperkenalkan dalam metode output tertentu, perlu diimplementasikan melalui plug-in, seperti transfer file, pengambilan log flash, dll. Lebih banyak plug-in akan menjadi open source nanti. Berikut ini adalah perbandingan singkat dari beberapa skenario penggunaan output:

• Terminal: nyaman bagi pengguna untuk melihat secara dinamis dan tidak memiliki fungsi penyimpanan;
• File dan Flash: Keduanya memiliki fungsi penyimpanan, dan pengguna dapat melihat log historis. Namun, metode file membutuhkan dukungan dari sistem file, dan metode flash lebih cocok untuk perangkat tertanam kecil tanpa sistem file.

2.6 demo

2.6.1 Fungsi Inti

Gambar berikut menunjukkan perintah input di terminal untuk mengontrol pengaturan output dan filter log, yang secara lebih intuitif menunjukkan fungsi inti EasyLogger.

• Jalur demo: demoosrt-threadstm32f10x
• Dokumentasi API: docszhapikernel.md
• Dokumentasi Migrasi: docszhportkernel.md

2.6.2 Flash Log (Simpan Log ke Flash)

Proses berikut adalah untuk mengeluarkan log melalui konsol dan menyimpan log output ke flash. Restart dan baca log yang disimpan terakhir, dan akhirnya hapus log flash.

• Jalur demo: demoosrt-threadstm32f10x
• Dokumentasi API: docszhapiflash.md
• Dokumentasi Migrasi: docszhportflash.md

2.6.2 Log File (Simpan log ke file)

Plug-in file memungkinkan Anda untuk secara otomatis menyimpan log ke file. Setiap file dapat diukur.

3. Dokumentasi

Untuk konten tertentu, lihat file di bawah docszh . Pastikan untuk menggunakannya setelah membaca dokumen .

4. Nanti

• Penyimpanan Flash: Tambahkan fungsi penyimpanan log dan membaca ke EasyFlash, memungkinkan EasyLogger terhubung dengan mulus. Membuat log lebih mudah disimpan dalam sistem non-file dan memiliki fungsi pengambilan log historis;
• File Konfigurasi: File Konfigurasi Di Bawah Sistem File;
• Transfer File: Transfer File didukung oleh kapasitas dan waktu dalam sistem file;
• Log Assistant: Kembangkan asisten log lintas-platform, kompatibel dengan sistem Linux, Windows, dan Mac. Front-end: html5 + bootstrap + angularjs + nw.js, back-end: karat + besi + karat-websocket + serial-rs;
• Output asinkron: Saat ini, output log dan kode pengguna disinkronkan. Namun, pada platform dengan kecepatan output rendah, kecepatan operasi perangkat lunak akan berkurang karena penambahan fungsi logging. Oleh karena itu, output asinkron akan ditambahkan nanti, dan penyaringan kata kunci juga dapat ditempatkan dalam output asinkron;
• Arduino: menambahkan Arduino Lib dan memberikan demo;

5. Izin

MIT Hak Cipta (C) [email protected]