A dead simple logger module for Node.js. Provides console and file-based logging with support for log rotation, custom formatting, colored output, and robust error handling.
- π₯ Console and file logging
- π Log rotation with delete/archive strategies
- π§© Customizable log formatting
- π Colored log levels in console
- π§± Handles undefined/non-serializable messages
- π§ TypeScript type definitions included
- π ESM + CommonJS support
npm install deadslog
# or
bun add deadslogconst deadslog = require("deadslog");
const logger = deadslog();
logger.info("Hello, world!");import deadslog from "deadslog";
const logger = deadslog();
logger.info("Hello, world!");const logger = deadslog({
formatter: (level, message) => {
const timestamp = new Date().toLocaleString();
return `---\nTime: ${timestamp}\nLevel: ${level}\nMessage: ${message}\n---`;
},
});
logger.info("Custom formatted log!");const logger = deadslog({
fileOutput: {
enabled: true,
logFilePath: "./logs/app.log",
rotate: true,
maxLogSize: 1024 * 1024, // 1MB
maxLogFiles: 3,
onMaxLogFilesReached: "archiveOld", // or "deleteOld"
},
});
logger.info("This will be written to a file!");For file output, deadslog escapes real newline characters (\n / \r\n) into the two-character sequence \\n so that each log call produces exactly one physical line in the log file (better for rotation, grep, CSV/JSONL parsing, and log shippers).
Console output is unchanged and will display multiline stack traces.
Returns a logger instance.
| Option | Type | Description |
|---|---|---|
consoleOutput.enabled |
boolean |
Enable console logging (default: true) |
consoleOutput.coloredCoding |
boolean |
Enable colored output using yoctocolors (default: true) |
fileOutput.enabled |
boolean |
Enable file logging (default: false) |
fileOutput.logFilePath |
string |
File path for log output (required if fileOutput.enabled is true) |
fileOutput.rotate |
boolean |
Enable automatic log file rotation (default: false) |
fileOutput.maxLogSize |
number |
Maximum log file size in bytes before rotation (required if fileOutput.rotate is true) |
fileOutput.maxLogFiles |
number |
Number of rotated files to keep (required if fileOutput.rotate is true) |
fileOutput.onMaxLogFilesReached |
string |
Rotation strategy: "deleteOld" or "archiveOld" (required if fileOutput.rotate is true) |
fileOutput.maxQueueSize |
number |
Maximum number of queued file writes before queue-full strategy applies (default: 100000) |
fileOutput.onQueueFull |
string |
Queue-full strategy: "drop" (default) or "block" |
fileOutput.queueFullTimeoutMs |
number |
Max time (ms) to wait for queue space when onQueueFull: "block" (default: 5000) |
formatter |
function |
Optional custom formatter for log messages |
minLevel |
string |
Minimum log level: trace, debug, info, success, warn, error, fatal (default: info) |
filters.include |
string |
RegExp string; if provided, only matching formatted lines are logged |
filters.exclude |
string |
RegExp string; if provided, matching formatted lines are skipped |
trace(msg)debug(msg)info(msg)success(msg)warn(msg)error(msg)fatal(msg)flush()destroy()
Type definitions are included and will be picked up automatically.
const simpleFormatter = (level, message) => {
const timestamp = new Date().toISOString();
return `[${timestamp}] [${level}] ${message}`;
};[2025-05-03T13:45:21.123Z] [INFO] Application startedconst multilineFormatter = (level, message) => {
const timestamp = new Date().toLocaleString();
return `---\nTime: ${timestamp}\nLevel: ${level}\nMessage: ${message}\n---`;
};---
Time: 5/3/2025, 1:46:11 PM
Level: DEBUG
Message: Connected to database
---const csvFormatter = (level, message) => {
const timestamp = new Date().toISOString();
const escaped = message.replace(/\r?\n/g, "\\n").replace(/"/g, '""');
return `"${timestamp}","${level}","${escaped}"`;
};"2025-05-03T13:47:02.789Z","ERROR","Failed to load module: ""auth.js"""const emojiFormatter = (level, message) => {
const emojis = {
TRACE: 'π',
DEBUG: 'π',
INFO: 'βΉοΈ',
SUCCESS: 'β
',
WARN: 'β οΈ',
ERROR: 'β',
FATAL: 'π'
};
const timestamp = new Date().toISOString();
return `${emojis[level] || ''} [${timestamp}] ${level}: ${message}`;
};β
[2025-05-03T13:48:15.456Z] SUCCESS: Task completedconst jsonlFormatter = (level, message) => {
return JSON.stringify({
ts: Date.now(),
level,
message
});
};{"ts":1714740493123,"level":"INFO","message":"Something happened"}deadslog is a small, console-friendly logger for Node.js that focuses on robust file logging without the complexity of a full logging framework.
It keeps the ergonomics of console.log(...args) (variadic arguments, readable output, optional colored levels), but adds production-minded behavior that many lightweight loggers skip:
- Durable shutdown:
flush()/destroy()wait for in-flight logs, queued writes, and rotations to finish. - File rotation: rotate by size and keep a configurable number of files, with either delete old or gzip archive strategies.
- Backpressure control: choose whether a full write queue should drop logs (and track it) or block with a timeout.
- Simple formatting by default, with a custom formatter hook when you want full control.
If you need high-throughput structured JSON logging and an ecosystem of transports/bindings, youβll likely want something like Pino or Winston. If you want a dead-simple API with reliable console + file logging, deadslog is built for that.
- Logging payloads are now built from variadic arguments in the exact order supplied (console-like behavior).
- The logger now stringifies non-string payload parts more readably, including:
undefinedβ"undefined"BigIntvalues β string form withnsuffix (e.g.1n)- circular references β
"[Circular Reference]" - non-serializable objects β
"[Non-serializable]"
defaultFormatternow treats the incomingmessageas a pre-built string payload (stringification happens during payload building).- File output now escapes newline characters (
\n/\r\n) as\\nto ensure one log entry per line (console output remains multiline for stack traces).
See CHANGELOG.md for previous versions and more details.
MIT