v2.2.0

Release v2.2.0

🎉 What's New

Sensitive Data Masking

• Added sensitiveKeys configuration option to automatically mask sensitive information in log outputs
• Sensitive keys (like password, secret, token, apiKey, etc.) are now automatically masked as [Sensitive data masked] to prevent accidental leakage of confidential information
• Case-insensitive pattern matching for flexible sensitive key detection
• Configurable via SeqLoggerModuleOptions:

SeqLoggerModule.forRoot({
  serverUrl: 'http://localhost:5341',
  apiKey: 'your-api-key',
  sensitiveKeys: ['password', 'secret', 'token', 'apiKey', 'authorization'],
  // ... other options
});

• Sensitive data masking is automatically applied to all log events processed through the SeqLoggerModule
• Also integrated into ConsoleSeqLogger for consistent behavior across all logging methods

Internal Improvements

• Improved internal object handling and processing mechanisms
• Enhanced error handling and data safety measures

🔧 Improvements

Reliability & Stability

• Improved error handling and retry mechanisms for more reliable log delivery
• Enhanced robustness when dealing with network issues and server errors
• Better event processing and recovery mechanisms

📚 Documentation

• Updated SEQ_LOGGER_OPTIONS.md with sensitiveKeys configuration documentation
• Added examples for sensitive data masking usage
• Enhanced documentation with better examples and explanations

🔗 Links

• Full Documentation
• Configuration Options
• Example Repository

📦 Installation

npm install @jasonsoft/nestjs-seq@2.2.0
# or
yarn add @jasonsoft/nestjs-seq@2.2.0
# or
pnpm add @jasonsoft/nestjs-seq@2.2.0

🔄 Migration Guide

Upgrading from v2.1.x

No breaking changes! The new sensitiveKeys option is completely optional. If you want to enable sensitive data masking, simply add it to your configuration:

// Before (still works)
SeqLoggerModule.forRoot({
  serverUrl: 'http://localhost:5341',
  apiKey: 'your-api-key',
});

// After (with sensitive data masking)
SeqLoggerModule.forRoot({
  serverUrl: 'http://localhost:5341',
  apiKey: 'your-api-key',
  sensitiveKeys: ['password', 'secret', 'token'], // Optional
});

📝 Full Changelog

Added

• sensitiveKeys configuration option for automatic sensitive data masking

Changed

• Enhanced internal processing mechanisms for better data safety
• Improved error handling and recovery mechanisms
• Updated documentation with new configuration options

Fixed

• Improved event handling reliability
• Better error recovery when log sending fails