Levge.AuditLog 2.3.0

Levge.AuditLog

EF Core ISaveChangesInterceptor tabanlı, yüksek performanslı ve esnek otomatik denetim kaydı (audit log) altyapısı.
.NET 10+ ve EF Core 10+ için optimize edilmiştir.

Özellikler

• Kalıtımsız Entegrasyon: IdentityDbContext gibi mevcut hiyerarşileri bozmadan IAuditableDbContext ile entegre olur.
• Otomatik Metadata: IAuditable ve ISoftDeletable varlıklarını otomatik yakalar.
• Soft Delete Desteği: Delete işlemlerini otomatik olarak IsDeleted güncellemesine çevirir ve audit log'a "Delete" olarak işler.
• Performans: ExecuteDeleteAsync ile toplu temizleme ve optimize edilmiş indexler.
• Esneklik: Belirli entity'leri audit dışı bırakma ve dinamik olarak audit log yazımını durdurma.
• Bileşik PK Desteği: Bileşik birincil anahtarlar JSON olarak saklanır.

İçindekiler

• Kurulum
• Hızlı Başlangıç (Seçenek A)
• Gelişmiş Entegrasyon (Seçenek B)
• Yapılandırma (Program.cs)
• Varlık Tanımlama
• AuditLogEntry Şeması
• IAuditLogService Kullanımı
• Arka Plan Temizleme Jobu
• Önemli Notlar ve İpuçları

Kurulum

dotnet add package Levge.AuditLog

Not: Bu paket Levge.Identity ve Levge.Domain paketlerine bağımlıdır. Projenizde bu paketlerin de kurulu olduğundan emin olun.

Hızlı Başlangıç (Seçenek A) — LevgeAuditDbContext ile

Eğer yeni bir projeye başlıyorsanız veya mevcut bir base DbContext'iniz yoksa:

using Levge.AuditLog.DbContexts;
using Microsoft.EntityFrameworkCore;

public class AppDbContext : LevgeAuditDbContext
{
    public AppDbContext(DbContextOptions<AppDbContext> options) : base(options) { }

    public DbSet<Order> Orders { get; set; } = null!;

    // Belirli entity'leri audit dışı bırakmak için:
    public override HashSet<Type> ExcludedAuditEntities { get; } = [typeof(InternalLog)];
}

Gelişmiş Entegrasyon (Seçenek B) — IAuditableDbContext ile

IdentityDbContext veya MultiTenantDbContext gibi başka bir sınıftan türetilen mevcut yapılar için:

using Levge.AuditLog.Entities;
using Levge.AuditLog.Interfaces;
using Microsoft.AspNetCore.Identity.EntityFrameworkCore;
using Microsoft.EntityFrameworkCore;

public class AppDbContext : IdentityDbContext<AppUser>, IAuditableDbContext
{
    public AppDbContext(DbContextOptions<AppDbContext> options) : base(options) { }

    // IAuditableDbContext Implementasyonu
    public DbSet<AuditLogEntry> AuditLogs { get; set; } = null!;
    public bool UseAuditLogs { get; set; } = true;
    public HashSet<Type> ExcludedAuditEntities { get; } = [];

    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        base.OnModelCreating(modelBuilder);
        
        // Performans indexlerini ve tablo yapılandırmasını ekle
        modelBuilder.ConfigureLevgeAuditLog();
    }
}

Yapılandırma (Program.cs)

var builder = WebApplication.CreateBuilder(args);

// 1. AuditLog servislerini kaydet
builder.Services.AddLevgeAuditLog<AppDbContext>(opt =>
{
    opt.EnableCleanupJob = true; // Eski kayıtları otomatik sil
    opt.RetentionDays    = 90;   // 90 günlük kayıt tut
    opt.CleanupTime      = new TimeOnly(3, 0); // UTC 03:00'da çalıştır
});

// 2. DbContext'e Interceptor'ı bağla
builder.Services.AddDbContext<AppDbContext>((sp, opt) =>
    opt.UseNpgsql(builder.Configuration.GetConnectionString("Default"))
       .AddLevgeAuditInterceptors(sp)); // ← Kritik: Interceptor kaydı

// 3. ICurrentUser için Identity yapılandırması gereklidir
builder.Services.AddLevgeIdentity(jwtOptions); 

Varlık Tanımlama

Audit log tutulmasını istediğiniz varlıkların IAuditable interface'ini implemente etmesi yeterlidir.

public class Product : IAuditable, ISoftDeletable
{
    public long Id { get; set; }
    public string Name { get; set; } = null!;

    // Otomatik yönetilen alanlar
    public DateTime CreatedAt { get; set; }
    public long CreatedByUserId { get; set; }
    public DateTime? UpdatedAt { get; set; }
    public long? UpdatedByUserId { get; set; }
    
    public bool IsDeleted { get; set; }
    public DateTime? DeletedAt { get; set; }
    public long? DeletedByUserId { get; set; }
}

AuditLogEntry Şeması

IAuditLogService Kullanımı

public class OrderService(IAuditLogService auditLogService)
{
    public async Task<List<AuditLogEntry>> GetOrderHistory(long orderId)
    {
        // "Orders" tablosundaki belirli bir kaydın geçmişini getirir
        return await auditLogService.GetLogsByObjectAsync("Orders", orderId);
    }
}

Arka Plan Temizleme Jobu

EnableCleanupJob = true olarak yapılandırıldığında, sistem her gün belirlenen saatte çalışarak RetentionDays süresinden eski kayıtları kalıcı olarak siler. Bu işlem ExecuteDeleteAsync kullandığı için milyonlarca kayıtta dahi veritabanını yormaz.

Önemli Notlar ve İpuçları

• Bileşik Anahtarlar: Eğer bir entity bileşik anahtara (Composite Key) sahipse, EntityId alanı null olur ve tüm anahtar değerleri KeyValues kolonunda JSON olarak saklanır.
• Tenant Desteği: Paket, çok kiracılı (multi-tenant) yapılarda kiracı filtrelerine uyumludur. Ancak AuditLogEntry tablosunun kendisinde TenantId bulunmaz; eğer logları kiracı bazlı izole etmek isterseniz, IAuditableDbContext.AuditLogs üzerinde Global Query Filter tanımlayabilirsiniz.
• Entity Exclusion: Hassas veriler içeren tabloları (ör. PasswordHashes) audit dışında bırakmak için ExcludedAuditEntities listesini kullanın.
• Performans: ConfigureLevgeAuditLog metodu; TableName, EntityId, ChangedByUserId ve ChangedAt alanlarına otomatik index ekler.
• ICurrentUser: Levge.Identity üzerinden gelen ICurrentUser.UserId değeri null ise (ör. bir background job işlemi), CreatedByUserId değeri varsayılan olarak 0 atanır.