Struct LoggingBuilder 

pub struct LoggingBuilder { /* private fields */ }

Builder for constructing a tracing subscriber with flexible configuration

This builder provides a fluent API for configuring logging with different formats and output targets. It eliminates code duplication by centralizing layer creation and subscriber initialization.

Supports independent format control for file and stderr outputs, with automatic ANSI code handling (disabled for files, enabled for stderr).

Examples

use std::path::Path;
use torrust_tracker_deployer_lib::bootstrap::logging::{LogOutput, LogFormat, LoggingBuilder};

// Basic usage with defaults (Compact file format, Pretty stderr format, FileAndStderr output)
LoggingBuilder::new(Path::new("./data/logs")).init();

// Custom configuration with independent formats
LoggingBuilder::new(Path::new("./data/logs"))
    .with_file_format(LogFormat::Json)
    .with_stderr_format(LogFormat::Pretty)
    .with_output(LogOutput::FileAndStderr)
    .init();

// Backward compatible with single format for both outputs
LoggingBuilder::new(Path::new("./data/logs"))
    .with_format(LogFormat::Compact)
    .with_output(LogOutput::FileOnly)
    .init();

Implementations

impl LoggingBuilder

pub fn new(log_dir: &Path) -> Self

Create a new logging builder with default settings

Default configuration:

• File Format: LogFormat::Compact (no ANSI codes)
• Stderr Format: LogFormat::Pretty (with ANSI codes)
• Output: LogOutput::FileAndStderr

Arguments

• log_dir - Directory where log files should be written (e.g., ./data/logs)

pub fn with_format(self, format: LogFormat) -> Self

Set the logging format for both file and stderr outputs

This is a convenience method for backward compatibility. For independent format control, use with_file_format() and with_stderr_format().

Arguments

• format - The desired logging format (Pretty, Json, or Compact)

pub fn with_file_format(self, format: LogFormat) -> Self

Set the logging format for file output

ANSI codes are automatically disabled for file output to ensure logs are easily parsed with standard text tools (grep, awk, sed).

Arguments

• format - The desired logging format for files (Pretty, Json, or Compact)

pub fn with_stderr_format(self, format: LogFormat) -> Self

Set the logging format for stderr output

ANSI codes are automatically enabled for stderr output to provide colored terminal output for better readability.

Arguments

• format - The desired logging format for stderr (Pretty, Json, or Compact)

pub fn with_output(self, output: LogOutput) -> Self

Set the output target

Arguments

• output - Where to write logs (FileOnly or FileAndStderr)

pub fn init(self)

Initialize the global tracing subscriber with the configured settings

This consumes the builder and sets up the global logging infrastructure. After calling this, all logging macros (tracing::info!, etc.) will use this configuration.

Panics

Panics if:

• Log directory cannot be created (filesystem permissions issue)
• Subscriber initialization fails (usually means it was already initialized)

Both panics are intentional as logging is critical for observability.