mirror of
https://github.com/Nanaloveyuki/BitLogger.git
synced 2026-07-29 14:06:34 +00:00
📝 consolidate logger API and async lifecycle guidance
This commit is contained in:
@@ -3,7 +3,7 @@ name: library-logger-log
|
||||
group: api
|
||||
category: facade
|
||||
update-time: 20260613
|
||||
description: Emit a record through a LibraryLogger facade with explicit level, message, fields, and optional target override.
|
||||
description: Emit a record through a LibraryLogger facade with explicit level, message, fields, and optional target override by delegating to the wrapped logger.
|
||||
key-word:
|
||||
- library
|
||||
- facade
|
||||
@@ -46,7 +46,9 @@ Detailed rules explaining key parameters and behaviors
|
||||
- This method delegates directly to the wrapped logger's `log(...)` behavior.
|
||||
- The logger checks `is_enabled(level)` before building and writing the record.
|
||||
- If `target` is empty, the facade's stored default target is used.
|
||||
- Any existing sink wrappers already inside the wrapped logger, such as `ContextSink`, `FilterSink`, `PatchSink`, or queued/runtime sink variants, still participate normally in the write path.
|
||||
- The narrower library facade does not change record construction semantics; it only limits the visible API surface.
|
||||
- Broader composition helpers remain on the underlying `Logger[S]` and require `to_logger()` first.
|
||||
|
||||
### How to Use
|
||||
|
||||
@@ -77,6 +79,20 @@ fn log_retry(logger : LibraryLogger[ConsoleSink], attempt : Int) -> Unit {
|
||||
|
||||
In this example, `log(...)` acts as the shared primitive under custom library-facing wrappers.
|
||||
|
||||
#### When Need Shared Context Plus Event-specific Fields
|
||||
|
||||
When a facade already carries shared context but one write needs extra detail:
|
||||
```moonbit
|
||||
let logger = base.with_context_fields([field("service", "cache")])
|
||||
logger.log(
|
||||
Level::Info,
|
||||
"entry refreshed",
|
||||
fields=[field("key", "user:42")],
|
||||
)
|
||||
```
|
||||
|
||||
In this example, both the stored shared context and the per-call fields still flow through the wrapped logger pipeline.
|
||||
|
||||
### Error Case
|
||||
|
||||
e.g.:
|
||||
@@ -84,8 +100,12 @@ e.g.:
|
||||
|
||||
- If `target` is empty and the logger default target is also empty, the emitted record simply has no target label.
|
||||
|
||||
- If callers need broader composition helpers after writing, they must unwrap first with `to_logger()`.
|
||||
|
||||
### Notes
|
||||
|
||||
1. Use this API when the call site needs full control instead of a fixed-severity helper.
|
||||
|
||||
2. The facade remains synchronous; any buffering behavior only comes from the wrapped sink type.
|
||||
|
||||
3. Use the optional `target` argument when one write should temporarily override the facade's default target without rebuilding or rewrapping it.
|
||||
|
||||
Reference in New Issue
Block a user