From ec0b7699fe2c9787079571e857683657f24e01bd Mon Sep 17 00:00:00 2001 From: Nanaloveyuki Date: Sun, 10 May 2026 13:31:49 +0800 Subject: [PATCH] =?UTF-8?q?=E2=9C=A8=20Add=20bundled=20file=20policy=20set?= =?UTF-8?q?ters?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 2 ++ bitlogger/BitLogger_test.mbt | 34 ++++++++++++++++++++++++++++++++++ bitlogger/BitLogger_wbtest.mbt | 25 +++++++++++++++++++++++++ bitlogger/README.mbt.md | 2 ++ bitlogger/config.mbt | 18 ++++++++++++++++++ bitlogger/sinks.mbt | 6 ++++++ docs/README-en.md | 2 ++ docs/changes/0.3.0.md | 1 + 8 files changed, 90 insertions(+) diff --git a/README.md b/README.md index a98e873..3ee2bf3 100644 --- a/README.md +++ b/README.md @@ -247,12 +247,14 @@ match logger.file_runtime_state() { - `file_sink(...)` 还提供 `rotation_enabled()` 与 `rotation_config()`，可直接查询当前 rotation 策略是否启用及其参数 - `file_sink(...)` 还提供 `state()`，可一次性读取 path、available、append、auto_flush、rotation 与各类 failure counter 快照 - `file_sink(...)` 还提供 `policy()` 与 `default_policy()`，可分别读取当前策略与创建时默认策略 +- `file_sink(...)` 也支持 `set_policy(...)`，可一次性写回 append/auto_flush/rotation 这组三元策略 - `file_sink(...)` 还提供 `reset_failure_counters()`，可在完成排障后清空 open/write/flush/rotation 失败计数 - `file_sink(...)` 还提供 `reset_policy()`，可将 append/auto_flush/rotation 恢复到创建 sink 时的默认策略 - `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 计数访问器，便于配置式接入后继续运维控制 - `ConfiguredLogger` 还提供 `file_runtime_state()`，可在 file sink 外层包了 queue 时同时读取底层 file 快照、是否 queue 包装、当前 pending 与 dropped 计数 - `ConfiguredLogger` 还提供 `file_policy()` 与 `file_default_policy()`，可分别读取当前 file 策略与初始配置策略 +- `ConfiguredLogger` 也支持 `file_set_policy(...)`，可一次性改写配置式 file sink 的当前运行期策略 - `ConfiguredLogger` 也支持 `file_reset_failure_counters()`，可在配置式 file sink 上统一清空失败计数 - `ConfiguredLogger` 也支持 `file_reset_policy()`，可将配置式 file sink 的运行期策略恢复到初始配置 - `file_sink_state_to_json(...)`、`stringify_file_sink_state(...)`、`runtime_file_state_to_json(...)`、`stringify_runtime_file_state(...)` 可直接把 file / queued-file 快照导出为 JSON，便于排障或上报 diff --git a/bitlogger/BitLogger_test.mbt b/bitlogger/BitLogger_test.mbt index ae4bb48..aa5c0cb 100644 --- a/bitlogger/BitLogger_test.mbt +++ b/bitlogger/BitLogger_test.mbt @@ -401,11 +401,45 @@ test "configured logger reset policy restores configured file defaults" { ignore(logger.close()) } +test "configured logger set policy applies bundled runtime file policy" { + let logger = build_logger( + LoggerConfig::new( + sink=SinkConfig::new(kind=SinkKind::File, path="config-set-policy.log"), + ), + ) + let default_policy = logger.file_default_policy() + inspect( + logger.file_set_policy( + FileSinkPolicy::new( + append=false, + auto_flush=false, + rotation=Some(file_rotation(22, max_backups=3)), + ), + ), + content="true", + ) + let policy = logger.file_policy() + inspect(policy.append, content="false") + inspect(policy.auto_flush, content="false") + match policy.rotation { + Some(rotation) => { + inspect(rotation.max_bytes, content="22") + inspect(rotation.max_backups, content="3") + } + None => inspect(false, content="true") + } + inspect(default_policy.append, content="true") + inspect(default_policy.auto_flush, content="true") + inspect(default_policy.rotation is None, content="true") + ignore(logger.close()) +} + test "configured non-file logger cannot reset file policy" { let logger = build_logger(LoggerConfig::new(sink=SinkConfig::new(kind=SinkKind::Console))) inspect(logger.file_reset_policy(), content="false") inspect(logger.file_policy().append, content="false") inspect(logger.file_default_policy().append, content="false") + inspect(logger.file_set_policy(FileSinkPolicy::new()), content="false") } test "configured logger can reopen built file sink" { diff --git a/bitlogger/BitLogger_wbtest.mbt b/bitlogger/BitLogger_wbtest.mbt index 32fd5db..d281ffe 100644 --- a/bitlogger/BitLogger_wbtest.mbt +++ b/bitlogger/BitLogger_wbtest.mbt @@ -194,6 +194,31 @@ test "file sink reset policy restores configured defaults" { } } +test "file sink set policy applies bundled runtime policy" { + let sink = file_sink("bitlogger-set-policy.log") + let default_policy = sink.default_policy() + sink.set_policy( + FileSinkPolicy::new( + append=false, + auto_flush=false, + rotation=Some(file_rotation(18, max_backups=2)), + ), + ) + let policy = sink.policy() + inspect(policy.append, content="false") + inspect(policy.auto_flush, content="false") + match policy.rotation { + Some(rotation) => { + inspect(rotation.max_bytes, content="18") + inspect(rotation.max_backups, content="2") + } + None => inspect(false, content="true") + } + inspect(default_policy.append, content="true") + inspect(default_policy.auto_flush, content="true") + inspect(default_policy.rotation is None, content="true") +} + test "file sink tracks rotation failures on unavailable backend" { let sink = file_sink("bitlogger-rotate.log", rotation=Some(file_rotation(1, max_backups=1))) sink.write(record(Level::Info, "a")) diff --git a/bitlogger/README.mbt.md b/bitlogger/README.mbt.md index 79e1f3e..093d88f 100644 --- a/bitlogger/README.mbt.md +++ b/bitlogger/README.mbt.md @@ -243,6 +243,7 @@ test { - `rotation_enabled()` and `rotation_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()` and `default_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(...)` and `runtime_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(...)` 可将快照直接导出为 JSON @@ -251,6 +252,7 @@ test { - `ConfiguredLogger` also 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()` and `ConfiguredLogger::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 diff --git a/bitlogger/config.mbt b/bitlogger/config.mbt index 137e9c4..faba432 100644 --- a/bitlogger/config.mbt +++ b/bitlogger/config.mbt @@ -388,6 +388,20 @@ pub fn RuntimeSink::file_set_auto_flush(self : RuntimeSink, enabled : Bool) -> B } } +pub fn RuntimeSink::file_set_policy(self : RuntimeSink, policy : FileSinkPolicy) -> Bool { + match self { + File(sink) => { + sink.set_policy(policy) + true + } + QueuedFile(sink) => { + sink.sink.set_policy(policy) + true + } + _ => false + } +} + pub fn RuntimeSink::file_set_rotation(self : RuntimeSink, rotation : FileRotation?) -> Bool { match self { File(sink) => { @@ -617,6 +631,10 @@ pub fn ConfiguredLogger::file_set_auto_flush(self : ConfiguredLogger, enabled : self.sink.file_set_auto_flush(enabled) } +pub fn ConfiguredLogger::file_set_policy(self : ConfiguredLogger, policy : FileSinkPolicy) -> Bool { + self.sink.file_set_policy(policy) +} + pub fn ConfiguredLogger::file_set_rotation( self : ConfiguredLogger, rotation : FileRotation?, diff --git a/bitlogger/sinks.mbt b/bitlogger/sinks.mbt index 007b182..a8976bc 100644 --- a/bitlogger/sinks.mbt +++ b/bitlogger/sinks.mbt @@ -198,6 +198,12 @@ pub fn FileSink::set_auto_flush(self : FileSink, enabled : Bool) -> Unit { self.auto_flush.val = enabled } +pub fn FileSink::set_policy(self : FileSink, policy : FileSinkPolicy) -> Unit { + self.append.val = policy.append + self.auto_flush.val = policy.auto_flush + self.rotation.val = policy.rotation +} + pub fn FileSink::set_rotation(self : FileSink, rotation : FileRotation?) -> Unit { self.rotation.val = rotation } diff --git a/docs/README-en.md b/docs/README-en.md index 6574982..b026e3c 100644 --- a/docs/README-en.md +++ b/docs/README-en.md @@ -231,12 +231,14 @@ match logger.file_runtime_state() { - `file_sink(...)` also exposes `rotation_enabled()` and `rotation_config()` for reading whether rotation is active and which parameters are currently in effect. - `file_sink(...)` also exposes `state()` for reading a single snapshot that includes path, availability, append policy, auto-flush flag, rotation config, and all current failure counters. - `file_sink(...)` also exposes `policy()` and `default_policy()` for reading the current runtime policy and the sink's original default policy separately. +- `file_sink(...)` also exposes `set_policy(...)` for applying append, auto-flush, and rotation as a single bundled runtime policy update. - `file_sink(...)` also exposes `reset_failure_counters()` so open/write/flush/rotation failure counters can be cleared after diagnostics or recovery handling. - `file_sink(...)` also exposes `reset_policy()` so append, auto-flush, and rotation settings can be restored to the sink's original defaults. - `file_sink(...)` also supports `set_auto_flush(...)`, `set_rotation(...)`, and `clear_rotation()` for runtime policy updates. - `ConfiguredLogger` built through `build_logger(...)` also exposes `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()`, plus `file_set_append_mode(...)`, `file_set_auto_flush(...)`, `file_set_rotation(...)`, `file_clear_rotation()`, and the corresponding file failure counters, so config-driven file logging keeps a usable control surface. - `ConfiguredLogger` also exposes `file_runtime_state()` so queued file loggers can report both the underlying file snapshot and the outer queue backlog/drop state in one read. - `ConfiguredLogger` also exposes `file_policy()` and `file_default_policy()` for reading current runtime file policy and initial config policy separately. +- `ConfiguredLogger` also exposes `file_set_policy(...)` for applying a bundled runtime file policy through the config-built control surface. - `ConfiguredLogger` also exposes `file_reset_failure_counters()` for clearing file failure counters through the config-built control surface. - `ConfiguredLogger` also exposes `file_reset_policy()` for restoring runtime file policy back to the initial config values. - `file_sink_state_to_json(...)`, `stringify_file_sink_state(...)`, `runtime_file_state_to_json(...)`, and `stringify_runtime_file_state(...)` can export file and queued-file snapshots directly as JSON for diagnostics or reporting. diff --git a/docs/changes/0.3.0.md b/docs/changes/0.3.0.md index aa906ca..240bbc6 100644 --- a/docs/changes/0.3.0.md +++ b/docs/changes/0.3.0.md @@ -45,6 +45,7 @@ version 0.3.0 - feat: add `reset_failure_counters()` / `file_reset_failure_counters()` so file failure counters can be cleared after diagnostics or recovery handling - feat: add `reset_policy()` / `file_reset_policy()` so runtime append, auto-flush, and rotation settings can be restored to their initial defaults - feat: add `policy()` / `default_policy()` and configured-logger forwarding helpers so current runtime file policy and original defaults can be read explicitly +- feat: add `set_policy()` / `file_set_policy()` so bundled append, auto-flush, and rotation policy can be applied in one runtime operation - 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