naloveyuki/BitLogger
1
0
Fork 0
mirror of https://github.com/Nanaloveyuki/BitLogger.git synced 2026-08-01 16:04:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

📝 clarify logger context field binding

Browse Source
This commit is contained in:
Nanaloveyuki
2026-06-14 11:28:42 +08:00
parent 480c5ad602
commit 93cadcc7f1
1 changed files with 5 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api/logger-with-context-fields.md
+5
View File
@@ -37,6 +37,7 @@ Detailed rules explaining key parameters and behaviors
- Context fields are merged at write time, not by mutating previously created records. - Context fields are merged at write time, not by mutating previously created records.
- When a log call also passes per-record fields, the context fields are placed before those per-call fields. - When a log call also passes per-record fields, the context fields are placed before those per-call fields.
- This API returns a new typed logger wrapper; it does not mutate the original logger variable. - This API returns a new typed logger wrapper; it does not mutate the original logger variable.
- The returned logger keeps the same stored target, min level, and timestamp behavior while extending the sink pipeline with context-field merging.
- `bind(...)` is an ergonomic alias for this same behavior. - `bind(...)` is an ergonomic alias for this same behavior.
### How to Use ### How to Use
@@ -57,6 +58,8 @@ In this example, both `service` and `region` are automatically included on every
And callers only need to provide fields that actually vary per event. And callers only need to provide fields that actually vary per event.
The original base logger value is still unchanged if later code keeps using it directly.
#### When Build Child Loggers For Subsystems #### When Build Child Loggers For Subsystems
When a subsystem has both a target and fixed fields: When a subsystem has both a target and fixed fields:
@@ -81,3 +84,5 @@ e.g.:
2. Prefer `fields([("k", "v")])` when you want a more ergonomic call site. 2. Prefer `fields([("k", "v")])` when you want a more ergonomic call site.
3. Use `bind(...)` when you want the same behavior with a shorter, library-style call name.