LogTape changelog

Version 1.0.0

To be released.

Added getLogLevels() function to retrieve all available log levels.
Added LogMethod type for better type inference of logger methods.
Added nonBlocking option to getConsoleSink(), getStreamSink(), getFileSink(), and getRotatingFileSink() for high-performance logging scenarios. When enabled, log records are buffered and flushed in the background, preventing blocking of the main thread.
- Console and stream sinks accept nonBlocking?: boolean | { bufferSize?: number; flushInterval?: number } option.
- File sinks accept nonBlocking?: boolean option.
- Default buffer size is 100 records for console/stream sinks and background flushing for file sinks.
- Default flush interval is 100ms for console/stream sinks.
- Console sink returns Sink & Disposable in non-blocking mode.
- Stream and file sinks return Sink & AsyncDisposable in non-blocking mode.
- Buffer-full flushes are now asynchronous (non-blocking) instead of synchronous to maintain performance during high-volume logging.
- Console and stream sinks include automatic buffer overflow protection that prevents unbounded memory growth by dropping oldest records when buffer exceeds 2x the configured size.
- Errors during background flushing are silently ignored to prevent application disruption.
Added getStreamFileSink() function in @logtape/file package for high-performance file logging using Node.js PassThrough streams.
- Added StreamFileSinkOptions interface for configuring stream-based file sink behavior.
- Uses PassThrough streams piped to WriteStreams for optimal I/O performance with automatic backpressure management and non-blocking writes.
- Optimized for high-volume logging scenarios with superior throughput compared to standard file sinks.
- Simple configuration with highWaterMark (default: 16384 bytes) and optional custom formatter options.
- Automatic stream cleanup and proper resource disposal via Disposable interface.
- Ideal for production applications requiring high-performance file logging without complex buffering configuration.
Added withBuffer() function to create buffered sinks that collect log records in memory and flush them to the underlying sink when the buffer is full or after a specified time interval.
- Added BufferSinkOptions interface for configuring buffer behavior.
- withBuffer() accepts bufferSize (default: 10 records) and flushInterval (default: 5000ms) options.
- Buffered sinks automatically flush when buffer is full, time interval elapses, or the sink is disposed.
- Returns a sink with AsyncDisposable support for proper cleanup.
Added fromAsyncSink() function to convert async sinks to regular sinks with proper async handling.
- Added AsyncSink type: (record: LogRecord) => Promise<void>.
- fromAsyncSink() chains async operations to ensure order preservation.
- Errors in async sinks are caught to prevent breaking the promise chain.
- Returns a sink with AsyncDisposable support that waits for all pending operations on disposal.
Added @logtape/cloudwatch-logs package for AWS CloudWatch Logs integration. [#48, #49]
- Added getCloudWatchLogsSink() function to send logs to AWS CloudWatch Logs.
- Added CloudWatchLogsSinkOptions interface for configuration.
- Supports intelligent batching up to 10,000 events or 1MiB per batch.
- Includes exponential backoff retry strategy for error handling.
- Works with existing CloudWatch Logs clients or creates new ones automatically.
- Supports custom AWS credentials and regions.
- Added formatter option to support custom text formatters, including jsonLinesFormatter() for enhanced CloudWatch Logs Insights querying capabilities with dot notation support.
Added @logtape/windows-eventlog package for Windows Event Log integration. [#47, #50]
- Added getWindowsEventLogSink() function to send logs to Windows Event Log.
- Added WindowsEventLogSinkOptions interface for configuration.
- Cross-runtime support: Works with Deno, Node.js, and Bun on Windows.
- Uses runtime-optimized FFI implementations: Deno FFI, koffi for Node.js, and Bun FFI for maximum performance.
- Supports all LogTape log levels with proper Event Log type mapping (Error, Warning, Information).
- Includes structured logging support with formatted context information.
- Added validateWindowsPlatform() function for platform validation.
- Added WindowsPlatformError and WindowsEventLogError for proper error handling.
- Platform-restricted installation (Windows only) for safety.
- Includes PowerShell-based test verification for actual Event Log integration.
Added @logtape/pretty package for beautiful console formatting designed for local development. [#46, #51]
- Added getPrettyFormatter() function to create visually appealing log formatters with colorful icons, smart category truncation, and perfect column alignment.
- Added prettyFormatter constant for quick setup with sensible defaults.
- Added PrettyFormatterOptions interface for extensive customization.
- Features Signale-inspired design with emojis for each log level: 🔍 trace, 🐛 debug, ✨ info, ⚠️ warning, ❌ error, 💀 fatal.
- Includes smart category truncation that preserves important context while maintaining layout (e.g., app·server…middleware).
- Supports true color terminals with rich color schemes and dimmed text for enhanced readability.
- Provides optional timestamp display, custom icons, color control, and flexible layout options.
- Supports multiple text styles combination (e.g., ["bold", "underline"]) for level, category, message, and timestamp formatting.
- Includes word wrapping feature with proper indentation alignment to maintain visual consistency for long messages.
- Optimized for development environments with focus on visual clarity and developer experience.
Added @logtape/adaptor-pino package for integrating LogTape with Pino logging infrastructure. [#52]
- Added getPinoSink() function to forward LogTape log records to Pino loggers.
- Added PinoSinkOptions interface for configuring the adapter behavior.
- Added CategoryOptions interface for customizing category formatting in Pino log messages.
- Added install() function for convenient auto-configuration with custom Pino logger and configuration options.
- Supports configurable category display with position (start/end), decorators ([], (), <>, {}, :, -, |, /, or none), and custom separators for multi-part categories.
- Maps LogTape log levels to equivalent Pino levels.
- Preserves LogTape's structured logging properties as Pino fields.
- Enables seamless adoption of LogTape-enabled libraries in applications using Pino without requiring logging infrastructure changes.
Added @logtape/adaptor-winston package for integrating LogTape with winston logging infrastructure. [#52]
- Added getWinstonSink() function to forward LogTape log records to winston loggers.
- Added WinstonSinkOptions interface for configuring the adapter behavior.
- Added CategoryOptions interface for customizing category formatting in winston log messages.
- Added install() function for convenient auto-configuration with optional custom winston logger and configuration options.
- Added install.ts module for automatic setup via simple import.
- Supports configurable category display with position (start/end), decorators ([], (), <>, {}, :, -, |, /, or none), and custom separators for multi-part categories.
- Maps LogTape log levels to equivalent winston levels with customizable level mapping.
- Supports custom value formatters for interpolated values in log messages.
- Preserves LogTape's structured logging properties as winston fields.
- Enables seamless adoption of LogTape-enabled libraries in applications using winston without requiring logging infrastructure changes.
Fixed browser support for @logtape/otel package by removing direct node:process dependency. [#53]
- Replaced node:process import with cross-runtime environment variable access that works in Deno, Node.js, and browsers.
- Changed tsdown platform setting from "node" to "neutral" to enable browser compatibility.
- The getOpenTelemetrySink() function now works in all JavaScript runtimes without throwing module resolution errors.
Removed the deprecated LoggerConfig.level property. Use LoggerConfig.lowestLevel instead for setting the minimum log level, or use LoggerConfig.filters for more advanced filtering.

Version 0.12.1

Released on June 19, 2025.

Fixed module resolution issues in CommonJS environments and bundlers like Vite by properly configuring conditional exports for types.
- Updated all package.json exports to use conditional types exports with separate .d.ts files for ESM imports and .d.cts files for CommonJS requires.
- This resolves runtime errors in frameworks like SvelteKit that require proper CommonJS modules for modules imported in CommonJS contexts.

Version 0.12.0

Released on June 15, 2025.

Added the "trace" severity level, which is lower than "debug". [#24]
- Added "trace" to the LogLevel union type.
- Added Logger.trace() method.
Added Logger.warning() method which is an alias for Logger.warn(). [#44]
Added bufferSize and flushInterval options to FileSinkOptions for configurable buffering in file sinks.
- getFileSink() and getRotatingFileSink() functions now accept a bufferSize option to control write buffering behavior.
- getFileSink() and getRotatingFileSink() functions now accept a flushInterval option to control the time-based flushing of the buffer to disk.
- When bufferSize is 0 or negative, writes are immediate without buffering.
- When bufferSize is positive, log entries are buffered until the buffer size is exceeded, then flushed to disk.
- Default buffer size is 8192 characters for improved performance.
- Buffer content is automatically flushed when the sink is disposed.
- When flushInterval is 0 or negative, the time-based flushing is disabled.
- Default flushInterval is 5000 milliseconds (5 seconds) for periodic flushing.
Added @logtape/syslog package for sending log messages to syslog servers using RFC 5424 format.
- Added getSyslogSink() function to create syslog sinks with support for both UDP and TCP protocols.
- Supports all standard RFC 5424 facilities (kern, user, mail, daemon, local0–7, etc.) and automatic priority calculation.
- Includes structured data support for log record properties with proper RFC 5424 escaping of special characters.
- Cross-runtime compatibility with Deno, Node.js, and Bun.
- Configurable connection timeouts, custom hostnames, and application names.
Now @logtape/otel, @logtape/sentry, and @logtape/syslog packages are released along with @logtape/logtape package. This means they share the same version number and changelog. This is to ensure that the packages are always compatible with each other and to simplify the release process.
Improved build and test infrastructure by migrating from dnt to tsdown for npm package bundling. [#43]

Version 0.11.0

Released on June 2, 2025.

Loggers now allow to interpolate all properties at once through the special placeholder {*}. This is useful for logging objects with many properties without having to specify each property name in the message template.
- Logger.debug(), Logger.info(), Logger.warn(), Logger.error(), and Logger.fatal() methods now accept a message template with the {*} placeholder. Unless there is a property with the name *, the {*} placeholder will be replaced with a stringified version of the LogRecord.properties object.
- As a shorthand, overloads of Logger.debug(), Logger.info(), Logger.warn(), Logger.error(), and Logger.fatal() methods that accept an object as the first argument now treat the object as a message template with the {*} placeholder. This is equivalent to calling the method with a message template of {*} and the object as the second argument.
Added the built-in JSON Lines formatter.
- Added jsonLinesFormatter() function.
- Added getJsonLinesFormatter() function.
- Added JsonLinesFormatterOptions interface.

Version 0.10.0

Released on May 19, 2025.

Added @logtape/redaction package for redacting sensitive information from log records.
- Added redactByField() function.
- Added FieldPattern type.
- Added FieldPatterns type.
- Added FieldRedactionOptions interface.
- Added DEFAULT_REDACT_FIELDS constant.
- Added redactByPattern() function.
- Added RedactionPattern interface.
- Added RedactionPatterns type.
- Added CREDIT_CARD_NUMBER_PATTERN constant.
- Added EMAIL_ADDRESS_PATTERN constant.
- Added JWT_PATTERN constant.
- Added KR_RRN_PATTERN constant.
- Added US_SSN_PATTERN constant.
The text formatter now can omit the timestamp from the formatted message. [#35 by Ooker]
- Changed the type of the TextFormatterOptions.timestamp option to "date-time-timezone" | "date-time-tz" | "date-time" | "time-timezone" | "time-tz" | "time" | "date" | "rfc3339" | "none" | "disabled" | ((ts: number) => string | null) (was "date-time-timezone" | "date-time-tz" | "date-time" | "time-timezone" | "time-tz" | "time" | "date" | "rfc3339" | ((ts: number) => string)).
- Changed the type of the FormattedValues.timestamp property to string | null (was string).
Added FileSinkOptions.lazy option. [#38, #39 by Rickey Ward]
The configure() and configureSync() functions now check for duplicate logger configurations with the same category and throw a ConfigError when detected. This prevents unintended overriding of logger configurations when configuring multiple loggers with the same category. [#41]

Version 0.9.2

Released on May 15, 2025.

Fixed a bug where importing @logtape/logtape threw a ReferenceError on Node.js or Bun when LogTape was installed from JSR (instead of npm). [#42]

Version 0.9.1

Released on April 24, 2025.

Fixed a CORS error when using LogTape in web browser environments like Fresh islands components due to importing Node.js node:util module. [#40]

Version 0.9.0

Released on March 1, 2025.

Moved file sinks and rotating file sinks to separate packages. [#19, #27, #28]
- Moved getFileSink() function to @logtape/file package.
- Moved FileSinkOptions interface to @logtape/file package.
- Moved getRotatingFileSink() function to @logtape/file package.
- Moved RotatingFileSinkOptions interface to @logtape/file package.
Added synchronous versions of configuration functions. [#12, #29 by Murph Murphy]
- Added configureSync() function.
- Added disposeSync() function.
- Added resetSync() function.
Added ConsoleSinkOptions.levelMap option.

Version 0.8.2

Released on February 11, 2025.

Fixed a bug of text formatters where they truncated string and array values in the formatted message. [#30]

Version 0.8.1

Released on February 1, 2025.

Fixed a bug where when a child logger is configured with a lower lowestLevel than its parent logger, a log record with a severity level lower than the parent logger's lowestLevel and higher than the child logger's lowestLevel would not be filtered out by the parent logger.

Version 0.8.0

Released on November 20, 2024.

Renewed the API to configure the lowest severity level of loggers. [#26]
- Added LoggerConfig.lowestLevel property.
- Deprecated LoggerConfig.level property in favor of LoggerConfig.lowestLevel.
Added compareLogLevel() function.

Version 0.7.2

Released on February 11, 2025.

Fixed a bug of text formatters where they truncated string and array values in the formatted message. [#30]

Version 0.7.1

Released on October 30, 2024.

The withContext() function no more throws an error even if no contextLocalStorage is configured. Instead, it will log a warning message to the ["logtape", "meta"] logger.

Version 0.7.0

Released on October 29, 2024.

Introduced implicit contexts.
- Added withContext() function.
- Added Config.contextLocalStorage option.
- Added ContextLocalStorage interface.

Version 0.6.5

Released on February 11, 2025.

Fixed a bug of text formatters where they truncated string and array values in the formatted message. [#30]

Version 0.6.4

Released on October 28, 2024.

Fixed a build warning due to importing node:fs and node:util modules on Next.js' client rendering. [#19]
Made it to work on Deno 2.0.0 or higher.