mirror of
https://github.com/Nanaloveyuki/BitLogger.git
synced 2026-05-30 15:42:25 +00:00
BitLogger
BitLogger is a minimal structured logger for MoonBit.
BitLogger 是一个基于 MoonBit 的结构化日志库。
Features / 特性
- log levels:
Trace,Debug,Info,Warn,Error - 日志级别:
Trace、Debug、Info、Warn、Error - structured key-value fields
- 结构化字段:
field("key", "value") - sink abstraction
- sink 抽象与组合边界
- default global console logger
- 默认全局 logger 辅助函数
- context fields via
with_context_fields(...) - 通过
with_context_fields(...)添加上下文字段 - child target composition via
child(...) - 通过
child(...)组合层级 target - optional timestamps via
with_timestamp() - 通过
with_timestamp()启用时间戳 - JSON console output via
json_console_sink() json_console_sink()提供 JSON 控制台输出- sink composition via
fanout_sink(...) fanout_sink(...)支持多 sink 组合- sink routing via
split_sink(...)andsplit_by_level(...) split_sink(...)、split_by_level(...)支持按谓词或 level 将日志路由到不同 sink- custom callback sink via
callback_sink(...) callback_sink(...)支持自定义外部集成- buffered sink via
buffered_sink(...) buffered_sink(...)支持内存缓冲与 flush- filter sink via
filter_sink(...) filter_sink(...)支持按Record条件筛选输出- reusable filter helpers such as
target_has_prefix(...),message_contains(...), andfield_equals(...) - 提供
target_has_prefix(...)、message_contains(...)、field_equals(...)等可复用过滤辅助函数 - record patching via
with_patch(...)andpatch_sink(...) - 支持
with_patch(...)、patch_sink(...)以及常见 record patch helper - context binding via
bind(...)andfields(...) - 支持
bind(...)、fields(...),更顺手地封装上下文字段 - explicit queued delivery via
queued_sink(...)andwith_queue(...) - 支持
queued_sink(...)、with_queue(...)、有界积压与溢出策略 - configurable text formatting via
text_formatter(...),format_text(...),text_console_sink(...), and template-driventemplateoutput - 支持
text_formatter(...)、format_text(...)、text_console_sink(...)以及模板化template文本输出 - JSON config parsing via
parse_logger_config_text(...)andstringify_logger_config(...) - 支持
parse_logger_config_text(...)、stringify_logger_config(...)进行最小 JSON 配置读写 - config-driven logger assembly via
build_logger(...) - 支持
build_logger(...)将配置组装为可直接使用的 logger - native-only file output via
file_sink(...), with basic size rotation, backup retention, explicitreopen()/reopen_with_current_policy()/reopen_append()/reopen_truncate(), and failure counters - 支持
file_sink(...)、基础 size rotation / backup retention、显式reopen()/reopen_with_current_policy()/reopen_append()/reopen_truncate()与失败计数,但当前仅保证native/llvmbackend 可用
Example / 示例
test {
let logger = Logger::new(console_sink(), min_level=Level::Debug, target="demo")
.with_timestamp()
logger.info("starting", fields=[field("port", "8080")])
}
test {
let logger = Logger::new(console_sink(), target="app").child("worker")
logger.info("ready")
}
test {
let logger = Logger::new(
fanout_sink(console_sink(), json_console_sink()),
min_level=Level::Info,
target="demo",
)
logger.info("ready", fields=[field("mode", "fanout")])
}
test {
let logger = Logger::new(
callback_sink(fn(rec) {
println("callback saw [\{rec.target}] \{rec.message}")
}),
target="hook",
)
logger.info("hello")
}
test {
let sink = buffered_sink(console_sink(), flush_limit=2)
let logger = Logger::new(sink, target="buffered")
logger.info("one")
logger.info("two")
sink.flush()
}
test {
let sink = filter_sink(console_sink(), fn(rec) {
rec.target == "kept"
})
let kept = Logger::new(sink, target="kept")
let dropped = Logger::new(sink, target="dropped")
kept.info("visible")
dropped.info("hidden")
}
test {
let logger = Logger::new(console_sink(), target="service")
.with_filter(all_of([
target_has_prefix("service"),
message_contains("visible"),
]))
logger.info("hidden")
logger.child("api").info("visible")
}
test {
let logger = Logger::new(console_sink(), target="auth")
.with_patch(compose_patches([
prefix_message("[safe] "),
redact_fields(["token"]),
append_fields([field("service", "bitlogger")]),
]))
logger.info("login", fields=[field("user", "alice"), field("token", "secret")])
}
test {
let logger = Logger::new(console_sink(), target="audit")
.bind(fields([("service", "bitlogger"), ("scope", "login")]))
logger.info("accepted", fields=[field("user", "alice")])
}
test {
let logger = Logger::new(console_sink(), target="queue")
.with_queue(max_pending=2, overflow=QueueOverflowPolicy::DropOldest)
logger.info("one")
logger.info("two")
logger.info("three")
ignore(logger.sink.flush())
}
test {
let logger = Logger::new(
split_by_level(
callback_sink(fn(rec) {
println("high priority: \{rec.level.label()} \{rec.message}")
}),
console_sink(),
min_level=Level::Warn,
),
min_level=Level::Trace,
target="split",
)
logger.info("normal output")
logger.warn("warning output")
}
test {
let formatter = text_formatter(
show_timestamp=false,
field_separator=",",
template="[{level}] {target} {message} :: {fields}",
)
let logger = Logger::new(text_console_sink(formatter), target="pretty")
logger.info("hello", fields=[field("mode", "pretty")])
}
test {
let config = parse_logger_config_text(
"{\"min_level\":\"debug\",\"target\":\"config.demo\",\"timestamp\":true,\"sink\":{\"kind\":\"text_console\",\"text_formatter\":{\"show_timestamp\":false,\"field_separator\":\",\",\"template\":\"[{level}] {target} {message} :: {fields}\"}},\"queue\":{\"max_pending\":2,\"overflow\":\"DropOldest\"}}",
)
let logger = build_logger(config)
logger.info("configured from json")
ignore(logger.flush())
}
Formatter Template / 模板格式
- supported tokens / 支持的 token:
{timestamp},{timestamp_ms},{level},{target},{message},{fields} - disabled or missing parts render as empty text / 被关闭或缺失的部分会渲染为空字符串
templateis intentionally a simple token replacement layer, not a full DSL /template当前刻意保持为轻量 token 替换层,而不是完整 DSL
test {
if native_files_supported() {
let logger = Logger::new(
file_sink("bitlogger.log", rotation=Some(file_rotation(128, max_backups=2))),
target="file",
)
logger.info("hello", fields=[field("kind", "file")])
ignore(logger.sink.flush())
ignore(logger.sink.close())
}
}
test {
let logger = build_logger(
LoggerConfig::new(
sink=SinkConfig::new(kind=SinkKind::File, path="bitlogger-runtime.log"),
queue=Some(QueueConfig::new(16)),
),
)
logger.info("queued hello")
match logger.file_runtime_state() {
Some(snapshot) => println(stringify_runtime_file_state(snapshot, pretty=true))
None => ()
}
}
File Rotation / 文件轮转
- basic rotation is size-based / 当前基础轮转为按文件大小触发
file_rotation(max_bytes, max_backups=...)controls threshold and retained backups /file_rotation(max_bytes, max_backups=...)控制触发阈值和保留备份数- JSON config uses
sink.rotation.max_bytesandsink.rotation.max_backups/ JSON 配置使用sink.rotation.max_bytes与sink.rotation.max_backups FileSink::reopen()can explicitly reopen the current file handle,FileSink::reopen_with_current_policy()makes the stored-policy reopen path explicit, andFileSink::reopen_append()/FileSink::reopen_truncate()cover the two common reopen modes directly /FileSink::reopen()可显式重开当前文件句柄,FileSink::reopen_with_current_policy()把“按当前保存策略重开”变成显式动作,FileSink::reopen_append()/FileSink::reopen_truncate()则直接覆盖常见 append 与 truncate 模式append_mode()exposes the current append policy, andreopen(append=...)updates that policy for later reopen calls /append_mode()可读取当前 append 策略,reopen(append=...)会更新后续 reopen 复用的 append 策略set_append_mode(...)updates the stored append policy without forcing an immediate reopen /set_append_mode(...)可直接更新保存的 append 策略,但不会强制立即 reopenpath()andauto_flush_enabled()expose core file sink policy state /path()与auto_flush_enabled()可读取 file sink 的基础策略状态rotation_enabled()androtation_config()expose whether rotation is active and which settings are currently applied /rotation_enabled()与rotation_config()可读取 rotation 是否启用及当前配置参数state()exposes a single file-sink snapshot including path, availability, append policy, auto-flush, rotation config, and failure counters /state()可一次性读取包含 path、availability、append、auto-flush、rotation 配置与失败计数的 file sink 快照policy()anddefault_policy()expose the current runtime policy and the sink's original defaults separately /policy()与default_policy()可分别读取当前运行期策略与 sink 初始默认策略set_policy(...)applies append, auto-flush, and rotation as a bundled runtime update /set_policy(...)可将 append、auto-flush、rotation 作为一组运行期策略一次性写回reset_failure_counters()clears the open/write/flush/rotation counters after diagnostics or recovery /reset_failure_counters()可在排障或恢复后清空 open/write/flush/rotation 失败计数reset_policy()restores append, auto-flush, and rotation back to the sink's original defaults /reset_policy()可将 append、auto-flush、rotation 恢复到 sink 初始默认策略file_sink_state_to_json(...)/stringify_file_sink_state(...)andruntime_file_state_to_json(...)/stringify_runtime_file_state(...)export snapshots as JSON /file_sink_state_to_json(...)/stringify_file_sink_state(...)与runtime_file_state_to_json(...)/stringify_runtime_file_state(...)可将快照直接导出为 JSONset_auto_flush(...),set_rotation(...), andclear_rotation()allow runtime tuning of core file sink policies /set_auto_flush(...)、set_rotation(...)、clear_rotation()可在运行期调整 file sink 的基础策略open_failures()、write_failures()、flush_failures()、rotation_failures()expose basic sink health counters /open_failures()、write_failures()、flush_failures()、rotation_failures()可用于观察基础 sink 健康状态ConfiguredLoggeralso forwards file reopen, flush, close, append-mode, path, auto-flush, rotation-config, state snapshot, append setter, policy setter, and failure-counter helpers for config-built file sinks /ConfiguredLogger也会为配置生成的 file sink 转发 reopen、flush、close、append-mode、path、auto-flush、rotation 配置、state 快照、append setter、策略 setter 与失败计数访问器ConfiguredLogger::file_runtime_state()also reports whether a file sink is queue-wrapped and exposes the outer queue pending/drop counters together with the inner file snapshot /ConfiguredLogger::file_runtime_state()还可报告 file sink 是否被 queue 包装,并将外层 queue 的 pending/drop 计数与内层 file 快照一起返回ConfiguredLogger::file_policy()andConfiguredLogger::file_default_policy()also expose current runtime policy and initial config policy separately /ConfiguredLogger::file_policy()与ConfiguredLogger::file_default_policy()也可分别读取当前运行期策略与初始配置策略ConfiguredLogger::file_set_policy()also applies a bundled runtime file policy through the config-built control surface /ConfiguredLogger::file_set_policy()也可通过配置式控制面一次性写回 bundled file 策略ConfiguredLogger::file_reset_failure_counters()also clears file failure counters through the config-built control surface /ConfiguredLogger::file_reset_failure_counters()也可通过配置式控制面清空 file 失败计数ConfiguredLogger::file_reset_policy()also restores runtime file policy back to the initial config values /ConfiguredLogger::file_reset_policy()也可将运行期 file 策略恢复到初始配置值- current scope is observability-first, not a full self-healing sink runtime / 当前定位仍以可观测性优先,不是完整自愈型 sink runtime