EnLogger ermöglicht es Ihnen, Logmeldungen nach Ihren Bedürfnissen zu schreiben, ohne Sie auf die Ausgabe in die Debug-Konsole oder andere Systeme zu beschränken.
Aus öffentlichen Paketdaten erstellte Orientierung.
EnLogger ist ein flexibles Logging-Paket für Flutter-Anwendungen, das Entwicklern ermöglicht, benutzerdefinierte Protokollmeldungen zu schreiben, ohne an die Debug-Konsole oder bestimmte Ausgabesysteme gebunden zu sein. Es unterstützt mehrere Plattformen wie Android, iOS, Web, macOS, Windows und Linux und bietet nahtlose Integration in jedes Projekt. Dank seines erweiterbaren Designs können Benutzer ihre eigenen Protokollhandler und Formate definieren, was es ideal für Debugging, Überwachung und Analyse macht. Das Paket betont Einfachheit und Kontrolle, sodass Entwickler das Protokollierungsverhalten genau nach ihren Bedürfnissen anpassen können.
Anwendungsfälle
Debuggen des Anwendungsflusses
Überwachung des Laufzeitverhaltens
Benutzerdefinierte Log-Ausgaberouting
Integration mit externer Analyse
Testen von Fehler-Szenarien
Anmeldung in Produktionsumgebungen
Hauptmerkmale
Erweiterbares Log-Handler-System
Unterstützung für mehrere Plattformen
Konfigurierbare Protokollformatierung
Keine Abhängigkeit vom Debug-Konsolen
Einfache Integration in bestehenden Code
Flexible Ausgabedestinationen
Geeignet für
Entwickler, die benutzerdefinierte Protokollierung benötigen
Teams, die plattformübergreifende Anwendungen erstellen
Projekte, die strukturierte Protokolle erfordern
Anwendungen mit komplexen Debugging-Anforderungen
Apps für die Produktion mit Protokollierung
Benutzer, die harte Konsolenausgaben vermeiden
Hinweise
Benötigt manuelle Einrichtung von Protokollhandlern
Keine integrierte Protokollspeicherung oder Persistenz
Kann zusätzliche Konfiguration für fortgeschrittene Anwendungsfälle erfordern
Nicht für hochfrequentes Protokollieren optimiert
Eingeschränkte Out-of-the-Box-Funktionen im Vergleich zu vollständigen Protokollierungsframeworks
Hängt von benutzerdefinierter Logik für die Nachrichtenverarbeitung ab
Original-README
Originaler README-Schnappschuss aus dem verknüpften Quell-Repository. Aktuelle Inhalte finden Sie im Repository.
En Logger
Welcome to EnLogger—a highly flexible and extensible logging system designed to adapt to your application's unique needs.
Instead of restricting you to the standard debug console, EnLogger acts as a central hub. It broadcasts your log messages to a customizable list of EnLoggerHandlers. You simply log your message once, and let your attached handlers decide where and how that data is processed.
Key Features:
Plug-and-Play Architecture:Log once, write anywhere. You can easily implement custom handlers based on your specific requirements:
Need local persistence? Implement a handler that writes logs to a local file.
Need remote crash reporting? Create a handler that pipes messages directly to Sentry, Crashlytics, or Datadog.
Lazy Evaluation: Boost your app's performance with "lazy" logging. Wrap expensive string interpolations or data serializations in closures; if the log level is disabled, the computation is completely skipped (see the Lazy messages section for details).
Zone: Automatically extract contextual data (tags) from Zone.current and attach them to every log event.
Caller info Indicates the exact location in your source code where the log was emitted
Syslog Standards: All log operations strictly adhere to the standard syslog severity levels (Emergency, Alert, Critical, Error, Warning, Notice, Info, Debug).
Ready-to-use Console Logger: Get started immediately with the included DevLogHandler, which outputs beautifully colored and formatted messages straight to your developer console.
To see these features in action, check out the example project.
Messages can include attachments such as serialized data, file contents, and more.
// error with data
logger.error(
"error",
data: [
EnLoggerData(
name: "response",
content: jsonEncode("BE data"),
description: "serialized BE response",
),
],
);
Instances
To avoid having to rewrite the prefix each time, you can create instances based on EnLogger. For instance, if you have a specific scope (like the API repository), you can instantiate a EnLogger with the prefix "API repository," and this prefix will be included in every log unless you explicitly override it.
final instLogger = logger.getConfiguredInstance(prefix: 'API Repository');
instLogger.debug('a debug message'); // [API Repository] a debug message
instLogger.error(
'error',
prefix: 'Custom prefix',
); // [Custom prefix] a debug message
Lazy messages
Lazy messages are not evaluated until at least one handler is going to write them.
Use them to avoid expensive computations when a log level is disabled (e.g. in production, where debug is often turned off).
The message closure is only called when at least one handler returns true from can(severity) for that log.
logger.lazyDebug(() => 'a lazy debug message');
// The closure is not run if debug is disabled (every handler's `can` returns `false`)
By default, can returns true for every handler, so all log levels are written unless you override it.
The message callbacks (e.g. the closure passed to lazyDebug) may be asynchronous. Handle exceptions inside the callback, otherwise they are ignored.
Tags & Zones
EnLogger can automatically extract contextual data (tags) from Dart's [Zone.current] and attach them to every log event.
By providing zoneContextKeys to the constructor, the logger will capture only the specified keys from the current execution zone.
Additionally, every logging method accepts its own tags parameter. The handlers will receive a single, merged, and sanitized map containing both the requested zone tags and the method-specific tags.
final logger = EnLogger(
zoneContextKeys: {#userId},
...
);
runZoned(
() {
// In addition to the method tags, the zoneContextKeys // values will be extracted from the zones
logger
.debug('a debug message',
prefix: 'API Repository',
tags: {'custom_key':'custom_value'},
);
},
zoneValues: {
#userId: 123,
#tenantId: 'abc'
},
);
Caller info
callerInfo captures the exact location in your source code where a log was emitted. It provides the function name, file path, and line number (e.g., AuthRepository.login (/lib/auth_repository.dart:142:5)).
While an error stackTrace shows you where an exception crashed, callerInfo pinpoints exactly where you wrote the log statement.
Because extracting stack traces is a CPU-intensive operation, this feature is disabled by default. You can explicitly enable it when initializing EnLogger:
final logger = EnLogger(includeCallerInfo: true);
Closing the logger
When you are done using an EnLogger instance, you should clean up its resources. EnLogger provides a graceful shutdown mechanism that safely stops accepting new logs and waits for any pending asynchronous writes or lazy evaluations to finish before clearing its handlers, ensuring no data is lost.
You can trigger this shutdown using two methods depending on your architectural needs:
close(): The preferred, asynchronous method. You can await it to guarantee all pending logs have been fully processed and written before proceeding.
dispose(): A synchronous wrapper around close(). It immediately marks the logger as closed and handles the graceful shutdown in the background (fire-and-forget).
Note: Both methods are safe to call multiple times (idempotent) and automatically cascade the shutdown to any child instances created via getConfiguredInstance().
Override can method to filter logs to complete skip the log evaluation.
@overrideboolcan({requiredSeverity severity, String? prefix}) {
if (isProduction) {
return severity.atLeastError; // only error and above are evaluated and written
}
returntrue; // every log is evaluated and written (default behavior)
}