View Source ProcessHub.Service.LoggerService (ProcessHub v0.5.0-beta)

Logging service for ProcessHub with Drupal-style placeholder-based formatting.

Provides simple functions (no macros) for logging with automatic [ProcessHub] prefix and optional custom prefix support. Each log message includes metadata (current node) appended at the end.

Placeholder Syntax

Uses @key placeholders that are replaced with values from the replacements map:

LoggerService.error("Child @child_id failed", %{
  "child_id" => "my_child"
})
# => "[ProcessHub] Child my_child failed | node: :foo@bar"

Custom Prefix

Add a custom prefix after [ProcessHub] using the :prefix option:

LoggerService.warning("Timeout occurred", %{}, prefix: "Coordinator")
# => "[ProcessHub][Coordinator] Timeout occurred | node: :foo@bar"

Available Functions

debug/3 - Debug level
info/3 - Info level
notice/3 - Notice level
warning/3 - Warning level
error/3 - Error level

All functions have the signature: level(message, replacements \\ %{}, opts \\ [])

Summary

Functions

debug(message, replacements \\ %{}, opts \\ [])

Logs a debug message with optional placeholders and prefix.

error(message, replacements \\ %{}, opts \\ [])

Logs an error message with optional placeholders and prefix.

format_message(message, replacements, opts)

Formats a message with prefix, placeholder replacement, and metadata.

info(message, replacements \\ %{}, opts \\ [])

Logs an info message with optional placeholders and prefix.

notice(message, replacements \\ %{}, opts \\ [])

Logs a notice message with optional placeholders and prefix.

replace_placeholders(message, replacements)

Replaces @key placeholders in a message with values from the replacements map.

warning(message, replacements \\ %{}, opts \\ [])

Logs a warning message with optional placeholders and prefix.

Functions

debug(message, replacements \\ %{}, opts \\ [])

@spec debug(String.t(), map(), keyword()) :: :ok

Logs a debug message with optional placeholders and prefix.

Parameters

message - The log message with optional @key placeholders
replacements - Map of placeholder keys to values (default: %{})
opts - Keyword list of options (default: [])
- :prefix - Optional string to add after [ProcessHub]

Examples

LoggerService.debug("Processing @item", %{"item" => "foo"})
LoggerService.debug("Starting up", %{}, prefix: "Worker")

error(message, replacements \\ %{}, opts \\ [])

@spec error(String.t(), map(), keyword()) :: :ok

Logs an error message with optional placeholders and prefix.

Parameters

message - The log message with optional @key placeholders
replacements - Map of placeholder keys to values (default: %{})
opts - Keyword list of options (default: [])
- :prefix - Optional string to add after [ProcessHub]

Examples

LoggerService.error("Failed to connect")
LoggerService.error("Process @pid crashed", %{"pid" => self()}, prefix: "Supervisor")

format_message(message, replacements, opts)

@spec format_message(String.t(), map(), keyword()) :: String.t()

Formats a message with prefix, placeholder replacement, and metadata.

Parameters

message - The log message with optional @key placeholders
replacements - Map of placeholder keys to values
opts - Keyword list of options
- :prefix - Optional string to add after [ProcessHub]

Examples

iex> LoggerService.format_message("Hello @name", %{"name" => "World"}, [])
"[ProcessHub] Hello World | node: :nonode@nohost"

iex> LoggerService.format_message("Test", %{}, prefix: "Module")
"[ProcessHub][Module] Test | node: :nonode@nohost"

info(message, replacements \\ %{}, opts \\ [])

@spec info(String.t(), map(), keyword()) :: :ok

Logs an info message with optional placeholders and prefix.

Parameters

message - The log message with optional @key placeholders
replacements - Map of placeholder keys to values (default: %{})
opts - Keyword list of options (default: [])
- :prefix - Optional string to add after [ProcessHub]

Examples

LoggerService.info("System started")
LoggerService.info("Connected to @host", %{"host" => "localhost"})

notice(message, replacements \\ %{}, opts \\ [])

@spec notice(String.t(), map(), keyword()) :: :ok

Logs a notice message with optional placeholders and prefix.

Parameters

message - The log message with optional @key placeholders
replacements - Map of placeholder keys to values (default: %{})
opts - Keyword list of options (default: [])
- :prefix - Optional string to add after [ProcessHub]

Examples

LoggerService.notice("Cache cleared")
LoggerService.notice("User @user logged in", %{"user" => "admin"})

replace_placeholders(message, replacements)

@spec replace_placeholders(String.t(), map()) :: String.t()

Replaces @key placeholders in a message with values from the replacements map.

Values are converted to strings using inspect/1 for non-string values.

Parameters

message - The message string with @key placeholders
replacements - Map of string keys to replacement values

Examples

iex> LoggerService.replace_placeholders("Hello @name", %{"name" => "World"})
"Hello World"

iex> LoggerService.replace_placeholders("Node @node", %{"node" => :foo@bar})
"Node :foo@bar"

warning(message, replacements \\ %{}, opts \\ [])

@spec warning(String.t(), map(), keyword()) :: :ok

Logs a warning message with optional placeholders and prefix.

Parameters

message - The log message with optional @key placeholders
replacements - Map of placeholder keys to values (default: %{})
opts - Keyword list of options (default: [])
- :prefix - Optional string to add after [ProcessHub]

Examples

LoggerService.warning("Connection timeout")
LoggerService.warning("Retrying @count times", %{"count" => 3}, prefix: "Client")