CG.Infrastructure.Logging 3.10.5

CG.Infrastructure.Logging

A comprehensive logging library for .NET applications built on top of Serilog, providing structured logging capabilities with extensive configuration options and multiple output sinks.

Overview

CG.Infrastructure.Logging is a .NET 10.0 library that simplifies logging implementation across your applications. It provides a unified logging interface with Serilog as the underlying engine, offering structured logging, correlation ID tracking, and multiple output destinations. This library works in conjunction with CG.Infrastructure.Logging.Data for database schema management and query definitions.

Features

• Structured Logging: Leverage Serilog's powerful structured logging capabilities
• Multiple Output Sinks: Console, file, HTTP, and SQL Server logging support
• Correlation ID Tracking: Automatically track request correlation across log entries
• Environment Enrichment: Automatically include environment and process information
• Exception Handling: Enhanced exception logging with detailed context
• Expression-based Filtering: Advanced log filtering using Serilog expressions
• Browser Console Support: Client-side logging for web applications
• Configuration-based Setup: Easy configuration through appsettings.json

Target Framework

• .NET 10.0

Dependencies

Core Dependencies

• CG.Infrastructure.Core (3.10.8) - Core infrastructure components
• Serilog (4.3.0) - Structured logging framework

ASP.NET Core Integration

• Serilog.AspNetCore (9.0.0) - ASP.NET Core integration
• Serilog.Extensions.Hosting (9.0.0) - Hosting integration

Enrichers

• Serilog.Enrichers.CorrelationId (3.0.1) - Request correlation tracking
• Serilog.Enrichers.Environment (3.0.1) - Environment information
• Serilog.Enrichers.Process (3.0.0) - Process information
• Serilog.Enrichers.Thread (4.0.0) - Thread information

Advanced Features

• Serilog.Exceptions (8.4.0) - Enhanced exception logging
• Serilog.Expressions (5.0.0) - Expression-based filtering

Output Sinks

• Serilog.Sinks.Console (6.0.0) - Console output
• Serilog.Sinks.File (7.0.0) - File output
• Serilog.Sinks.Http (9.2.0) - HTTP endpoint output
• Serilog.Sinks.MSSqlServer (8.2.2) - SQL Server database output
• Serilog.Sinks.BrowserConsole (8.0.0) - Browser console output

Configuration

• Serilog.Settings.Configuration (9.0.0) - Configuration-based setup

Utilities

• System.Text.Json (9.0.8) - JSON serialization support

Package Information

• Package ID: CG.Infrastructure.Logging
• Version: 3.10.4
• Authors: Matthew Evans
• Company: Matthew Evans
• Product: CG.Infrastructure.Logging
• Description: Infra Logging library with Serilog setup, extensions and database contexts

Getting Started

Installation

dotnet add package CG.Infrastructure.Logging

Basic Configuration

// Program.cs or Startup.cs
using Serilog;

var builder = WebApplication.CreateBuilder(args);

// Configure Serilog
builder.Host.UseSerilog((context, services, configuration) => configuration
 .ReadFrom.Configuration(context.Configuration)
 .ReadFrom.Services(services)
 .Enrich.FromLogContext()
 .WriteTo.Console()
 .WriteTo.File("logs/app-.txt", rollingInterval: RollingInterval.Day));

Configuration Example (appsettings.json)

{
 "Serilog": {
 "Using": ["Serilog.Sinks.Console", "Serilog.Sinks.File"],
 "MinimumLevel": {
 "Default": "Information",
 "Override": {
 "Microsoft": "Warning",
 "System": "Warning"
 }
 },
 "WriteTo": [
 {
 "Name": "Console",
 "Args": {
 "outputTemplate": "[{Timestamp:HH:mm:ss} {Level:u3}] {Message:lj} {Properties:j}{NewLine}{Exception}"
 }
 },
 {
 "Name": "File",
 "Args": {
 "path": "logs/app-.txt",
 "rollingInterval": "Day",
 "retainedFileCountLimit": 7
 }
 }
 ],
 "Enrich": ["FromLogContext", "WithCorrelationId", "WithEnvironment", "WithProcess", "WithThread"]
 }
}

Usage Examples

Basic Logging

using Serilog;

public class ExampleService
{
 private readonly ILogger _logger;

 public ExampleService(ILogger logger)
 {
 _logger = logger;
 }

 public void ProcessData(string data)
 {
 _logger.Information("Processing data: {Data}", data);
 
 try
 {
 // Process data
 _logger.Information("Data processed successfully");
 }
 catch (Exception ex)
 {
 _logger.Error(ex, "Error processing data: {Data}", data);
 throw;
 }
 }
}

Structured Logging

_logger.Information("User {UserId} accessed {Resource} from {IPAddress}", 
 userId, resourceName, ipAddress);

Correlation ID Tracking

// Automatically included when using Serilog.Enrichers.CorrelationId
_logger.Information("Request processed");
// Output: [CorrelationId: abc123] Request processed

Advanced Features

Expression-based Filtering

{
 "Serilog": {
 "Filter": [
 {
 "Name": "ByExcluding",
 "Args": {
 "expression": "RequestPath like '/health%'"
 }
 }
 ]
 }
}

SQL Server Logging

{
 "Serilog": {
 "WriteTo": [
 {
 "Name": "MSSqlServer",
 "Args": {
 "connectionString": "Server=...;Database=Logs;...",
 "tableName": "LogEvents",
 "schemaName": "Logging",
 "autoCreateSqlTable": false
 }
 }
 ]
 }
}

Note: For production environments, it's recommended to use the Infrastructure.Logging.Data project with DbUp for database schema management rather than auto-creating tables.

HTTP Sink

{
 "Serilog": {
 "WriteTo": [
 {
 "Name": "Http",
 "Args": {
 "requestUri": "https://logs.example.com/api/logs",
 "queueLimitBytes": null
 }
 }
 ]
 }
}

Best Practices

1. Use Structured Logging: Pass objects as properties rather than concatenating strings
2. Configure Appropriate Log Levels: Set minimum levels based on environment
3. Include Correlation IDs: Enable correlation ID tracking for distributed systems
4. Use Async Logging: Configure sinks to handle high-volume logging asynchronously
5. Monitor Log Performance: Use appropriate sink configurations for production environments
6. Database Schema Management: Use Infrastructure.Logging.Data with DbUp for production database setup
7. Query Constants: Define SQL queries as C# constants for better maintainability and version control

Contributing

This project is part of the CG Infrastructure Libraries. For contributions, please refer to the main infrastructure repository guidelines.

License

See the LICENSE file in the root directory for licensing information.

Support

For issues and questions related to this library, please contact the development team or create an issue in the project repository.