logd 0.7.1
logd: ^0.7.1 copied to clipboard
Modular hierarchical logging for Dart and Flutter. Features modular pipeline processing, O(1) configuration resolution, and low‑overhead performance.
Changelog #
0.7.1: The Flutter Visibility Fix (Critical Patch) #
This patch addresses a critical visibility issue where logs were invisible in Flutter IDE consoles (VS Code, Android Studio) due to ConsoleSink relying exclusively on stdout.
-
Critical Fixes & Visibility #
- Automatic Print Delegation: Enhanced
ConsoleSinkto automatically switch its output mechanism toprint()when running in a Flutter environment (dart.library.ui) or in non-terminal environments (standard for IDE consoles). - Environment Awareness: Improved
AutoConsoleEncoderandConsoleSinkto gracefully handle environments whereio.stdoutis unavailable or restricted. - Manual Override: Added
usePrintparameter toConsoleSinkfor explicit control over output delegation.
- Automatic Print Delegation: Enhanced
-
Architectural Refinement #
- PrintSink Identification: Introduced
PrintSinkas a dedicated, byte-to-string bridge forprint()-based output. - API Surface Protection: Marked
PrintSinkas@internal, ensuring the public API remains clean while providing robust internal delegation forConsoleSink.
- PrintSink Identification: Introduced
0.7.0: [RETRACTED] The Architectural Inversion & Performance Milestone #
Caution
REVISION NOTICE: v0.7.0 was retracted shortly after release due to a critical regression where logs were invisible in Flutter IDE consoles. Users are strongly advised to upgrade to v0.7.1.
This milestone represents a complete overhaul of the logd logging pipeline, transitioning from a string-centric model to a zero-allocation, byte-oriented, and semantic-IR-driven architecture. It consolidates all development phases originally intended for 0.6.5.
Warning
Breaking Changes & Architectural Inversion
- SDK Requirements:
logd0.7.0+ now requires Dart 3.6.0+ to support monorepo workspace configurations and modern language features. - Structural Reorganization: Internal handler components relocated to domain-specific sub-modules:
document/(Semantic IR),layout/(Physical Rendering),engine/(Orchestration), anddecorator/(Transformation). Direct imports of internal files will break. - Pipeline Factory Transition: The legacy
LogNodeFactoryhas been replaced by the unifiedLogPipelineFactory. All custom formatters and sinks must update their signatures to accommodate the new factory type. - LogContext Removal: The
LogContextclass and its parameters have been removed from the entire pipeline (format,decorate,output). Metadata is now handled viaLogLineandLogDocumentIR. - Width Authority Inversion: The
lineLengthconstraint now originates fromLogSink(e.g.,ConsoleSink,FileSink), allowing handlers to be completely width-agnostic. - Engine Orchestration: The
Handlerno longer manages the processing lifecycle directly; it delegates execution to an exchangeableLogEngine. Low-level handler overrides require migration. - Encapsulation: Marked
Handler.logandLogEntryconstructor as@internalto prevent direct manipulation of the internal pipeline. - HTML Encoder: The legacy
HtmlFormatterhas been removed. All HTML generation is now handled by the high-fidelityHtmlEncoder, which can be paired with any standard formatter (e.g.,StructuredFormatter,JsonFormatter) to produce GFM reports. - Markdown Inversion: The legacy
MarkdownFormatterhas been removed. All Markdown generation is now handled by the high-fidelityMarkdownEncoder, which can be paired with any standard formatter (e.g.,StructuredFormatter,JsonFormatter) to produce GFM reports.
-
Handler Module & Execution Engines #
- Modular Architecture: Relocated the handler internal suite into domain-specific modules:
document/(Semantic IR),layout/(Physical Rendering),engine/(Orchestration), anddecorator/(Transformation). - Execution Engine Abstraction: Extracted the core logging lifecycle from
Handlerinto theLogEngineinterface. Users can now choose betweenStandardEngine(heap allocation) andArenaEngine(zero-allocation LIFO pooling) viaHandler.configure(). - Resource Pooling (Arena): Introduced
Arenaas an isolate-local object pool forLogDocumentand all node types, eliminating GC pressure in high-throughput steady-state logging. - Unified Resource Management: Introduced
LogPipelineFactoryas the sole authority for allocating IR nodes, allowing engines to swap allocation strategies without modifying formatter logic.
- Modular Architecture: Relocated the handler internal suite into domain-specific modules:
-
Byte-Oriented Pipeline & Serialization Inversion #
- Zero-Churn Serialization: Refactored the entire encoding pipeline (
Ansi,Json,Toon,Html) to write directly to sharedUint8Listbuffers, drastically reducing temporary string churn. - Buffer Recycling: Introduced
HandlerContextto manage pooled byte buffers, enabling zero-allocation buffer acquisition during steady-state logging when combined withArenaEngine. - Sink Modernization: Standardized
LogSinkto operate on byte streams. OptimizedConsoleSinkandFileSinkfor direct byte output tostdout. - FastStringWriter: Added high-performance byte-constant utility for pre-encoded ANSI and structural tokens.
- Zero-Churn Serialization: Refactored the entire encoding pipeline (
-
Semantic Layout & Geometric Rendering #
- Deep Semantic IR: Completely decoupled visual intent from physical serialization. Formatters now emit a pure semantic tree (
LogDocument), which is then processed by the geometric layout engine. - TerminalLayout Authority: Centralized all physical wrapping, TAB-stop calculation, and ANSI segment slicing within the
TerminalLayoutengine. - High-Fidelity HTML Pipeline: A full Implementation of the semantic rendering pipeline for browsers, providing high-fidelity visual parity with terminal output.
- ANSI Resilience: Improved width calculation accuracy for complex ANSI sequences and double-width characters.
- Deep Semantic IR: Completely decoupled visual intent from physical serialization. Formatters now emit a pure semantic tree (
-
Performance, Benchmarking & Infrastructure #
- Monorepo Migration: Converted the project into a structured monorepo using Dart workspaces, separating core logic from benchmarks and examples.
- Performance Ledger: Introduced a centralized ledger in
packages/benchmarks/records/README.mdfor tracking architectural performance milestones, including the Milestone 11 Arena vs Standard comparison showing up to 49% throughput gains. - AOT Stress Test Suite: Developed a high-throughput validation suite (
stress_test.dart) for baseline performance monitoring. - Bitmask Optimizations: Leveraged
intbitmasks forLogTaghandling, significantly reducing overhead in hot path processing. - Agentic Development: Integrated specialized
.agentsworkflows and development rules to standardize AI-assisted coding and architectural integrity across the monorepo.
-
Specialized Formats & Inspection #
- GFM Markdown Pipeline: Introduced
MarkdownEncoderwith comprehensive mapping for allLogNodetypes.- Header Flattening: Consolidates multiple semantic headers (Timestamp, Level, Logger) into a single, elegant
###line with•separators. - Aesthetic Refinement: Optimized vertical whitespace, high-fidelity GFM alerts for errors, and thematic separators (
---) for professional report generation. - Collapsible Detail Blocks: Supports
<details>sections for stack traces and complex payloads.
- Header Flattening: Consolidates multiple semantic headers (Timestamp, Level, Logger) into a single, elegant
- TOON Hierarchy: Introduced Token-Oriented Object Notation (TOON), integrated in both flat-row (
ToonFormatter) and recursive (ToonPrettyFormatter) variants for LLM efficiency. - Intelligent JSON Inspection:
JsonPrettyFormatternow features recursive detection and pretty-printing of stringified JSON objects nested within lines. - Advanced Layout Features: Added adaptive stacking (threshold-driven wrapping), composite compaction for maps/lists, and structural safety guards (
maxDepth).
- GFM Markdown Pipeline: Introduced
0.6.4: LogBuffer Enhancements & Project-Wide Refactor #
-
LogBuffer Enhancement & Safety #
- Error/StackTrace Support: Added ability to capture
errorandstackTracewithinLogBufferfor more robust multi-line error reporting. - Deterministic Sinking: Changed default behavior to
autoSink: falseinLogger.infoBufferand related utilities to encourage explicit lifecycle management. - Leak Traceability:
LogBuffernow captures and reports the creation stack trace when a buffer is leaked (abandoned without sinking), facilitating rapid debugging of resource leaks.
- Error/StackTrace Support: Added ability to capture
0.6.3: Optimized Stack Trace Parsing & Logger Robustness #
-
Optimizations #
- Single-Pass Parsing: Introduced a unified
StackTraceParser.parsemethod that extracts both the caller and required stack frames in a single pass, eliminating redundant processing. - Regex Caching: Implemented class-level caching for stack frame regular expressions to minimize compilation overhead.
- Single-Pass Parsing: Introduced a unified
-
Robustness & Validation #
- Configuration Guards: Added strict input validation to
Logger.configure, rejecting negative stack counts and empty handler lists with clear error messages. - Inheritance Efficiency: Optimized
freezeInheritanceto track actual state changes, skipping expensive cache invalidations when descendant configurations are already fully defined. - Null Message Stability: Standardized behavior for
nulllog messages (converted to empty string) and explicitly documented this behavior in the API.
- Configuration Guards: Added strict input validation to
-
Refactoring & Quality #
- Module Reorganization: Refined the
stack_tracemodule structure, movingStackFrameSetto a dedicated file and standardizing the parsing API. - Documentation Refresh: Comprehensively updated roadmap, architecture, and philosophy documents to align with the latest performance and structural improvements.
- Module Reorganization: Refined the
0.6.2: Resilient Network Logging & Timezone Standardization #
-
Features #
- Network Sinks: Introduced
HttpSinkandSocketSinkfor robust remote logging.- Supports configurable retries, batching, and timeout handling.
- Compatible with all standard formatters (JSON, semantic formatters).
- Includes
SocketSinkfor TCP/UDP logging (experimental/advanced usage).
- Network Sinks: Introduced
-
Robustness & Standardization #
- Timezone Engine Overhaul: Replaced the custom timezone implementation with the industry-standard
package:timezone.- Standard Integration: Leverages the official IANA Time Zone Database via
package:timezone. - Robust Caching: Implemented a caching layer for
Timezone.localandTimezone.namedto eliminate expensive database lookups on every log call. - Web Support: Fixed compilation issues on Web platforms (
clock_web.dart).
- Standard Integration: Leverages the official IANA Time Zone Database via
- Timezone Initialization: Added
Timezone.ensureInitialized()for explicit control over timezone database loading.
- Timezone Engine Overhaul: Replaced the custom timezone implementation with the industry-standard
-
Fixes #
- Timezone Resolution: Fixed an issue where
timezonefetching could fail or produce repetitive error logs on iOS devices. - Web Platform: Resolved a
MissingPluginExceptionand compilation errors related toclock_web.dart.
- Timezone Resolution: Fixed an issue where
0.6.1: Unified Formatter Configuration & Layout Stability #
Breaking Changes #
- Removed
BoxFormatter: Finalized the removal of the deprecatedBoxFormatterin favor of the more flexibleStructuredFormatter+BoxDecoratorcomposition. LogMetadataTransition: Replaced theLogFieldenum with a more focusedLogMetadataenum (timestamp,logger,origin).- Internal API Shields: Marked
Handler.logand theLogEntryconstructor as@internalto protect the internal data model while promoting the high-levelLoggerAPI.
Enhancements & Features #
- Unified Formatter API: All formatters now accept a
Set<LogMetadata>in their constructors, providing a consistent interface for controlling contextual data output while preserving core content (message,level,error). - Introducing
SuffixDecorator: A new decorator for appending text to log lines, featuring an aligned mode to right-justify suffixes against the terminal or box edge. - Intelligent JSON Inspection:
JsonPrettyFormatternow features recursive detection and pretty-printing of stringified JSON objects nested within messages. - Markdown Redesign:
MarkdownFormatternow produces high-fidelity output with a single h1 heading, blockquotes for messages, and collapsible (<details>) sections for stack traces. - Toon & Plain Enhancements:
ToonFormatter: Now supports multiline content and separate metadata/field streams.PlainFormatter: Reworked with a flow-based layout that correctly wraps long messages and errors containing metadata.
- Styled Decorators:
PrefixDecoratorandHierarchyDepthPrefixDecoratornow support applying aLogStylefor high-fidelity semantic coloring.
Layout & Architecture #
- Centralized Layout Logic: Text wrapping is now handled implicitly by the
Handlerpipeline, ensuring structural decorators likeBoxDecoratornever receive overflowing lines. - Decorator
paddingWidth: Decorators can now declare their visual footprint, allowing theHandlerto calculate precisely how much space is available for the primary log content. - Expanded
LogContext: AddedtotalWidthandcontentLimitproperties to provide decorators with definitive spatial constraints for precise alignment. - Dynamic Hierarchy Depth:
LogEntrynow computes itshierarchyDepthdynamically from theloggerName, guaranteeing that visual indentation always reflects the actual logger tree.
Stability & Fixes #
- Robust ANSI Utilities: Significant improvements to
visibleLength(including tab expansion) and a newwrapWithDatautility that preserves semantic segments across line breaks. - Pure-Dart Compatibility: Eliminated leaked
package:flutter_testdependencies from the core library. - Layout Artifact Removal: Fixed redundant ANSI reset sequences that caused "phantom" empty lines in narrow terminal widths.
0.6.0: LLM-Optimized Logging & Shared Data Model #
Breaking Changes #
- Styling Engine Overhaul: Replaced the terminal-bound
AnsiColorConfigandAnsiColorSchemewith a platform-agnosticLogThemesystem. Visual intent is now decoupled from platform representation. - Unified Formatter API: Standardized metadata extraction via the
LogFieldenum.- Removed: Individual boolean flags (e.g.,
showLevel,includeTime) inJsonFormatterandToonFormatter. - Note: Customizable field support for legacy formatters is planned for future versions.
- Removed: Individual boolean flags (e.g.,
- Strict Logger Naming: Enforced deterministic hierarchy traversal via name validation (regex:
^[a-z0-9_]+(\.[a-z0-9_]+)*$) and automatic normalization to lowercase. This prevents "Ghost Hierarchies" caused by case sensitivity or invalid characters. - Decorator Migration:
ColorDecoratoris now a deprecated alias forStyleDecorator. All visual transformations now flow through theLogThemeresolution logic.
Major Overhauls & Features #
- ToonFormatter (LLM-Native): Introduced Token-Oriented Object Notation (TOON), a header-first streaming format optimized for AI agent context efficiency.
- Semantic Styling Pipeline: The internal pipeline now emits rich
LogStylemetadata. Sinks are now responsible for final rendering (e.g., translatingBoldandDiminto ANSI codes or CSS classes). - Style Resolution Precision: Enhanced
JsonPrettyFormatterto correctly tag and style nested JSON values by mapping them to their correspondingLogFieldtypes. - Shared Field Logic: Core log metadata (Timestamp, Level, Logger, Message, Error, StackTrace) is now extracted via a centralized, type-safe provider used by all modern formatters.
Documentation Suite #
- Technical Manuals: Completely rebuilt the
doc/module with high-precision architectural guides:- Architecture: Details the 4-stage pipeline and operational context (
LogContext). - Migration Guide: Outlines the transition from monolithic "God Components" to decentralized behaviors.
- Philosophy: Documents foundational principles like Hierarchical Inheritance and Lazy Resolution.
- Decorator Composition: Explains execution priority and data-model flow.
- Architecture: Details the 4-stage pipeline and operational context (
- Roadmap Pivot: Updated future priorities to include Structured Context Support and a Web-Based Logd Dashboard.
0.5.0: Centralized Layout & Rigid Alignment #
-
Core Architecture & Layout #
- Centralized Layout Management: Introduced a rigid layout system where
Handler.lineLengthacts as the primary constraint, falling back toLogSink.preferredWidth(e.g., 80 for Terminal, dynamic for others) - LogContext Evolution:
LogContextnow carriesavailableWidth, serving as the single, authoritative source of truth for all layout calculations in formatters and decorators - Parameter Cleanup: Removed deprecated and redundant
lineLengthparameters fromStructuredFormatter,BoxDecorator, andBoxFormatterto enforce centralized control and reduce API surface
- Centralized Layout Management: Introduced a rigid layout system where
-
Component Enhancements #
- Const-Friendly Decorators: Migrated
BoxDecoratorandJsonPrettyFormattertoconstconstructors where possible, improving initialization performance - Logical Segment Tags: Added
LogTag.prefixto support specialized content prefixes fromPrefixDecorator, providing better isolation from header coloring - PlainFormatter Refinement: Improved multi-line message handling in
PlainFormatterto yield distinct segments, preventing structural breaks during decoration
- Const-Friendly Decorators: Migrated
-
Quality & Safety #
- Width Clamping: Consistent width clamping across the pipeline ensures stability even with extremely narrow terminal configurations
- Comprehensive Test Migration: Full coverage of the new layout model in
null_safety_test.dart,layout_safety_test.dart, anddecorator_composition_test.dart
0.4.2: Semantic Segments & Visual Overhaul #
-
Core Architecture & Structure #
- Directory Overhaul: Centralized internal modules under
lib/src/core/(coloring, context, utils, logger, time, stack_trace) for cleaner package organization - Semantic Tagging Engine: Migrated the entire pipeline to a segment-based architecture. Formatters now emit
LogLineobjects composed ofLogSegments with rich semantic tags (LogTag)
- Directory Overhaul: Centralized internal modules under
-
New Formatters & Sinks #
- JsonSemanticFormatter: Outputs structured JSON containing both raw data and semantic metadata for programmatic analysis
- MarkdownFormatter: Generates beautifully structured Markdown with support for headers, code blocks, and nested lists
- HTMLFormatter & HTMLSink: Dedicated system for producing semantic HTML logs with customizable CSS mapping for browser visualization
-
Visual Enhancements #
- Advanced Header Wrapping:
StructuredFormatternow intelligently wraps long headers (logger names, levels, timestamps) while preserving fine-grained semantic tags where possible - Expanded Color System: Refined
ColorSchemeandColorConfigto leverage semantic tags for precise, multi-layered coloring
- Advanced Header Wrapping:
-
Developer Experience #
- Logd Theatre Showcase: A new flagship example (
example/log_theatre.dart) providing an interactive, "dashboard-style" demonstration of the entire library capability - Test Rationalization: Consolidated the fragmented edge-case test suite from 16 files into 5 high-impact safety suites, improving test speed and maintainability
- Logd Theatre Showcase: A new flagship example (
-
Maintenance & Fixes #
- Version Correction: Unified versioning across documentation and package metadata
- General Stability: Fixed several edge-case wrapping bugs in
StructuredFormatterandBoxDecorator
0.4.1: Handler Robustness & Stability #
-
Critical Bug Fixes #
- FileSink Race Condition: Implemented mutex-based synchronization to serialize concurrent writes, preventing data loss during rapid logging
- TimeRotation Accuracy: Fixed timestamp tracking by updating
lastRotationafter successful writes, ensuring correct rotation triggers - Rotation Error Resilience: Enhanced error handling to continue writing to original file when rotation fails, preventing data loss
- BoxDecorator Width: Fixed internal content width calculation (
lineLength - 2) and added width clamping to prevent crashes - PlainFormatter Multi-line: Now joins multi-line messages to prevent format breaks in file logs
-
ANSI Code Handling #
- Added
wrapVisiblePreserveAnsi()to maintain ANSI styles across line breaks, fixing style loss in wrapped content - Added
padRightVisiblePreserveAnsi()to ensure padding inherits styling, preventing visual gaps in colored headers - Introduced
AnsiColorSchemeandAnsiColorConfigfor structured color customization - Replaced boolean
colorHeaderBackgroundwith explicitAnsiColorConfig(headerBackground: true)
- Added
-
Robustness & Idempotency #
- Width clamping in
StructuredFormatterandBoxDecoratorprevents negative width crashes BoxDecoratoridempotency check prevents nested box decorations- Fixed
LogBufferto avoid unnecessary stack trace creation during sink
- Width clamping in
-
Examples & Documentation #
- Added 17 comprehensive examples covering basic setups, formatters, decorators, sinks, filters, and edge cases
- Updated
docs/handler/README.mdwith color customization and edge case handling info - Added migration guide for
BoxFormatterand color configuration changes
-
Test Coverage #
- Added 13+ edge case test files validating concurrency, null handling, Unicode, ANSI codes, extreme widths, rotation timing, and error handling
- Over 2,400 new lines of test code ensuring robust behavior under edge conditions
0.4.0: Context-Aware Decorators & Visual Refinement #
-
Context-Aware Decoration Pipeline #
- Full Context Access:
LogDecorator.decorate()now accepts the fullLogEntryobject, granting decorators access to metadata likehierarchyDepth,tags, andloggerNamefor smarter transformations. - Automatic Composition Control: The
Handlerautomatically sorts decorators by type (Transform → Visual → Structural) to ensure correct visual composition, with deduplication to prevent redundant processing.
- Full Context Access:
-
Visual Refinements #
- Independent Coloring:
BoxDecoratornow supports its ownuseColorsparameter, allowing the structural border to be colored independently of the content.ColorDecoratorcan now be focused purely on content styling. - Header Highlights:
ColorDecoratoradds acolorHeaderBackgroundoption to apply bold background colors specifically to log headers, improving scannability in dense logs without bleeding into structural elements. - Hierarchy Visualization: Introduced
HierarchyDepthPrefixDecorator(formerly experimented asTreeDecorator). It adds visual indentation (defaulting to│) based on the logger's hierarchy depth, creating a clear tree-like structure in the terminal.
- Independent Coloring:
-
API & Robustness #
- Simplified BoxDecorator: Removed internal complexity from
BoxDecorator, making it a pureStructuralDecoratorfocused on layout. - Robustness Tests: Expanded test suite to cover deep decorator composition, ensuring that complex chains (Color -> Box -> Indent) render correctly without layout artifacts.
- Simplified BoxDecorator: Removed internal complexity from
0.3.1: Logger Architecture Refactor & Performance Optimization + Critical Bug Fix #
-
Bug Fix: Corrupted Pure Dart support fixed #
- Version 0.3.0 dropped support for pure dart due to a mis-used library. Fixed in version 0.3.1.
-
Architectural Shift: Separated Configuration from Resolution #
LoggerConfig&LoggerCache: Introduced a dual-component architecture for logger configuration.LoggerConfignow strictly holds raw, explicitly set configuration values, while the newLoggerCachehandles the hierarchical resolution (inheritance) and provides a high-performance caching layer.- Versioned Invalidation: Implemented a version-based cache invalidation mechanism.
LoggerConfigtracks changes via a_versioncounter, allowingLoggerCacheto lazily re-resolve effective settings only when the source configuration or its ancestry changes. - Thread-Safety & Immutability: Resolved configuration objects (like
handlersandstackMethodCount) are now returned as unmodifiable collections, protecting the internal state from accidental external mutation.
-
Performance: Deep Equality Optimization #
- Smart Reconfiguration:
Logger.configurenow performs deep equality checks on collections using internallistEqualsandmapEqualsutilities. This prevents redundant cache invalidations and descending tree walks when passing new collection instances that contain identical configurations. - Comprehensive Equality Support: Implemented
operator ==andhashCodeacross the entire configuration surface, including:- Handlers:
Handlernow correctly compares its formatter, sink, filters, and decorators. - Time Engine:
TimestampandTimezone(including DST rules and transition logic) now support value-based equality. - Stack Logic:
StackTraceParserandCallbackInfonow support deep comparison. - Filters & Formatters:
LevelFilter,RegexFilter,PlainFormatter,BoxFormatter, andJsonFormatterare now value-comparable.
- Handlers:
- Smart Reconfiguration:
-
Resilience & Testing #
- InternalLogger Resilience: Added targeted tests to verify that
InternalLoggerremains safe and circular-logging-free even when primary handlers fail, preventing stack overflows during failure recovery. - Deep Inheritance: Expanded the test suite to cover complex, multi-level hierarchy inheritance with partial overrides, ensuring configuration correctly "bubbles" through the tree.
- LogBuffer Integration: Verified the instance-based
LogBufferAPI (logger.infoBuffer) and its integration with the logging pipeline.
- InternalLogger Resilience: Added targeted tests to verify that
-
API & Maintenance #
- Immutability Enforcement: Applied
@immutableannotations to all core configuration and handler classes, providing better compile-time safety and alignment with modern Dart best practices. - Core Utilities: Centralized collection equality logic into
src/core/utils.dart.
- Immutability Enforcement: Applied
0.3.0: Robust Fallback Logging & Handler Resilience #
-
Fallback Logger for Circularity Prevention #
- Introduced
InternalLogger, a safe, direct-to-console logging mechanism for library-internal errors. - This prevents circular logging loops where a failure in a sink (like
FileSink) could trigger another error log, leading to infinite recursion. - Integrated
InternalLoggerintoLogger,FileSink,MultiSink,LogBuffer, andTimezone.
- Introduced
-
Improved Handler Resilience #
Loggernow catches errors from individual handlers. If one handler fails, it reports the error viaInternalLoggerand continues to process other handlers.MultiSinknow iterates through its sinks and handles individual sink failures independently, ensuring a single failing sink doesn't stop the entire output pipeline.
-
Bug Fixes & API Refinements #
- StackTraceParser: Fixed a regex bug that prevented parsing frames with spaces in method names, such as
<anonymous closure>. - API Visibility: Unhidden
LogEntryin the public API, as it is required for users to implement customLogFormatterinstances. - InternalLogger Visibility: Marked
InternalLoggeras@internalto keep it out of the public surface while still available for internal use.
- StackTraceParser: Fixed a regex bug that prevented parsing frames with spaces in method names, such as
0.2.3: Decoupled System Dependencies for Enhanced Testability #
-
Internal Service Locator for System Dependencies #
- Introduced an internal
Contextclass to act as a service locator for system-level dependencies likeClockandFileSystem. - This decouples the library from concrete implementations (e.g.,
DateTime.now(),dart:io), making it possible to inject mock implementations during testing. - Added
@visibleForTestingannotations to allow injecting customClockandFileSysteminstances in test environments. - This change significantly improves the testability and reliability of time-sensitive and file-system-dependent components.
- Introduced an internal
0.2.2: Enhanced FileSink Rotation & Custom Formatters #
-
Custom Filename Formatters for Rotated Logs #
SizeRotationandTimeRotationnow accept an optionalfilenameFormatterfunction.- This allows developers to define custom naming schemes for rotated log files, providing more control over backup organization.
-
Robust File Rotation & Cleanup Logic #
- The backup cleanup logic has been refactored to be more reliable. It now sorts backup files by their last modified timestamp to determine which to delete, instead of parsing potentially fragile filenames.
SizeRotationnow correctly renames the current log file to the first backup (e.g.,.1) before compression.
-
Improved Argument Validation & Reliability #
FileSinknow validates thebasePathto ensure it is not empty or a directory.FileRotationandTimeRotationconstructors now throw anArgumentErrorfor invalid arguments (e.g., negativebackupCount), replacing previousassertchecks.FileSink.write()now writes to the file withflush: trueto ensure data is immediately persisted.
0.2.1: Comprehensive Time Component Testing & Fixes #
-
Comprehensive Unit Testing #
Time&TimezoneTests: Addedtime_test.dartandtimezone_test.dartto verify mockable providers and extensive DST calculations across various rules and hemispheres.TimestampFormatter Tests: Addedtimestamp_test.dartto validate formatters, literal parsing, edge cases, and timezone handling.
-
Bug Fixes & Refinements #
- Timestamp Formatting: Corrected
iso8601andrfc2822formatters by removing extra single quotes to fix timezone literal rendering. The formatter token parser was also updated to correctly handle tokens containing underscores and digits. - DST Rules: Updated internal DST transition rules for several European timezones (
Europe/Paris,Europe/London,Europe/Berlin) to use the correct local transition times. - Time Class: Renamed
Time.resetTimeProvide()toTime.resetTimeProvider()for consistency. - Code Simplification: Replaced a manual Zeller’s congruence implementation for calculating the day of the week with a simpler call to
DateTime.utc().weekday.
- Timestamp Formatting: Corrected
0.2.0: Time Engine Overhaul & Mockable Time Provider #
-
Timestamp & Timezone Overhaul (Performance, DST, API) #
- Performance: Implemented a cached token system, eliminating the need to re-parse redundant formatters on every call.
- Mockable Time Provider: Introduced a mockable time provider (
Time.timeProvider) for robust testing of time-sensitive logic. TheTimeclass is now encapsulated with controlled access viasetTimeProvider()andresetTimeProvider(). - DST Support: Added full support for Daylight Saving Time (DST). The local timezone will resolve to a DST-aware timezone if available on the platform.
timezoneRenaming (Backward Incompatible): ThetimeZoneparameter was renamed totimezonefor consistency. TheTimeZoneclass was also renamed toTimezone.- DST Calculation Fix: Improved the DST offset calculation logic to better handle transitions.
- Platform Support: Enhanced platform-aware timezone detection, now including web support.
-
Advanced
TimestampFormatter #- Literal Support: The formatter now supports single-quoted literals (e.g.,
'on','at') to include static text in the output. - New Format Tokens:
'F...': For microseconds (for high-accuracy benchmarking).'E...': For weekdays (e.g., 'Monday').'a': For lowercase "am/pm".'z': For a standard-compliant timezone offset string (e.g.,Zor+0330).
- Token Changes: Removed the 'SSSS' token as it was redundant.
- Factory Constructors: Introduced common factory constructors like
Timestamp.iso8601(),rfc3339(),rfc2822(), andmillisecondsSinceEpoch().
- Literal Support: The formatter now supports single-quoted literals (e.g.,
-
Other Changes & Refinements #
- API Clarity: Renamed
LogBuffer.sync()toLogBuffer.sink(). - Improved Error Handling:
LogBufferandFileSinknow use the logger instance for error reporting instead ofprint(). - Code Refinements: Internal function and variable names related to timezones have been unified for better readability.
- API Clarity: Renamed
0.1.5: Async Logging / File Rotation #
-
Asynchronous Logging Pipeline #
- The entire logging pipeline, from
logger.log()tohandler.log()andsink.output(), is nowasync. - This prevents I/O operations (like file or network writes) from blocking the main thread.
- Error handling has been added to logging calls to catch and print exceptions that occur during the logging process itself.
- The entire logging pipeline, from
-
Advanced File Sink with Rotation #
- Introduced
FileRotationabstract class to enable log file rotation policies. - Added
SizeRotation: Rotates log files when they exceed a specified size (e.g., '10 MB'). - Added
TimeRotation: Rotates logs based on a time interval. - Both rotation policies support keeping a configured number of backup files and optional
gzipcompression for rotated logs.
- Introduced
-
Minor Refinements #
MultiSinknow outputs to all its sinks concurrently usingFuture.wait.- Added
//ignore: one_member_abstractstoLogFilterandLogFormatterto clean up analyzer warnings.
0.1.3: Pure Dart Support / Instantaneous Cached Configurations #
-
Pure Dart Optimizations #
- logd in now Dart ready. Decoupled from Flutter dependencies in favor of Dart standalone support.
-
Instantaneous Cached Configurations #
- Introduced
_LoggerConfig: Configuration is now stored in a separate internal_LoggerConfigclass, decoupling it from theLoggerinstance itself. This allowsLoggerto act as a lightweight proxy. - Improved Dynamic Hierarchy Propagation: Configuration changes now dynamically propagate down the logger tree.
- Cached Configuration: Resolved configuration values are now cached to improve performance by avoiding repeated hierarchy lookups. Caches are automatically cleared when parent configurations change.
- Simplified
configure(): Theconfigure()method now updates the configuration in-place rather than creating a newLoggerinstance. - Normalized Logger Names: Logger names are now consistently normalized to lowercase to ensure case-insensitivity. The root logger is consistently referred to as 'global'.
- Refactored
freezeInheritance(): ThefreezeInheritance()method has been updated to work with the new_LoggerConfigmodel, "baking" the current resolved configuration into descendant loggers. - Removed
attachToUncaughtErrors(): The method was removed from theLoggerclass.
- Introduced
-
TimeZone Improvements #
- The
Timestampconstructor'sformatterparameter is now required. - A new factory constructor,
Timestamp.none(), is introduced to create aTimestampwith an empty formatter. TimeZone.local()now correctly includes the system's current time zone offset.
- The
-
Improved FileSink (Still Under Development) #
- Automatically create parent directories for the log file path.
- Add more robust error handling:
- Rethrow exceptions in debug mode for easier debugging.
-
Comprehensive example demonstrating all
logdfeatures #
0.1.2: Minor API Changes #
0.1.1: Dynamic Logger Tree Hierarchy Inheritance #
-
Dynamic Inheritance #
- Logger tree is now dynamically propagated, rooting at 'global' logger
- freezeInheritance() is introduced to bake configs into a logger (and it's descendant branch, if any).
- global getter ditched in favor of uniformity: access global logger using get() or get('global').
0.1.0: Dot-separated Logger Tree Hierarchy + Handlers #
-
New Api #
- Logger has new Api surface.
- Introduced Dot-separated Logger Tree Hierarchy.
- Introduced functionalities to attach to Flutter/Dart Error and Unhandled Exceptions
-
Logger Tree Hierarchy #
- Loggers are named, now with a Dot-separated mechanism to inherit from their parent if not explicitly set. (Under Development)
- global Logger (still) available.
- Child propagation. (Under Development)
-
Handlers #
- Introduce Handlers: This Replaces Printers in V 0.0.2, no backward compatibility here!
- Introduced LogFormatters: Separated formatting LogEntries from outputting.
- Introduced LogSinks: Separated outputting LogEntries from formatting.
- Introduce LogFilters A way to filter out specific log entries.
-
Better Structure and Documentation #
0.0.2: Modularity + Printers #
-
Introduced Modular Loggers #
-
Introduced LogEvents #
-
Introduced Printers #
- Printers are a way of outputting data. (Soon to be replaced with Handlers: Formatters and Sinks)