🚀 Features

• Smart Log Rotation - Automatic daily and size-based log rotation with customizable naming
• Intelligent Archiving - Archive old logs in ZIP, GZIP, or TAR formats
• Configurable Retention - Automatic cleanup of old logs based on retention policy
• High Performance - Buffered writes and async I/O for optimal performance
• Flexible Filtering - Log level filtering to control verbosity
• Robust Error Handling - Graceful degradation without crashing your application
• Pino Ecosystem - Seamless integration with Pino logger ecosystem

📦 Installation

npm install pino-file-logger-transport

✅ Compatibility

| Package line | Node.js | Pino | |--------------|---------|------| | 1.x | >=16 | ^9 | | 2.x | >=20 | ^9.14.0 \|\| ^10.0.0 |

🔄 Migration Notes

• If your project is on Node.js 18, stay on 1.x:

npm install pino-file-logger-transport@^1

• Use 2.x for Node.js 20+ and official pino@10 support.
• Size-based rotation options (maxFileSizeMB, maxFiles) are available starting from 2.1.0.

🎯 Quick Start

const pino = require('pino');

const transport = pino.transport({
  target: 'pino-file-logger-transport',
  options: {
    logDirectory: './logs',
    filename: 'app',
    retentionDays: 7,
  },
});

const logger = pino(transport);

logger.info('Hello world!');
logger.error('Something went wrong');

⚙️ Configuration

const transport = pino.transport({
  target: 'pino-file-logger-transport',
  options: {
    // Required: Directory for log files
    logDirectory: './logs',
    
    // Optional: Base filename (default: 'log')
    filename: 'my-app',
    
    // Optional: Days to retain logs (default: 7)
    retentionDays: 30,
    
    // Optional: Minimum log level (default: 'info')
    level: 'warn',
    
    // Optional: Archive format (default: 'zip')
    archiveFormat: 'gzip',
    
    // Optional: Buffer size for performance (default: 100)
    bufferSize: 50,

    // Optional: Rotate file when size is reached in MB (disabled by default, since 2.1.0)
    maxFileSizeMB: 50,

    // Optional: Maximum managed files per directory (disabled by default, since 2.1.0)
    maxFiles: 100,
  },
});

const logger = pino(transport);

🛠 Advanced Usage

const pino = require('pino');

const transport = pino.transport({
  target: 'pino-file-logger-transport',
  options: {
    logDirectory: './logs',
    filename: 'application',
    retentionDays: 14,
    level: 'info',
    bufferSize: 100,
    flushInterval: 1000,
    archiveFormat: 'zip',
    compressionLevel: 6,
    archiveDirectory: './archives',
    cleanupOnRotation: true,
    archiveOnRotation: true,
  },
});

const logger = pino(transport);

// Structured logging
logger.info({ userId: 123, action: 'login' }, 'User authenticated');

// Error logging with stack traces
logger.error(new Error('Database connection failed'), 'Critical system error');

// Child loggers
const authServiceLogger = logger.child({ service: 'auth' });
authServiceLogger.info('Authentication service initialized');

📖 Documentation

For complete documentation, visit our docs:

• 🔧 Features - Full feature overview
• 🚀 Usage Guide - Detailed usage instructions
• 📚 API Reference - Complete API documentation
• 🏗 Architecture - Internal architecture

🧪 Testing

npm test

📄 License

MIT © ProydakD