--- name: configured-logger group: api category: runtime update-time: 20260707 description: Public configured runtime logger alias used for config-built sync logging with queue and file controls. key-word: - logger - runtime - alias - public --- ## Configured-logger `ConfiguredLogger` is the public sync runtime logger type returned by config-driven build APIs. It is a direct alias to `Logger[RuntimeSink]`, so it keeps ordinary logger write methods while also exposing configured queue and file runtime helpers. ### Interface ```moonbit pub type ConfiguredLogger = Logger[RuntimeSink] ``` #### output - `ConfiguredLogger` - Public config-built runtime logger backed by `RuntimeSink`. ### Explanation Detailed rules explaining key parameters and behaviors - This is a type alias, not a separate wrapper implementation. - It preserves normal logger methods such as `info(...)`, `warn(...)`, `error(...)`, and the other `Logger` APIs. - Because it is `Logger[RuntimeSink]`, it also keeps ordinary logger composition and target behavior such as `with_target(...)`, `child(...)`, and per-call `log(..., target=...)` overrides. - In particular, `log(..., target=...)` can override the target for one call, while severity helpers such as `info(...)`, `warn(...)`, and `error(...)` continue using the stored logger target unless code derives another logger first with `with_target(...)` or `child(...)`. - It also exposes configured runtime helpers such as `flush_progress()`, `drain_progress()`, `flush()`, `drain()`, `pending_count()`, `dropped_count()`, and file-specific controls when the runtime sink supports them. - `flush_progress()` and `drain_progress()` are the recommended truthful generic progress helpers, while `flush()` and `drain()` remain compatibility wrappers that collapse the structured result back into one `Int`. - Because `ConfiguredLogger` is only an alias over `Logger[RuntimeSink]`, ordinary sync composition helpers such as `with_target(...)`, `child(...)`, `with_timestamp(...)`, `with_filter(...)`, and `with_patch(...)` keep the same visible runtime-sink logger line rather than stripping away the configured helper surface. - In current direct builder coverage, derived configured loggers still preserve queue counters, drain or flush behavior, runtime sink variant choice, and file helper access instead of collapsing back to a narrower non-runtime shape. - Builders such as `build_logger(...)` and `parse_and_build_logger(...)` return this alias as the main sync config-to-runtime result. - `ApplicationLogger` is another direct alias-oriented name for this same configured runtime surface, while `LibraryLogger[RuntimeSink]` is the narrowing facade variant that intentionally hides these runtime helpers until `to_logger()` is used. ### How to Use Here are some specific examples provided. #### When Need A Typed Config-built Runtime Logger When boot code should keep the built logger as a named runtime type: ```moonbit let logger : ConfiguredLogger = build_logger(LoggerConfig::new(target="svc")) ``` In this example, the configured runtime logger remains a first-class typed value after config assembly. #### When Need Normal Logging Plus Runtime Controls When code should both emit logs and inspect configured runtime behavior: ```moonbit logger.info("started") ignore(logger.pending_count()) ``` In this example, the alias keeps ordinary logging calls while still exposing runtime diagnostics. And the inherited logger target rules stay unchanged: `log(..., target=...)` can override the target per call, while `info(...)`, `warn(...)`, and `error(...)` continue using the stored target unless code derives another logger first with `with_target(...)` or `child(...)`. And later derived values such as `logger.child("worker")` or `logger.with_patch(...)` still keep the runtime helper surface because the configured logger line is only being recomposed, not narrowed or rebuilt into a different facade. #### When Need A One-call Target Override On The Configured Runtime Logger When config-built sync code should keep the same logger value but emit one record under a different target: ```moonbit logger.log(Level::Error, "boom", target="svc.audit") ``` In this example, the emitted record uses `svc.audit` only for that one call. And later `info(...)`, `warn(...)`, or `error(...)` calls still use the logger's stored target unless code derives another logger first with `with_target(...)` or `child(...)`. ### Error Case e.g.: - `ConfiguredLogger` itself does not have a runtime failure mode. - The concrete behavior of queue and file helpers still depends on the configured `RuntimeSink` shape and current backend support. ### Notes 1. Use `build_logger(...)` or `parse_and_build_logger(...)` when you need a value of this type. 2. Inherited `Logger` behavior stays unchanged on this alias, including target overrides on `log(...)` and derived target composition through `with_target(...)` and `child(...)`. 3. Use `ApplicationLogger` when application code wants the same full configured-runtime helper surface under an app-facing name. 4. Use `LibraryLogger[RuntimeSink]` when a library boundary should intentionally hide configured-runtime helper methods behind a narrower facade.