Logging

api.zig includes a cross-platform colorful logging system that works on Windows, Linux, and macOS.

LogConfig Options

Option	Type	Default	Description
level	LogLevel	.info	Minimum log level
colors	bool	true	Enable ANSI colors
timestamps	bool	false	Include timestamps
show_source	bool	false	Show source location
format	enum	.simple	Output format
output	enum	.stderr	Output destination
include_thread_id	bool	false	Show thread ID

Log Levels

Level	Color	Value	Description
.debug	Cyan	0	Detailed debugging information
.info	Green	1	General information messages
.warn	Yellow	2	Warning messages
.err	Red	3	Error messages

Using the Logger

Create a Logger

const logger = try api.Logger.init(allocator);
defer logger.deinit();

Log Messages

try logger.debug("Debug message", null);
try logger.info("Server started", null);
try logger.warn("Connection timeout", null);
try logger.err("Failed to process request", null);
try logger.success("Application ready!");

Formatted Messages

try logger.debugf("Value: {d}", .{42}, null);
try logger.infof("Server started on port {d}", .{port}, null);
try logger.warnf("Connection timeout: {s}", .{address}, null);
try logger.errf("Failed to process request: {}", .{error}, null);

Log Level Filtering

Messages below the minimum level are ignored:

const logger = try api.Logger.init(allocator);

// Only logs info and above (info, warn, err)
logger.setLevel(.info);

try logger.debug("This won't appear", null);  // Filtered out
try logger.info("This will appear", null);     // Logged

Change Level at Runtime

var logger = try api.Logger.init(allocator);

// Enable debug logging
logger.setLevel(.debug);

// Back to info
logger.setLevel(.info);

Formatting Options

Disable Colors

var logger = try api.Logger.init(allocator);
logger.setColors(false);  // No ANSI colors

Cross-Platform Support

api.zig automatically enables ANSI color support on all platforms:

Platform	Support
Windows cmd	Virtual Terminal Processing
Windows PowerShell	Virtual Terminal Processing
VS Code Terminal	Native support
Linux	Native ANSI support
macOS	Native ANSI support

Output Format

Default colored output format:

[OK] Server started
[INFO] GET /users
[INFO] POST /users
[WARN] High memory usage detected
[ERROR] Database connection failed
[DEBUG] Request body: {...}

Access Logging

Enable access logging in server config:

try app.run(.{
    .port = 8000,
    .enable_access_log = true,  // Enable access logging (default: true)
});

Output:

[INFO] GET /users
[INFO] POST /users
[INFO] GET /users/123
[INFO] DELETE /users/123

Disable Logging

try app.run(.{
    .port = 8000,
    .enable_access_log = false,  // Disable request logging
});

Print Version Info

api.report.printVersionInfo();
// api.zig v0.0.1
// Repository: https://github.com/muhammad-fiaz/api.zig
// Docs: https://muhammad-fiaz.github.io/api.zig/

Example: Request Logging

fn loggedHandler(ctx: *api.Context) api.Response {
    ctx.logger.infof("Processing {s} {s}", .{
        ctx.method().toString(),
        ctx.path(),
    }, null) catch {};

    const response = api.Response.text("ok");

    ctx.logger.infof("Response: {d}", .{
        response.status.toInt(),
    }, null) catch {};

    return response;
}

Example: Standalone Logger

const std = @import("std");
const api = @import("api");

pub fn main() !void {
    var gpa = std.heap.GeneralPurposeAllocator(.{}){};
    defer _ = gpa.deinit();

    const logger = try api.Logger.init(gpa.allocator());
    defer logger.deinit();

    try logger.success("Application started");
    try logger.info("Initializing components...", null);
    try logger.infof("Listening on port {d}", .{8000}, null);
}