mirror of
https://github.com/Nanaloveyuki/BitLogger.git
synced 2026-05-30 15:42:25 +00:00
845718224b771d6c2d4eac10ce5764660aa0fc8a
<html>
2026 MoonBit 国产基础软件生态开源大赛参赛作品
中文 | English
</html>
📖 介绍
BitLogger 是一个基于 MoonBit 编写的结构化日志库。
❇️ 特点
- 🧩 核心能力清晰:先把 logging core 做稳,再继续扩展 rotation/async 等能力。
- 🏗️ 结构明确:按
level / record / formatter / sinks / logger / global拆文件,便于继续维护。 - 🔌 可扩展:支持
fanout_sink(...)和callback_sink(...),方便后续桥接文件、指标或外部系统。 - 🧱 可组合:支持
buffered_sink(...)和filter_sink(...),可以在不引入复杂 runtime 的前提下组合输出策略。 - 🔎 可复用过滤:提供
target_has_prefix(...)、message_contains(...)、level_at_least(...)、field_equals(...)等过滤辅助函数。 - 🩹 可变换 Record:支持
with_patch(...)、patch_sink(...)与脱敏/补字段/message 变换 helper。 - 📮 显式队列:支持
queued_sink(...)/with_queue(...)、有界积压与溢出策略,作为后续 async sink 的 runtime-safe 基础。 - 🧾 可配置文本格式:支持
text_formatter(...)、format_text(...)、text_console_sink(...)和formatted_callback_sink(...)。 - 💾 Native 文件输出:支持
file_sink(...),但当前仅保证native/llvmbackend 可用。 - 📦 面向 MoonBit:API 和工程结构围绕 MoonBit 的 package / visibility / toolchain 现实约束设计。
🚀 快速开始
let logger = Logger::new(console_sink(), min_level=Level::Info, target="demo")
.with_timestamp()
.with_context_fields([field("service", "bitlogger")])
logger.info("starting", fields=[field("port", "8080")])
层级 target 示例
let worker = Logger::new(console_sink(), target="app").child("worker")
worker.info("job ready")
自定义 callback sink 示例
let hook = Logger::new(
callback_sink(fn(rec) {
println("callback saw [\{rec.target}] \{rec.message}")
}),
target="hook",
)
hook.info("hello")
基础 buffered sink 示例
let sink = buffered_sink(console_sink(), flush_limit=2)
let logger = Logger::new(sink, target="buffered")
logger.info("one")
logger.info("two")
sink.flush()
基础 filter sink 示例
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")
Logger 链式 filter 示例
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")
Record patch 示例
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")])
显式 queue sink 示例
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())
自定义文本 formatter 示例
let formatter = text_formatter(show_timestamp=false, separator=" | ")
let logger = Logger::new(text_console_sink(formatter), target="pretty")
logger.info("hello", fields=[field("mode", "pretty")])
native 文件 sink 示例
if native_files_supported() {
let logger = Logger::new(file_sink("bitlogger.log"), target="file")
logger.info("hello", fields=[field("kind", "file")])
ignore(logger.sink.flush())
ignore(logger.sink.close())
}
📂 仓库结构
bitlogger/:MoonBit 库 package,本体实现、测试与 Mooncake READMEexamples/basic/:最小可运行示例
🔗 相关文档
Languages
MoonBit
100%