LoggingHelper Documentation

Overview

The LoggingHelper class provides comprehensive logging functionality with support for multiple logging sinks, structured logging, performance metrics, and audit events. It uses Serilog as the underlying logging framework.

Features

• Multiple logging sinks (Console, File, Elasticsearch)
• Structured logging with context
• Performance metrics logging
• Audit and security event logging
• Log scoping and correlation
• Configurable log levels and templates

Usage

Initialization

            
                content_copy
            
            
var options = new LoggingOptions
{
    MinimumLevel = LogEventLevel.Information,
    EnableConsole = true,
    ConsoleTemplate = "{Timestamp:yyyy-MM-dd HH:mm:ss} [{Level:u3}] {Message:lj}{NewLine}{Exception}",
    EnableFile = true,
    FilePath = "logs/app.log",
    RetainedFileCount = 31,
    EnableElasticsearch = true,
    ElasticsearchUrl = "http://localhost:9200",
    ElasticsearchIndex = "logs-{0:yyyy.MM}"
};

LogHelper.Initialize(options);
        

Basic Logging

            
                content_copy
            
            
LogHelper.Verbose("Detailed debugging information");
LogHelper.Debug("Debugging information");
LogHelper.Information("General information");
LogHelper.Warning("Warning message");
LogHelper.Error("Error message");
LogHelper.Fatal("Fatal error message");
        

Exception Logging

            
                content_copy
            
            
try
{
    // Some code that might throw
}
catch (Exception ex)
{
    LogHelper.Exception(ex, "An error occurred while processing {Item}", itemName);
}
        

Scoped Logging

            
                content_copy
            
            
using (LogHelper.BeginScope(new Dictionary
{
    ["UserId"] = userId,
    ["RequestId"] = requestId
}))
{
    LogHelper.Information("Processing request");
    // All logs within this scope will include UserId and RequestId
}
        

Performance Metrics

            
                content_copy
            
            
LogHelper.LogMetric("ProcessingTime", 150.5, "ms", new Dictionary
{
    ["Operation"] = "DataSync",
    ["BatchSize"] = 1000
});
        

Audit Events

            
                content_copy
            
            
LogHelper.LogAudit(
    action: "UserCreated",
    resource: "Users",
    user: "admin@example.com",
    details: new { UserId = 123, Role = "Admin" }
);
        

Security Events

            
                content_copy
            
            
LogHelper.LogSecurity(
    eventType: "UnauthorizedAccess",
    severity: SecuritySeverity.High,
    message: "Invalid login attempt",
    details: new { Username = "user", IpAddress = "192.168.1.1" }
);
        

Performance Measurement

            
                content_copy
            
            
var result = await LogHelper.MeasureExecutionTime(
    async () =>
    {
        // Long running operation
        return await ProcessData();
    },
    "DataProcessing"
);
        

Options Class

LoggingOptions

• MinimumLevel: Minimum log level to capture
• EnableConsole: Enable console logging
• ConsoleTemplate: Console output template
• ConsoleMinLevel: Minimum level for console output
• EnableFile: Enable file logging
• FilePath: Log file path
• FileTemplate: File output template
• RetainedFileCount: Number of log files to retain
• EnableElasticsearch: Enable Elasticsearch logging
• ElasticsearchUrl: Elasticsearch server URL
• ElasticsearchIndex: Index name format

Security Severity Levels

            
                content_copy
            
            
public enum SecuritySeverity
{
    Low,
    Medium,
    High,
    Critical
}
        

Best Practices

1. Log Levels

   • Use Verbose for detailed debugging
   • Use Debug for general debugging
   • Use Information for general information
   • Use Warning for potential issues
   • Use Error for actual errors
   • Use Fatal for catastrophic failures

2. Structured Logging

   • Use structured log messages with named parameters
   • Include relevant context in log scopes
   • Use semantic logging for metrics and events

3. Performance

   • Use appropriate log levels to avoid unnecessary logging
   • Consider using async logging for high-throughput scenarios
   • Monitor log file sizes and implement rotation

4. Security

   • Never log sensitive information
   • Use appropriate security severity levels
   • Include relevant security context in audit logs

Error Handling

The helper automatically handles logging errors internally. If initialization fails, it will use default settings to ensure logging continues to function.