naloveyuki/BitLogger
1
0
Fork 0
mirror of https://github.com/Nanaloveyuki/BitLogger.git synced 2026-07-29 22:16:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

📝 refresh runtime file export docs

Browse Source
This commit is contained in:
Nanaloveyuki
2026-06-13 23:37:55 +08:00
parent 06541a578c
commit 56ba583680
6 changed files with 19 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api/runtime-file-state-to-json.md
+3 -3
View File
@@ -13,7 +13,7 @@ key-word:
## Runtime-file-state-to-json
Convert `RuntimeFileState` into a `JsonValue`. This helper exports both file sink status and outer queue metrics for queued file runtime diagnostics.
Convert `RuntimeFileState` into a `JsonValue`. This helper exports both file sink status and queue metrics for combined runtime file diagnostics.
### Interface
@@ -36,7 +36,7 @@ Detailed rules explaining key parameters and behaviors
- The output includes `file`, `queued`, `pending_count`, and `dropped_count`.
- `file` is itself exported as a nested file sink state object.
- This helper is richer than `file_sink_state_to_json(...)` because it also carries queue wrapping context.
- It is useful for `ConfiguredLogger::file_runtime_state()` and similar queued-file diagnostics flows.
- It is useful for `RuntimeSink::file_runtime_state()`, `ConfiguredLogger::file_runtime_state()`, and similar queued-file diagnostics flows.
### How to Use
@@ -71,4 +71,4 @@ e.g.:
1. Use this helper when file and queue runtime context should stay together.
2. It is especially useful for configured queued file loggers.
2. It is especially useful for queued file runtime paths, whether accessed directly or through configured loggers.