EasyLogger

EasyLogger

---

1. Einführung

EasyLogger ist ein Ultra-Lightweight (ROM <1,6K, RAM <0,3K), Hochleistungs-C/C ++-Protokollbibliothek, das ideal für ressourcen-sensitive Softwareprojekte ist, wie z. B. IoT-Produkte, tragbare Geräte, Smart Homes und mehr. Im Vergleich zu bekannten C/C ++-Protokollbibliotheken wie Log4c und Zlog verfügt EasyLogger einfachere Funktionen und bietet weniger Schnittstellen für Benutzer, wird jedoch schnell einsetzt.

1.1 Hauptmerkmale

• Unterstützt benutzerdefinierte Ausgabemethoden (z. B. Terminal, Datei, Datenbank, serieller Port, 485, Flash ...);
• Der Protokollinhalt kann Ebenen, Zeitstempel, Threadinformationen, Prozessinformationen usw. Enthalten;
• Die Protokollausgabe ist als thread-sicherer Methode ausgelegt und unterstützt asynchrone Ausgangs- und gepufferte Ausgangsmodi.
• Unterstützt mehrere Betriebssysteme (RT-Thread, UCOS, Linux, Windows, Nuttx ...) und unterstützt auch Bare-Metal-Plattformen.
• Protokolle unterstützen das RAW -Format und unterstützen Hexdump ;
• Unterstützung der dynamischen Filterung durch Tags , Ebenen und Schlüsselwörter ;
• Protokolle auf allen Ebenen unterstützen verschiedene Farben, um angezeigt zu werden.
• Stark erweiterbar, unterstützt die Erweiterung neuer Funktionen in Form von Plug-Ins.

Erläuterung von Substantiven:

• 1. RAW -Format: Unformatiertes Originalprotokoll.
• 2. Tags: In der Software können Sie Tags für Protokolle festlegen, die nach Dateien, Modulen, Funktionen usw. gedruckt werden müssen, um die Protokollklassifizierung zu realisieren.

1.2 Plug-In

• 1. Flash: Verwenden Sie die von der EasyFlash -Bibliothek bereitgestellte Flash -Operation -Schnittstelle und speichern Sie die Protokolle direkt in Flash, ohne dass ein Dateisystem erforderlich ist.
• 2. Datei: Unterstützt die Dateiübertragung, das Speichern von Dateischleifen und andere Funktionen, die sich auf die Dateiprotokollausgabe beziehen.
• 3. Bleib dran ...

1,3 Sterne & Gabel

Ich werde später mehr Plugins bereitstellen. Wir sind auch sehr willkommen, um mehr praktische Plug-Ins und Funktionen zu entwerfen und zu entwickeln, um EasyLogger zu verbessern (Github | Oschina | Codierung) . Wenn Sie der Meinung sind, dass dieses Open -Source -Projekt großartig ist, können Sie in der oberen rechten Ecke der Projekt -Homepage auf Stern klicken und es mehr Freunden in Not empfehlen.

2. Verwendung

2.1 Parameterkonfiguration

EasyLogger verfügt über Eigenschaften wie Filtermethoden, Ausgangsformat und Ausgangsschalter.

• Die Filtermethode unterstützt die Filterung gemäß Bezeichnungen, Ebenen und Schlüsselwörtern.
• Die Protokollausgabe kann dynamisch ein-/ausgeschaltet werden.
• Dynamische und statische Ausgangsebenen können eingestellt werden
  • Statisch: Schalter der ersten Stufe, definiert durch Makros, verwendet in der Kompilierungsphase;
  • Dynamik: Der Sekundärschalter wird während der Betriebsstufe über die API -Schnittstelle verwendet.

HINWEIS: Derzeit sind Parameterkonfigurations- und Ausgabemethoden der Singleton -Modus, dh nur eine Konfigurationsmethode wird global unterstützt. In diesem Modus ist die Software einfacher, kann jedoch keine komplexen Ausgangsmethoden unterstützen.

2.2 Ausgangspegel

Siehe Android -Logcat, die höchste Ebene beträgt 0 (assert) und die niedrigste Ebene beträgt 5 (ausführlich).

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

2.2.1 Ausgabe farbenfrohe Protokolle

Der Standardfarbeneffekt von Protokollen auf jeder Ebene ist wie folgt. Benutzer können auch die Farben und Schriftarten von Protokollen bei elog_cfg.h gemäß ihren Vorlieben festlegen.

2.3 Ausgangsfilterung

Support Filtering nach Level, Etikett und Keyword . Wenn es viele Protokollinhalte gibt, kann die Filterfunktion verwendet werden, um das Protokoll schneller zu finden, um die Lesbarkeit des Protokolls sicherzustellen. Weitere Einstellungen und Details für Filterfunktionen finden Sie unter docszhapikernel.md -Dokument

Hinweis: RAW -Format- und Hexdump -Formatprotokolle unterstützen keine Tags und Keyword -Filterung.

2.4 Ausgangsformat

Das Ausgabeformat unterstützt: Stufe, Zeit, Beschriftung, Prozessinformationen, Threadinformationen, Dateipfad, Zeilennummer, Methodenname. Jede Prioritätsstufe kann das Ausgangsformat unabhängig festlegen.

2.5 Ausgangsmethode

Durch die Benutzerportierung kann jede Ausgabemethode unterstützt werden. Für neue Funktionen, die in einer bestimmten Ausgabemethode eingeführt werden können, muss sie jedoch durch Plug-Ins wie Dateiübertragung, Abrufen von Flash-Protokollen usw. implementiert werden. Weitere Plug-Ins werden später Open Source sein. Das Folgende ist ein kurzer Vergleich einiger der Ausgangsnutzungsszenarien:

• Terminal: Bequem für Benutzer, dynamisch zu sehen und keine Speicherfunktionen zu haben.
• Dateien und Flash: Beide haben Speicherfunktionen und Benutzer können historische Protokolle anzeigen. Die Dateimethode erfordert jedoch die Unterstützung des Dateisystems, und die Flash -Methode eignet sich besser für kleine eingebettete Geräte ohne Dateisysteme.

2.6 Demo

2.6.1 Kernfunktionen

Die folgende Abbildung zeigt die Eingangsbefehle in der Klemme, um die Einstellungen für die Protokoll- und Filtereinstellungen zu steuern, die die Kernfunktionen von EasyLogger intuitiver demonstrieren.

• Demo-Pfad: demoosrt-threadstm32f10x
• API -Dokumentation: docszhapikernel.md
• Migrationsdokumentation: docszhportkernel.md

2.6.2 Flash -Protokoll (Speichern Sie das Protokoll auf Flash)

Der folgende Vorgang besteht darin, Protokolle über die Konsole auszugeben und die Ausgabeprotokolle in Flash zu speichern. Starten Sie das letzte gespeicherte Protokoll neu und löschen Sie das Flash -Protokoll schließlich.

• Demo-Pfad: demoosrt-threadstm32f10x
• API -Dokumentation: docszhapiflash.md
• Migrationsdokumentation: docszhportflash.md

2.6.2 Dateiprotokoll (Speichern Sie das Protokoll in einer Datei)

Mit dem Datei-Plug-In können Sie Protokolle automatisch in Dateien speichern. Jede Datei kann nach dem Überschreiten der angegebenen Größe eine neue Datei automatisch erstellt werden, um das Protokoll zu speichern.

3. Dokumentation

Für bestimmte Inhalte finden Sie in der Datei unter docszh . Verwenden Sie es unbedingt, nachdem Sie das Dokument gelesen haben .

4. Später

• Flash -Speicher: Fügen Sie den Protokollspeicher- und Lesefunktionen in EasyFlash hinzu, sodass EasyLogger nahtlos eine Verbindung damit verbindet. Die Protokolle leichter in nicht-file Systemen zu speichern und haben die Funktion des historischen Protokollabrufs.
• Konfigurationsdatei: Konfigurationsdatei unter dem Dateisystem;
• Dateiübertragung: Die Dateiübertragung wird durch Kapazität und Zeit im Dateisystem unterstützt.
• Protokollassistent: Entwickeln Sie einen plattformübergreifenden Protokollassistenten, der mit Linux-, Windows- und Mac-Systemen kompatibel ist. Front-End: HTML5 + Bootstrap + AngularJS + NW.JS, Back-End: Rost + Eisen + Rost-Websocket + Serial-Rs;
• Asynchrone Ausgabe: Derzeit werden die Protokollausgabe und der Benutzercode synchronisiert. Auf Plattformen mit geringer Ausgangsgeschwindigkeit wird die Software -Betriebsgeschwindigkeit aufgrund der Hinzufügung von Protokollierungsfunktionen jedoch reduziert. Daher wird später eine asynchrone Ausgabe hinzugefügt, und die Keyword -Filterung kann auch in der asynchronen Ausgabe platziert werden.
• Arduino: Arduino Lib fügte hinzu und stellte seine Demo zur Verfügung;

5. Erlaubnis

MIT Copyright (c) [email protected]