Files
BitLogger/docs/api/parse-and-build-application-logger.md
Nanaloveyuki 25a6a973d2 πŸ“ Update More API Document
2026-05-20 11:37:49 +08:00

1.8 KiB

name, group, category, update-time, description, key-word
name group category update-time description key-word
parse-and-build-application-logger api facade 20260520 Parse JSON logger config text and build the application-facing sync logger facade.
application
facade
parse
public

Parse-and-build-application-logger

Parse raw JSON config text and build an ApplicationLogger in one step. This facade is the application-oriented counterpart to parse_and_build_logger(...).

Interface

pub fn parse_and_build_application_logger(
  input : String,
) -> ApplicationLogger raise ConfigError {

input

  • input : String - Raw JSON logger config text.

output

  • ApplicationLogger - Application-facing configured runtime logger built from parsed config.

Explanation

Detailed rules explaining key parameters and behaviors

  • This API delegates to parse_and_build_logger(...).
  • JSON parsing and config validation happen before the logger is built.
  • The returned logger keeps the same queue and file helper surface as other configured sync runtime loggers.

How to Use

Here are some specific examples provided.

When Need Direct JSON Bootstrapping For Applications

When config is stored as text and should be built immediately:

let logger = parse_and_build_application_logger(
  "{\"min_level\":\"warn\",\"target\":\"app\",\"sink\":{\"kind\":\"console\"}}",
)

In this example, parsing and runtime construction are combined into one facade call.

Error Case

e.g.:

  • If the JSON is malformed, a ConfigError is raised.

  • If the parsed config is invalid, such as an empty file sink path, a ConfigError is raised.

Notes

  1. Use this facade when application code wants a text-to-runtime entry point.

  2. Use build_application_logger(...) when the config is already typed as LoggerConfig.