EnLogger 是一个灵活的日志记录包,适用于 Flutter 应用程序,使开发者能够编写自定义日志消息,而无需局限于调试控制台或特定输出系统。它支持 Android、iOS、Web、macOS、Windows 和 Linux 多个平台,可无缝集成到任何项目中。凭借其可扩展的设计,EnLogger 允许用户定义自己的日志处理器和格式,非常适合用于调试、监控和分析。该包强调简单性和控制性,让开发者可以根据自身需求精确定制日志行为。
适合场景
调试应用程序流程
监控运行时行为
自定义日志输出路由
与外部分析工具集成
测试错误场景
在生产环境中的登录
主要特点
可扩展的日志处理系统
对多平台的支持
可配置的日志格式化
不依赖调试控制台
与现有代码的轻松集成
灵活的输出目标
适合对象
需要自定义日志记录的开发人员
构建跨平台应用的团队
需要结构化日志的项目
具有复杂调试需求的应用程序
面向生产环境的带有日志记录的应用程序
用户避免硬编码控制台输出
使用建议
需要手动设置日志处理器
无内置日志存储或持久化
可能需要额外的配置以应对高级用例
未针对高频日志记录进行优化
与完整的日志框架相比,开箱即用的功能有限
取决于用户定义的消息处理逻辑
原始 README
以下为关联源码仓库的 README 原文快照,最新内容请访问源码仓库。
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)
}