RG.AuditTrail 1.1.0

RG.AuditTrail

✨ Features

• Insert / Update / Delete actions
• Old Values and New Values
• Logged-in Username from JWT token
• Timestamp and Table Name
• Correlation ID tracking
• User, IP & request tracking
• Plug & Play integration
• Works with custom DbContext

📦 Installation

dotnet add package RG.AuditTrail

RG.AuditTrail with JWT Authentication }

🔹 Step 1: Register Services

📂 File: Program.cs

csharp

NameSpaces in PROGRAM.CS

📂 File: Program.cs

using AuditTrail.core.Extensions;
using AuditTrail.core.Helpers;
using AuditTrail.core.Interceptor;
using AuditTrail.core.Interfaces;
using AuditTrail.core.Services;
using AuditTrailWithJWT.Data;

Database Connection in PROGRAM.CS

📂 File: Program.cs

builder.Services.AddDbContext<AppDbContext>((provider, options) =>
{
    options.UseSqlServer(
        builder.Configuration.GetConnectionString("Connection"))
    .UseAuditTrail(provider); 
});

Required Services in PROGRAM.CS

📂 File: Program.cs

builder.Services.AddHttpContextAccessor();
builder.Services.AddScoped<HttpContextHelper>();
builder.Services.AddScoped<IAuditService, AuditService>();
builder.Services.AddScoped<AuditSaveChangesInterceptor>();
builder.Services.AddScoped<IAuditDbContext>(sp =>sp.GetRequiredService<AppDbContext>());

Add Middleware (IMPORTANT ORDER) in PROGRAM.CS

📂 File: Program.cs

app.UseAuthentication();
app.UseAuthorization();

app.UseCorrelationId();   // 🔥 MUST be first
app.UseAuditTrail();      // 🔥 Then audit logging

🔹 Step 2: Create AuditLog Table Model create a model otherwise use service on PROGRAM.CS file (Optional if not exists)

builder.Services.AddScoped<IAuditDbContext>(sp ⇒sp.GetRequiredService<AppDbContext>());

📂 File: Models/AuditLog.cs

public class AuditLog
{
    public long Id { get; set; }
    public string? UserId { get; set; }
    public string? Action { get; set; }
    public string? TableName { get; set; }
    public string? RecordId { get; set; }
    public string? OldValues { get; set; }
    public string? NewValues { get; set; }
    public DateTime CreatedAt { get; set; }
    public string? IpAddress { get; set; }
    public string? CorrelationId { get; set; }
}

🔹 Step 3: Implement DbContext

📂 File: Data/AppDbContext.cs

using AuditTrail.core.Interfaces;
using AuditTrail.core.Models;

public class AppDbContext : DbContext, IAuditDbContext
{
    public AppDbContext(DbContextOptions<AppDbContext> options)
        : base(options)
    {
    }

    public DbSet<AuditLog> AuditLogs { get; set; }   
}

🔹 Step 4: JWT Claims Required

var claims = new[]
{
    new Claim(ClaimTypes.NameIdentifier, user.Id.ToString()),
    new Claim(ClaimTypes.Name, user.Name),
    new Claim(ClaimTypes.Role, user.Role)
};

RG.AuditTrail (with out JWT Authentication) }

🔹 Step 1: Program.cs

Requied NAMESPACES in PROGRAM.CS 📂 File: Program.cs

using ActivitylogTest.Data;
using AuditTrail.core.Extensions;
using AuditTrail.core.Interfaces;

Required Database Connection in PROGRAM.CS 📂 File: Program.cs

builder.Services.AddDbContext<AppDbContext>((provider, options) =>
{
    options.UseSqlServer(builder.Configuration.GetConnectionString("SimpleConn"))
           .UseAuditTrail(provider);
});

Required Services in PROGRAM.CS 📂 File: Program.cs

builder.Services.AddScoped<IAuditDbContext>(provider => provider.GetRequiredService<AppDbContext>());
builder.Services.AddAuditTrail();

Required middleware in PROGRAM.CS 📂 File: Program.cs

app.UseCorrelationId();
app.UseAuditTrail();

🔹 Step 2: Add this line in dbContext File

📂 File: Data/AppDbContext.cs

    using AuditTrail.core.Interfaces;
    using AuditTrail.core.Models;

    public class AppDbContext : DbContext, IAuditDbContext
          {
              public AppDbContext(DbContextOptions<AppDbContext> options)
                  : base(options)
              {
              }
          
              public DbSet<AuditLog> AuditLogs { get; set; }   
          }

🧪 Example Flow

1. User sends request

2. CorrelationId middleware generates unique ID

3. Audit middleware captures:

   • User
   • IP Address
   • API endpoint
   • Status code

4. Data saved into AuditLogs table

📊 Sample Output (Database)

⚠️ Important Notes

• Middleware order must be correct
• DbContext must implement IAuditDbContext
• CorrelationId helps track request across services

📌 Requirements

• .NET 8+
• Entity Framework Core

👨‍💻 Author

Raj Gupta

⭐ Support

If you like this package, give it a ⭐ on GitHub!