EasyLogger

EasyLogger

---

1. مقدمة

EasyLogger عبارة عن وزن خفيف للغاية (ROM <1.6K ، RAM <0.3K) ، مكتبة سجل C/C ++ عالية الأداء ، وهي مثالية لمشاريع البرمجيات الحساسة للموارد ، مثل: منتجات إنترنت الأشياء ، والأجهزة القابلة للارتداء ، والمنازل الذكية ، والمزيد. مقارنةً بمكتبات سجل C/C ++ المعروفة مثل Log4C و Zlog ، فإن EasyLogger لديه وظائف أبسط ويوفر واجهات أقل للمستخدمين ، ولكنها ستكون سريعة البدء.

1.1 الميزات الرئيسية

• يدعم طرق الإخراج المعرفة من قبل المستخدم (على سبيل المثال: المحطة ، الملف ، قاعدة البيانات ، المنفذ التسلسلي ، 485 ، فلاش ...) ؛
• يمكن أن يشتمل محتوى السجل على المستويات ، الطوابع الزمنية ، معلومات مؤشر الترابط ، معلومات العملية ، إلخ ؛
• تم تصميم إخراج السجل كطريقة آمنة مؤشرات ترابط ويدعم الإخراج غير المتزامن وأنماط الإخراج المخزنة ؛
• يدعم أنظمة التشغيل المتعددة (RT-Trhread ، UCOs ، Linux ، Windows ، Nuttx ...) ، ويدعم أيضًا منصات المعادن العارية ؛
• سجلات تدعم التنسيق الخام ودعم hexdump ؛
• دعم التصفية الديناميكية حسب العلامات والمستويات والكلمات الرئيسية ؛
• سجلات على جميع المستويات تدعم ألوان مختلفة لعرضها ؛
• يمكن توسيعه بقوة ، يدعم توسيع وظائف جديدة في شكل المكونات الإضافية.

شرح الأسماء:

• 1. تنسيق الخام: سجل أصلي غير مهتم.
• 2. العلامات: في البرنامج ، يمكنك تعيين علامات للسجلات التي تحتاج إلى طباعتها وفقًا للملفات والوحدات النمطية والوظائف وما إلى ذلك لتحقيق تصنيف السجل.

1.2 المكون الإضافي

• 1. فلاش: استخدم واجهة تشغيل الفلاش التي توفرها مكتبة Easyflash ، وقم بتخزين السجلات مباشرة في الفلاش دون الحاجة إلى نظام ملفات.
• 2. الملف: يدعم نقل الملفات وحفظ حلقة الملفات والوظائف الأخرى المتعلقة بإخراج سجل الملف.
• 3. ترقبوا ...

1.3 نجمة وشوكة

سأقدم المزيد من الإضافات لاحقًا. نحن أيضًا مرحبًا بكم في تصميم وتطوير المزيد من المكونات والوظائف العملية لتحسين EasyLogger (Github | Oschina | الترميز) . إذا كنت تعتقد أن هذا المشروع المفتوح المصدر رائع ، فيمكنك النقر فوق Star في الزاوية اليمنى العليا من الصفحة الرئيسية للمشروع والتوصية به لمزيد من الأصدقاء المحتاجين.

2. الاستخدام

2.1 تكوين المعلمة

يحتوي EasyLogger على خصائص مثل طريقة التصفية وتنسيق الإخراج ومفتاح الإخراج.

• تدعم طريقة التصفية التصفية وفقًا للعلامات والمستويات والكلمات الرئيسية ؛
• يمكن تشغيل إخراج السجل/إيقاف تشغيله ديناميكيًا ؛
• يمكن تعيين مستويات الإخراج الديناميكية والستاتيك
  • ثابت: مفتاح المستوى الأول ، المحدد بواسطة وحدات الماكرو ، المستخدمة في مرحلة التجميع ؛
  • ديناميكي: يتم استخدام المفتاح الثانوي خلال مرحلة التشغيل من خلال واجهة API.

ملاحظة: حاليًا ، فإن تكوين المعلمة وطرق الإخراج هي وضع Singleton ، أي أن طريقة تكوين واحدة فقط مدعومة عالميًا. في هذا الوضع ، سيكون البرنامج أكثر بساطة ، لكنه لا يمكنه دعم طرق الإخراج المعقدة.

2.2 مستوى الإخراج

ارجع إلى Android Logcat ، أعلى مستوى هو 0 (تأكيد) وأدنى مستوى هو 5 (مطول).

 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. الواجهة الأمامية: html5 + bootstrap + AngularJS + nw.js ، خلفية: Rust + Iron + Rust-Websocket + Serial-Rs ؛
• الإخراج غير المتزامن: حاليًا ، تتم مزامنة إخراج السجل ورمز المستخدم. ومع ذلك ، على المنصات ذات سرعات الإخراج المنخفضة ، سيتم تقليل سرعة تشغيل البرنامج بسبب إضافة وظائف التسجيل. لذلك ، سيتم إضافة الإخراج غير المتزامن لاحقًا ، ويمكن أيضًا وضع تصفية الكلمات الرئيسية في الإخراج غير المتزامن ؛
• Arduino: أضيف Arduino Lib وقدم العرض التوضيحي ؛

5. تصريح

MIT حقوق الطبع والنشر (C) [email protected]