Logger

Centralized logging system for Ceramic applications that provides colored, categorized output.

The Logger class extends Entity to provide event-based logging with different severity levels. It handles platform-specific output formatting (Unity, Web, Native) and thread-safe logging from background threads. All log messages can be observed through events for custom handling.

The logger supports five severity levels:

• debug: Development and diagnostic information (magenta in Unity, [debug] prefix)
• info: General informational messages (cyan in Unity, [info] prefix)
• success: Success confirmations (lime in Unity, [success] prefix)
• warning: Warning messages (yellow in Unity, uses console.warn on web)
• error: Error messages (red in Unity, uses console.error on web)

Example usage:

// Basic logging (accessible via `log` in Ceramic project)
log.info("Game started");
log.debug("Player position: " + player.x + ", " + player.y);
log.warning("Low memory detected");
log.error("Failed to load save file");

// Hierarchical logging with indentation
log.info("Loading assets...");
log.pushIndent();
log.info("Loading textures...");
log.info("Loading sounds...");
log.popIndent();
log.success("Assets loaded!");

// Listen to log events
log.onInfo(this, (value, pos) -> {
    // Custom handling of info messages
    saveToLogFile(value, pos);
});

Compile-time flags:

• ceramic_mute_logs: Disables all console output (events still fire)
• ceramic_no_log: Completely removes logging code (no output, no events)
• ceramic_unity_no_log: Disables Unity-specific console output

Instance Members #

Logs a debug message with magenta/[debug] formatting.

Debug messages are intended for development and diagnostic information that helps understand program flow and state during development. These messages are typically filtered out in production builds.

Thread-safe: Can be called from background threads.

Logs an informational message with cyan/[info] formatting.

Info messages communicate general application state and progress. Use for non-critical information that helps understand what the application is doing during normal operation.

Thread-safe: Can be called from background threads.

Logs a success message with lime/[success] formatting.

Success messages indicate successful completion of operations. Use to confirm that important actions completed without errors, such as asset loading, save operations, or network requests.

Thread-safe: Can be called from background threads.

Logs a warning message with yellow/[warning] formatting.

Warning messages indicate potential issues that don't prevent operation but may cause problems. Uses native console.warn() on web platforms for proper browser dev tools integration.

Thread-safe: Can be called from background threads.

Logs an error message with red/[error] formatting.

Error messages indicate failures that may affect application behavior. Uses native console.error() on web platforms for proper browser dev tools integration with stack traces.

Thread-safe: Can be called from background threads.

Increases the indentation level for subsequent log messages.

Each call adds 4 spaces to the beginning of log messages, creating a visual hierarchy in the output. Useful for logging nested operations or sub-tasks.

Must be balanced with popIndent() calls.

Example:

logger.info("Processing items...");
logger.pushIndent();
for (item in items) {
    logger.info("Processing: " + item.name);
}
logger.popIndent();
logger.success("Done!");

Decreases the indentation level for subsequent log messages.

Removes 4 spaces from the indentation prefix. Should be called to balance each pushIndent() call.

Creates a new Logger instance. Configures platform-specific trace handlers on first initialization.

Private Members #

Current indentation prefix for hierarchical logging. Each level adds 4 spaces to create visual hierarchy in log output.

Emitted when an info message is logged.

Emitted when a debug message is logged.

Emitted when a success message is logged.

Emitted when a warning message is logged.

Emitted when an error message is logged.

Adds prefix and indentation to each line of the input. Used internally to format multi-line log messages with proper category prefixes and indentation.

Metadata #