AuditTracker 1.0.1

AuditTracker

AuditTracker is a flexible and extensible library for tracking and logging changes to entities in your application. It supports entity and API auditing, background processing, and fully customizable configuration.

🚀 Features

• Entity Auditing: Automatically logs insert, update, and delete operations on entities.
• API Auditing: Tracks incoming API requests and outgoing responses (optional).
• Background Processing: Supports asynchronous processing of audit logs.
• Customizable Writers: Implement IAuditLogWriter to control how and where audit logs are saved (e.g., database, file, etc.).
• Extensible Options: Configure behavior using AuditLogTrackerOptions.

📦 Requirements

• .NET Version: .NET 8
• C# Version: 12.0

📥 Installation

Install the required NuGet packages:

dotnet add package Microsoft.Extensions.Logging
dotnet add package Microsoft.Extensions.Options

⚙️ Usage

1. Configure Services

In your Startup.cs or Program.cs:

builder.Services.AddAuditLogTracker(options =>
{
	//Add options
});

//Add Provider do you want to use
builder.Services.AddSqlAuditLogWriter(options =>
{
	options.ConnectionString = builder.Configuration.GetConnectionString("SqlServer");
	options.CreateTablesIfNotExist = true;
});

//Add Middleware to track API
app.UseApiAuditLogging();

2. Implement on DbContext

Override SaveChanges method in your DbContext to add handler to track changes

using AuditTracker.Extensions;

public override async Task<int> SaveChangesAsync(CancellationToken cancellationToken = default)
{
	// Track changes before saving them
	this.EnableAuditTracking(
			_auditLogger,
			GetCurrentUserId,
			GetCurrentUsername);

	return await base.SaveChangesAsync(cancellationToken);
}

🛠 Configuration Options

Customize behavior via AuditLogTrackerOptions:

Example:

services.Configure<AuditLogTrackerOptions>(options =>
{
    options.EnableEntityAuditing = true;
    options.EnableApiAuditing = false;
    options.UseBackgroundProcessing = true;
    options.ApplicationName = "MyApplication";
    options.SanitizeRequestResponse = true;
    options.CaptureRequestBody = true;
    options.CaptureResponseBody = true;
    options.CaptureRequestHeaders = true;
    options.CaptureResponseHeaders = true;
    options.IncludedPaths = new[] { "/api/v1/*" };
    options.ExcludedPaths = new[] { "/api/v1/health" };
});

🧩 Extensibility

Custom Entity ID Resolution

The DefaultAuditLogger uses reflection to resolve entity IDs. You can override this by customizing the GetEntityId method.

Ignoring Properties

Override the IsIgnoredProperty method to exclude specific properties from auditing.

🪵 Error Logging

The library uses ILogger to log internal errors. Ensure your application has a configured logging provider.

🤝 Contributing

Contributions are welcome! Feel free to open issues or submit pull requests to improve the library.

Happy auditing! 🎉