Files
BitLogger/docs/api/build-application-logger.md
T
2026-06-14 07:41:51 +08:00

2.7 KiB

name, group, category, update-time, description, key-word
name group category update-time description key-word
build-application-logger api facade 20260520 Build the application-facing configured logger alias from a LoggerConfig by delegating directly to the normal runtime logger build path.
application
facade
logger
public

Build-application-logger

Build an ApplicationLogger from LoggerConfig. This facade is the application-oriented sync entry point and currently aliases the configured runtime logger shape returned by build_logger(...).

Interface

pub fn build_application_logger(config : LoggerConfig) -> ApplicationLogger {

input

  • config : LoggerConfig - Fully assembled sync logger config.

output

  • ApplicationLogger - Application-facing configured runtime logger.

Explanation

Detailed rules explaining key parameters and behaviors

  • This API delegates to build_logger(...) directly.
  • The embedded config still goes through the normal runtime logger build path, including runtime sink selection, optional queue wrapping, and timestamp application.
  • Because the result is only the ApplicationLogger alias over ConfiguredLogger, this builder does not hide any queue, drain, flush, or file runtime helper methods.
  • The returned alias also keeps inherited Logger behavior such as with_target(...), child(...), and per-call target= overrides on log(...).
  • Use this alias-oriented entrypoint when application boot code wants an app-specific name without changing the underlying configured runtime logger surface.

How to Use

Here are some specific examples provided.

When Need An App-level Sync Builder Entry

When boot code assembles config values before runtime construction:

let logger = build_application_logger(
  LoggerConfig::new(target="app", sink=SinkConfig::new(kind=SinkKind::Console)),
)

In this example, the application facade builds the same configured runtime logger shape as build_logger(...).

And any queue/file/runtime helpers selected by the config remain directly available on the returned alias value.

The returned value also keeps the ordinary logger target semantics because the facade does not wrap or narrow the underlying ConfiguredLogger.

Error Case

e.g.:

  • If the config uses file output on a backend without native file support, backend runtime limitations still apply after construction.

  • If queueing is not configured, queue helper values simply reflect the non-queued runtime shape.

Notes

  1. This is a facade API, not a separate runtime implementation.

  2. Use parse_and_build_application_logger(...) when starting from JSON text.

  3. Use build_library_logger(...) instead when the public surface should intentionally hide configured-runtime helper methods.