mirror of
https://github.com/Nanaloveyuki/BitLogger.git
synced 2026-05-30 15:42:25 +00:00
Nanaloveyuki
253 lines
10 KiB
Markdown
253 lines
10 KiB
Markdown
<html>
|
||
<div style="display: flex; justify-content: center; align-items: center; height: 15vh;">
|
||
<h3 title="https://moonbitlang.github.io/OSC2026/index.html#top">2026 MoonBit 国产基础软件生态开源大赛参赛作品</h3>
|
||
</div>
|
||
<div style="display: flex; justify-content: center; align-items: center; height: 8vh;">
|
||
<a href="https://mooncakes.io/docs/Nanaloveyuki/BitLogger" title="点击前往 Mooncake 页面"><b>Mooncake@Nanaloveyuki/BitLogger</b></a>
|
||
</div>
|
||
<div style="display: flex; justify-content: center; align-items: center; height: 2vh;">
|
||
<b>中文 | <a href="./docs/README-en.md">English</a></b>
|
||
</div>
|
||
</html>
|
||
|
||
## 📖 介绍
|
||
|
||
BitLogger 是一个基于 MoonBit 编写的结构化日志库。
|
||
|
||
## ❇️ 特点
|
||
|
||
- 🧩 核心能力清晰：先把 logging core 做稳，再继续扩展 rotation/async 等能力。
|
||
- 🏗️ 结构明确：按 `level / record / formatter / sinks / logger / global` 拆文件，便于继续维护。
|
||
- 🔌 可扩展：支持 `fanout_sink(...)` 和 `callback_sink(...)`，方便后续桥接文件、指标或外部系统。
|
||
- 🔀 可分流：支持 `split_sink(...)` / `split_by_level(...)`，可按谓词或 level 将日志路由到不同 sink。
|
||
- 🧱 可组合：支持 `buffered_sink(...)` 和 `filter_sink(...)`，可以在不引入复杂 runtime 的前提下组合输出策略。
|
||
- 🔎 可复用过滤：提供 `target_has_prefix(...)`、`message_contains(...)`、`level_at_least(...)`、`field_equals(...)` 等过滤辅助函数。
|
||
- 🩹 可变换 Record：支持 `with_patch(...)`、`patch_sink(...)` 与脱敏/补字段/message 变换 helper。
|
||
- 🧷 可绑定上下文：支持 `bind(...)` 与 `fields(...)`，更方便地封装复用字段上下文。
|
||
- 📮 显式队列：支持 `queued_sink(...)` / `with_queue(...)`、有界积压与溢出策略，作为后续 async sink 的 runtime-safe 基础。
|
||
- 🧾 可配置文本格式：支持 `text_formatter(...)`、`format_text(...)`、`text_console_sink(...)`、`formatted_callback_sink(...)` 与模板化 `template` 输出。
|
||
- 💾 Native 文件输出：支持 `file_sink(...)`、基础 size rotation / backup retention、显式 `reopen()` / `reopen_with_current_policy()` / `reopen_append()` / `reopen_truncate()` 与失败计数；当前仅保证 `native/llvm` backend 可用。
|
||
- 📦 面向 MoonBit：API 和工程结构围绕 MoonBit 的 package / visibility / toolchain 现实约束设计。
|
||
|
||
## 🚀 快速开始
|
||
|
||
```moonbit
|
||
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")])
|
||
```
|
||
|
||
<details><summary>层级 target 示例</summary>
|
||
|
||
```moonbit
|
||
let worker = Logger::new(console_sink(), target="app").child("worker")
|
||
worker.info("job ready")
|
||
```
|
||
</details>
|
||
|
||
<details><summary>自定义 callback sink 示例</summary>
|
||
|
||
```moonbit
|
||
let hook = Logger::new(
|
||
callback_sink(fn(rec) {
|
||
println("callback saw [\{rec.target}] \{rec.message}")
|
||
}),
|
||
target="hook",
|
||
)
|
||
|
||
hook.info("hello")
|
||
```
|
||
</details>
|
||
|
||
<details><summary>基础 buffered sink 示例</summary>
|
||
|
||
```moonbit
|
||
let sink = buffered_sink(console_sink(), flush_limit=2)
|
||
let logger = Logger::new(sink, target="buffered")
|
||
|
||
logger.info("one")
|
||
logger.info("two")
|
||
sink.flush()
|
||
```
|
||
</details>
|
||
|
||
<details><summary>基础 filter sink 示例</summary>
|
||
|
||
```moonbit
|
||
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")
|
||
```
|
||
</details>
|
||
|
||
<details><summary>Logger 链式 filter 示例</summary>
|
||
|
||
```moonbit
|
||
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")
|
||
```
|
||
</details>
|
||
|
||
<details><summary>Record patch 示例</summary>
|
||
|
||
```moonbit
|
||
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")])
|
||
```
|
||
</details>
|
||
|
||
<details><summary>bind 上下文示例</summary>
|
||
|
||
```moonbit
|
||
let logger = Logger::new(console_sink(), target="audit")
|
||
.bind(fields([("service", "bitlogger"), ("scope", "login")]))
|
||
|
||
logger.info("accepted", fields=[field("user", "alice")])
|
||
```
|
||
|
||
</details>
|
||
|
||
<details><summary>显式 queue sink 示例</summary>
|
||
|
||
```moonbit
|
||
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())
|
||
```
|
||
</details>
|
||
|
||
<details><summary>按 level 分流 sink 示例</summary>
|
||
|
||
```moonbit
|
||
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")
|
||
```
|
||
|
||
</details>
|
||
|
||
<details><summary>自定义文本 formatter 示例</summary>
|
||
|
||
```moonbit
|
||
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")])
|
||
```
|
||
|
||
</details>
|
||
|
||
<details><summary>JSON 配置加载示例</summary>
|
||
|
||
```moonbit
|
||
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())
|
||
```
|
||
|
||
</details>
|
||
|
||
<details><summary>native 文件 sink 示例</summary>
|
||
|
||
```moonbit
|
||
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())
|
||
}
|
||
```
|
||
</details>
|
||
|
||
## 📂 仓库结构
|
||
|
||
- `bitlogger/`：MoonBit 库 package，本体实现、测试与 Mooncake README
|
||
- `examples/basic/`：最小可运行示例
|
||
|
||
## 🔗 相关文档
|
||
|
||
- [Mooncake 文档页](https://mooncakes.io/docs/Nanaloveyuki/BitLogger)
|
||
- [English README](./docs/README-en.md)
|
||
|
||
## 📝 配置说明
|
||
|
||
- 当前提供 JSON 配置层：`parse_logger_config_text(...)`、`stringify_logger_config(...)`、`build_logger(...)`
|
||
- 已支持字段：`min_level`、`target`、`timestamp`、`sink.kind`、`sink.path`、`sink.append`、`sink.auto_flush`、`sink.rotation`、`sink.text_formatter`、`queue`
|
||
- `sink.rotation` 当前支持 `max_bytes` 与 `max_backups`，提供基础 size-based rotation 和 backup retention
|
||
- `file_sink(...)` 还提供 `reopen()`、`reopen_with_current_policy()`、`reopen_append()`、`reopen_truncate()`、`open_failures()`、`write_failures()`、`flush_failures()`、`rotation_failures()`，用于基础可观测性
|
||
- `file_sink(...)` 当前还提供 `append_mode()`；`reopen(append=...)` 在显式传值时会更新后续 reopen 使用的 append 策略，`reopen_with_current_policy()` 把“按当前保存策略重开”变成显式动作，而 `reopen_append()` / `reopen_truncate()` 则为常见 append 与 truncate 语义提供更直观入口
|
||
- `file_sink(...)` 也支持 `set_append_mode(...)`，用于显式修改后续 reopen 将使用的 append 策略
|
||
- `file_sink(...)` 也可直接读取 `path()` 与 `auto_flush_enabled()` 等基础 file 策略状态
|
||
- `file_sink(...)` 还提供 `rotation_enabled()` 与 `rotation_config()`，可直接查询当前 rotation 策略是否启用及其参数
|
||
- `file_sink(...)` 还提供 `state()`，可一次性读取 path、available、append、auto_flush、rotation 与各类 failure counter 快照
|
||
- `file_sink(...)` 也支持 `set_auto_flush(...)`、`set_rotation(...)`、`clear_rotation()`，可在运行期调整基础写出策略
|
||
- `build_logger(...)` 产出的 `ConfiguredLogger` 同样提供 `file_reopen()`、`file_reopen_with_current_policy()`、`file_reopen_append()`、`file_reopen_truncate()`、`file_flush()`、`file_close()`、`file_append_mode()`、`file_path()`、`file_auto_flush()`、`file_rotation_enabled()`、`file_rotation_config()`、`file_state()`，以及 `file_set_append_mode(...)`、`file_set_auto_flush(...)`、`file_set_rotation(...)`、`file_clear_rotation()` 与对应 file failure 计数访问器，便于配置式接入后继续运维控制
|
||
- `sink.text_formatter.template` 当前支持固定 token：`{timestamp}`、`{timestamp_ms}`、`{level}`、`{target}`、`{message}`、`{fields}`
|
||
- 当前可由配置直接组装的 sink 类型：`console`、`json_console`、`text_console`、`file`
|
||
- `queue` 会作为显式包装层附着在最终 sink 外侧；这仍然是同步 drain 模型，不是 async runtime
|
||
|
||
## 🧵 异步层
|
||
|
||
- 当前已新增独立 package：`bitlogger_async/`
|
||
- 异步层基于 `moonbitlang/async`，提供 `AsyncLogger`、`async_logger(...)`、后台 `run()` worker 与有界 async queue
|
||
- 当前 async API 已支持 `with_context_fields(...)`、`with_filter(...)`、`with_patch(...)`、`with_target(...)`、`child(...)`
|
||
- 当前建议用 `shutdown()` 收口 worker；它会在默认模式下先等待队列清空，再关闭 queue 并等待 worker 退出
|
||
- 当前已支持基础生命周期观测：`is_closed()`、`is_running()`、`has_failed()`、`last_error()`
|
||
- 当前 async worker 已支持 `max_batch` 批量消费，以及 `flush=Never|Batch|Shutdown` 的基础 flush 策略
|
||
- 推荐启动方式见 [examples/async_basic/main.mbt](/E:/repo/MooLiteyukiBot/examples/async_basic/main.mbt:1)
|
||
- 这层目前仅面向 `native/llvm` backend；它是独立 adapter，不会污染现有同步 core
|
||
|
||
### Async Config
|
||
|
||
- 当前已支持 `parse_async_logger_config_text(...)`、`stringify_async_logger_config(...)`、`parse_async_logger_build_config_text(...)` 与 `build_async_logger(...)`
|
||
- JSON 顶层结构分为两个字段：`logger` 与 `async_config`
|
||
- `logger` 完全复用同步 `LoggerConfig` 的 schema；`async_config` 当前支持 `max_pending`、`overflow`、`max_batch` 与 `flush`
|
||
- 当前推荐写法可直接参考 [examples/async_basic/main.mbt](/E:/repo/MooLiteyukiBot/examples/async_basic/main.mbt:1)
|