diff --git a/README.md b/README.md index 126cc79..cdfebae 100644 --- a/README.md +++ b/README.md @@ -222,7 +222,7 @@ if native_files_supported() { - 已支持字段:`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()`、`open_failures()`、`write_failures()`、`flush_failures()`、`rotation_failures()`,用于基础可观测性 -- `build_logger(...)` 产出的 `ConfiguredLogger` 同样提供 `file_reopen()` 与对应 file failure 计数访问器,便于配置式接入后继续运维控制 +- `build_logger(...)` 产出的 `ConfiguredLogger` 同样提供 `file_reopen()`、`file_flush()`、`file_close()` 与对应 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 diff --git a/bitlogger/BitLogger_test.mbt b/bitlogger/BitLogger_test.mbt index c3a078d..33c293a 100644 --- a/bitlogger/BitLogger_test.mbt +++ b/bitlogger/BitLogger_test.mbt @@ -231,3 +231,43 @@ test "configured logger can reopen built file sink" { inspect(logger.file_open_failures(), content="2") } } + +test "configured logger exposes file flush and close helpers" { + let logger = build_logger( + LoggerConfig::new( + sink=SinkConfig::new(kind=SinkKind::File, path="config-control.log"), + ), + ) + if logger.file_available() { + logger.info("before flush") + inspect(logger.file_flush(), content="true") + inspect(logger.file_close(), content="true") + inspect(logger.file_available(), content="false") + inspect(logger.file_flush(), content="false") + } else { + inspect(logger.file_flush(), content="false") + inspect(logger.file_close(), content="false") + } +} + +test "configured queued file logger flushes queue through file helper" { + let logger = build_logger( + LoggerConfig::new( + sink=SinkConfig::new(kind=SinkKind::File, path="config-queued-file.log"), + queue=Some(QueueConfig::new(4, overflow=QueueOverflowPolicy::DropNewest)), + ), + ) + logger.info("one") + logger.info("two") + if logger.file_available() { + inspect(logger.pending_count(), content="2") + inspect(logger.file_flush(), content="true") + inspect(logger.pending_count(), content="0") + inspect(logger.file_close(), content="true") + } else { + inspect(logger.pending_count(), content="2") + inspect(logger.file_flush(), content="false") + inspect(logger.pending_count(), content="0") + inspect(logger.file_close(), content="false") + } +} diff --git a/bitlogger/README.mbt.md b/bitlogger/README.mbt.md index e04998c..74b9c47 100644 --- a/bitlogger/README.mbt.md +++ b/bitlogger/README.mbt.md @@ -222,5 +222,5 @@ test { - JSON config uses `sink.rotation.max_bytes` and `sink.rotation.max_backups` / JSON 配置使用 `sink.rotation.max_bytes` 与 `sink.rotation.max_backups` - `FileSink::reopen()` can explicitly reopen the current file handle / `FileSink::reopen()` 可显式重开当前文件句柄 - `open_failures()`、`write_failures()`、`flush_failures()`、`rotation_failures()` expose basic sink health counters / `open_failures()`、`write_failures()`、`flush_failures()`、`rotation_failures()` 可用于观察基础 sink 健康状态 -- `ConfiguredLogger` also forwards file reopen and failure-counter helpers for config-built file sinks / `ConfiguredLogger` 也会为配置生成的 file sink 转发 reopen 与失败计数访问器 +- `ConfiguredLogger` also forwards file reopen, flush, close, and failure-counter helpers for config-built file sinks / `ConfiguredLogger` 也会为配置生成的 file sink 转发 reopen、flush、close 与失败计数访问器 - current scope is observability-first, not a full self-healing sink runtime / 当前定位仍以可观测性优先,不是完整自愈型 sink runtime diff --git a/bitlogger/config.mbt b/bitlogger/config.mbt index fba92f9..30ae032 100644 --- a/bitlogger/config.mbt +++ b/bitlogger/config.mbt @@ -231,6 +231,28 @@ pub fn RuntimeSink::file_reopen(self : RuntimeSink, append~ : Bool? = None) -> B } } +pub fn RuntimeSink::file_flush(self : RuntimeSink) -> Bool { + match self { + File(sink) => sink.flush() + QueuedFile(sink) => { + ignore(sink.flush()) + sink.sink.flush() + } + _ => false + } +} + +pub fn RuntimeSink::file_close(self : RuntimeSink) -> Bool { + match self { + File(sink) => sink.close() + QueuedFile(sink) => { + ignore(sink.flush()) + sink.sink.close() + } + _ => false + } +} + pub fn RuntimeSink::file_open_failures(self : RuntimeSink) -> Int { match self { File(sink) => sink.open_failures() @@ -293,6 +315,14 @@ pub fn ConfiguredLogger::file_reopen(self : ConfiguredLogger, append~ : Bool? = self.sink.file_reopen(append=append) } +pub fn ConfiguredLogger::file_flush(self : ConfiguredLogger) -> Bool { + self.sink.file_flush() +} + +pub fn ConfiguredLogger::file_close(self : ConfiguredLogger) -> Bool { + self.sink.file_close() +} + pub fn ConfiguredLogger::file_open_failures(self : ConfiguredLogger) -> Int { self.sink.file_open_failures() } diff --git a/docs/README-en.md b/docs/README-en.md index 4671c8d..6c566c1 100644 --- a/docs/README-en.md +++ b/docs/README-en.md @@ -207,7 +207,7 @@ if native_files_supported() { - Supported keys include `min_level`, `target`, `timestamp`, `sink.kind`, `sink.path`, `sink.append`, `sink.auto_flush`, `sink.rotation`, `sink.text_formatter`, and `queue`. - `sink.rotation` currently supports `max_bytes` and `max_backups` for basic size-based rotation and backup retention. - `file_sink(...)` also exposes `reopen()`, `open_failures()`, `write_failures()`, `flush_failures()`, and `rotation_failures()` for basic observability. -- `ConfiguredLogger` built through `build_logger(...)` also exposes `file_reopen()` and the corresponding file failure counters, so config-driven file logging keeps a usable control surface. +- `ConfiguredLogger` built through `build_logger(...)` also exposes `file_reopen()`, `file_flush()`, `file_close()`, and the corresponding file failure counters, so config-driven file logging keeps a usable control surface. - `sink.text_formatter.template` currently supports fixed tokens: `{timestamp}`, `{timestamp_ms}`, `{level}`, `{target}`, `{message}`, and `{fields}`. - Config-driven sink assembly currently supports `console`, `json_console`, `text_console`, and `file`. - `queue` remains a synchronous bounded wrapper around the final sink, not an async runtime. diff --git a/docs/changes/0.3.0.md b/docs/changes/0.3.0.md index 7d0a8ff..0bd2414 100644 --- a/docs/changes/0.3.0.md +++ b/docs/changes/0.3.0.md @@ -31,6 +31,7 @@ version 0.3.0 - feat: support `sink.rotation.max_bytes` and `sink.rotation.max_backups` in JSON logger config - feat: add `FileSink::reopen()` and basic file sink failure counters via `open_failures()`, `write_failures()`, and `flush_failures()` - feat: forward file sink reopen and failure-counter helpers through `RuntimeSink` and `ConfiguredLogger` +- feat: add explicit `file_flush()` and `file_close()` helpers for config-built file sinks, including queued file sink drain-before-close behavior - feat: add `SplitSink`, `split_sink(...)`, and `split_by_level(...)` for routing records into different sinks by predicate or level - feat: add `Logger::bind(...)` as an ergonomic context-binding alias and `fields(...)` helper for tuple-based field construction @@ -46,6 +47,7 @@ version 0.3.0 - test: cover file rotation config parsing, config roundtrip, and native rotation behavior - test: cover file sink reopen behavior and backend-dependent failure counter paths - test: cover config-built file logger reopen and failure-counter helper access +- test: cover config-built file logger flush/close helpers and queued-file drain semantics - test: cover split sink predicate routing and level-based routing behavior - test: cover `bind(...)` context composition and `fields(...)` helper behavior - test: add async logger lifecycle, config roundtrip, and batching/flush policy test seeds @@ -62,6 +64,7 @@ version 0.3.0 - docs: update file sink examples to demonstrate rotation and backup retention - docs: document file sink reopen and observability counters in README variants - docs: clarify that config-built file loggers keep file control and observability helpers +- docs: document explicit file flush/close helpers for config-built file loggers - docs: add split sink examples for level-based routing - docs: add `bind(...)` examples for reusable context binding - docs: update root README and English README with async adapter notes and current scope