mirror of
https://github.com/Nanaloveyuki/BitLogger.git
synced 2026-05-30 15:42:25 +00:00
Nanaloveyuki
85 lines
2.6 KiB
Markdown
85 lines
2.6 KiB
Markdown
---
|
|
name: async-logger-with-context-fields
|
|
group: api
|
|
category: async
|
|
update-time: 20260512
|
|
description: Attach reusable structured fields to an async logger so every queued record inherits them.
|
|
key-word:
|
|
- async
|
|
- logger
|
|
- fields
|
|
- public
|
|
---
|
|
|
|
## Async-logger-with-context-fields
|
|
|
|
Bind shared structured fields to an async logger. This is the standard way to attach stable metadata such as service name, component, region, or subsystem identity without repeating them for every async log call.
|
|
|
|
### Interface
|
|
|
|
```moonbit
|
|
pub fn[S] AsyncLogger::with_context_fields(
|
|
self : AsyncLogger[S],
|
|
fields : Array[@bitlogger.Field],
|
|
) -> AsyncLogger[S] {}
|
|
```
|
|
|
|
#### input
|
|
|
|
- `self : AsyncLogger[S]` - Base async logger that should gain shared fields.
|
|
- `fields : Array[Field]` - Structured fields that will be prepended to each emitted record.
|
|
|
|
#### output
|
|
|
|
- `AsyncLogger[S]` - A new async logger carrying the shared field set.
|
|
|
|
### Explanation
|
|
|
|
Detailed rules explaining key parameters and behaviors
|
|
|
|
- Context fields are merged during `log(...)` before enqueue.
|
|
- When a log call also passes per-record fields, the context fields are placed before those per-call fields.
|
|
- This API returns a new logger value; it does not mutate the original async logger.
|
|
- Unlike synchronous `Logger::with_context_fields(...)`, this async variant stores fields directly on `AsyncLogger` instead of changing the visible sink type.
|
|
|
|
### How to Use
|
|
|
|
Here are some specific examples provided.
|
|
|
|
#### When Need Stable Async Service Metadata
|
|
|
|
When every queued record should carry service-level metadata:
|
|
```moonbit
|
|
let logger = async_logger(console_sink(), target="billing")
|
|
.with_context_fields([
|
|
@bitlogger.field("service", "billing"),
|
|
@bitlogger.field("region", "cn"),
|
|
])
|
|
```
|
|
|
|
In this example, both fields are attached before each record enters the queue.
|
|
|
|
#### When Build Child Async Loggers For Subsystems
|
|
|
|
When a subsystem has both a target and fixed fields:
|
|
```moonbit
|
|
let worker = async_logger(console_sink(), target="app")
|
|
.child("worker")
|
|
.with_context_fields([@bitlogger.field("component", "worker")])
|
|
```
|
|
|
|
In this example, target composition and field binding stay separate but work together cleanly.
|
|
|
|
### Error Case
|
|
|
|
e.g.:
|
|
- If `fields` is empty, the logger remains valid and just adds no extra metadata.
|
|
|
|
- If duplicate field keys are provided, all fields are still emitted; conflict handling is left to the consumer side.
|
|
|
|
### Notes
|
|
|
|
1. Use this for stable metadata, not highly dynamic event-specific values.
|
|
|
|
2. This async variant preserves the visible `AsyncLogger[S]` type while still injecting shared fields.
|