distribute/log

Types

Config

Logger configuration

pub type Config {
  Config(
    level: Level,
    enable_colors: Bool,
    enable_timestamps: Bool,
  )
}

Constructors

Config(
  level: Level,
  enable_colors: Bool,
  enable_timestamps: Bool,
)

Level

</>

Log levels from most verbose to least verbose

pub type Level {
  Debug
  Info
  Warn
  Error
  Off
}

Constructors

```
Debug
```
```
Info
```
```
Warn
```
```
Error
```
```
Off
```

LogEntry

</>

Structured log entry with metadata

pub type LogEntry {
  LogEntry(
    Level,
    String,
    List(#(String, String)),
    option.Option(String),
    Int,
  )
}

Constructors

LogEntry(
  Level,
  String,
  List(#(String, String)),
  option.Option(String),
  Int,
)

Values

clear_last_log_entry_for_test

</>

pub fn clear_last_log_entry_for_test() -> Nil

Clear the last formatted log entry (test helper)

debug

</>

pub fn debug(
  message: String,
  metadata: List(#(String, String)),
) -> Nil

Log a debug message

debug_with_correlation

</>

pub fn debug_with_correlation(
  message: String,
  metadata: List(#(String, String)),
  correlation_id: String,
) -> Nil

Log a debug message with correlation ID

disable_logging

</>

pub fn disable_logging() -> Nil

Disable all logging output (useful for tests)

enable_logging

</>

pub fn enable_logging() -> Nil

Enable logging output

error

</>

pub fn error(
  message: String,
  metadata: List(#(String, String)),
) -> Nil

Log an error message

error_with_correlation

</>

pub fn error_with_correlation(
  message: String,
  metadata: List(#(String, String)),
  correlation_id: String,
) -> Nil

Log an error message with correlation ID

format_log_entry

</>

pub fn format_log_entry(entry: LogEntry) -> String

Format a log entry as a string

generate_correlation_id

</>

pub fn generate_correlation_id() -> String

Generate a new correlation ID

get_level

</>

pub fn get_level() -> Level

Get the current minimum log level

info

</>

pub fn info(
  message: String,
  metadata: List(#(String, String)),
) -> Nil

Log an info message

info_with_correlation

</>

pub fn info_with_correlation(
  message: String,
  metadata: List(#(String, String)),
  correlation_id: String,
) -> Nil

Log an info message with correlation ID

last_log_entry_for_test

</>

pub fn last_log_entry_for_test() -> option.Option(String)

Retrieve the last formatted log entry (test helper)

log

</>

pub fn log(
  level: Level,
  message: String,
  metadata: List(#(String, String)),
  correlation_id: option.Option(String),
) -> Nil

Core logging function

set_backend

</>

pub fn set_backend(backend: String) -> Nil

Set the logging backend implementation used to handle output. Use “console” (default) or “erlang_logger”.

set_level

</>

pub fn set_level(level: Level) -> Nil

Set the minimum log level Messages below this level will not be logged

warn

</>

pub fn warn(
  message: String,
  metadata: List(#(String, String)),
) -> Nil

Log a warning message

warn_with_correlation

</>

pub fn warn_with_correlation(
  message: String,
  metadata: List(#(String, String)),
  correlation_id: String,
) -> Nil

Log a warning message with correlation ID

with_correlation_id

</>

pub fn with_correlation_id(id: String, f: fn() -> a) -> a

Execute a function with a specific correlation ID