K.Bag.Log4Net.Extension 0.0.1

K.Bag.Log4Net.Extension

A powerful and flexible logging extension library built on top of log4net, providing enhanced logging capabilities with customizable formatters, writers, and configurations.

📦 Installation

Install via NuGet Package Manager:

<PackageReference Include="K.Bag.Log4Net.Extension" Version="1.0.0" />

Or via Package Manager Console:

Install-Package K.Bag.Log4Net.Extension

Or via .NET CLI:

dotnet add package K.Bag.Log4Net.Extension

💡 Basic Usage

1. Quick Setup

The easiest way to get started with logging:

using K.Bag.Log4Net.Extension;
using K.Bag.Log4Net.Extension.Configuration;

// Configure the logger once in your application startup
var config = new KlypzLoggerConfiguration();
config.SetFileFormatter(LoggerFileFormatterDefault.CsvPattern);
config.SetConsoleWriter(LoggerWriterConsoleDefault.Modern);

// Set up file logging (optional - omit the path to log only to console)
LoggerManager.ConfigureDefault(config, @"C:\logs\application.log");

// Use the logger in your classes
IKlypzCustomLogger logger = LoggerManager.GetLoggerDefault(typeof(MyClass));
logger.AddInformation("Application started successfully");

2. Advanced Configuration

Configure different logging levels and options:

var config = new KlypzLoggerConfiguration()
{
    DebugEnable = LevelTypeEnable.OnlyConsole, // Debug only shown in console, not file
    InfoEnable = LevelTypeEnable.Both,         // Info shown in both console and file
    WarnEnable = LevelTypeEnable.Both,
    ErrorEnable = LevelTypeEnable.Both,
    FatalEnable = LevelTypeEnable.Both,
    IgnoresException = false,                  // Log exception details
    MaximumFileSize = "10MB",                  // Rotate log files at 10MB
    MaxSizeRollBackups = 5                     // Keep up to 5 rotated log files
};

config.SetFileFormatter(LoggerFileFormatterDefault.TabPattern);
config.SetConsoleWriter(LoggerWriterConsoleDefault.ModernClean);

LoggerManager.ConfigureDefault(config, @"C:\logs\application.log");

3. Different Console Writers

Choose from three built-in console writers:

// Old school style (similar to Situator)
config.SetConsoleWriter(LoggerWriterConsoleDefault.OldSchool);

// Modern formatted output
config.SetConsoleWriter(LoggerWriterConsoleDefault.Modern);

// Clean modern output
config.SetConsoleWriter(LoggerWriterConsoleDefault.ModernClean);

4. Different File Formatters

Choose from three built-in file formatters:

// CSV-style formatting
config.SetFileFormatter(LoggerFileFormatterDefault.CsvPattern);

// Tab-separated formatting  
config.SetFileFormatter(LoggerFileFormatterDefault.TabPattern);

// Traditional .log formatting
config.SetFileFormatter(LoggerFileFormatterDefault.OldSchoolPattern);

5. Using the Logger

Add different types of log messages:

IKlypzCustomLogger logger = LoggerManager.GetLoggerDefault(typeof(MyClass));

// Different log levels
logger.AddDebug("Debugging information");
logger.AddInformation("General information");
logger.AddWarning("Warning message");
logger.AddError("Error occurred");
logger.AddFatal("Fatal error");

// With exception details
try
{
    // Something that throws an exception
}
catch(Exception ex)
{
    logger.AddError("An error occurred processing data", ex);
    logger.AddWarning("Recovering from error", ex);
}

6. Named Loggers

Create multiple loggers with different names for different purposes:

IKlypzCustomLogger dataAccessLogger = LoggerManager.GetLoggerDefault("Data Access");
IKlypzCustomLogger businessLogicLogger = LoggerManager.GetLoggerDefault("Business Logic");

dataAccessLogger.AddDebug("Executing query took 250ms");
businessLogicLogger.AddInformation("User authentication successful");

7. Custom File Formatting

Define custom columns for your log files:

var config = new KlypzLoggerConfiguration();

// Define custom column layout
var columns = new[]
{
    ColumnLog.DateTime,
    ColumnLog.Level,
    ColumnLog.Name,
    ColumnLog.Message,
    ColumnLog.ExceptionMessage
};

config.SetFileFormatter(LoggerFileFormatterDefault.CsvPattern);
config.SetColumnsFormatter(columns);

LoggerManager.ConfigureDefault(config, @"C:\logs\application.log");

⚙️ Configuration Options

Available LevelTypeEnable values:

• OnlyFile - Messages appear only in file
• OnlyConsole - Messages appear only in console
• Both - Messages appear in both file and console

🔧 Supported Column Types

When configuring file formatters, you can use these column types:

• ColumnLog.Name - Class or grouping name
• ColumnLog.FullName - Full class name (namespace + class)
• ColumnLog.DateTime - Timestamp of log entry
• ColumnLog.Level - Log level (DEBUG, INFO, WARN, ERROR, FATAL)
• ColumnLog.Message - Log message
• ColumnLog.FullMessage - Full message including line breaks
• ColumnLog.ExceptionMessage - Exception message if provided
• ColumnLog.ExceptionStackTrace - Exception stack trace if provided
• ColumnLog.Thread - Thread ID where log occurred

🛠️ Logger Methods

✅ Best Practices

1. Initialize Once: Configure the logger manager only once during application startup
2. Use Named Loggers: For different components of your application
3. Keep Debug Off in Production: Set DebugEnable = LevelTypeEnable.OnlyConsole or disable for production
4. Manage File Sizes: Use appropriate MaximumFileSize and MaxSizeRollBackups settings
5. Include Exceptions: Always include exception details when logging errors

📋 Dependencies

This package depends on:

• log4net

📄 License

See the LICENSE file for licensing information.

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.