BrainEnterprise.Library.LLBLGen.Audit 1.0.0

Prefix Reserved
dotnet add package BrainEnterprise.Library.LLBLGen.Audit --version 1.0.0
                    
NuGet\Install-Package BrainEnterprise.Library.LLBLGen.Audit -Version 1.0.0
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="BrainEnterprise.Library.LLBLGen.Audit" Version="1.0.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="BrainEnterprise.Library.LLBLGen.Audit" Version="1.0.0" />
                    
Directory.Packages.props
<PackageReference Include="BrainEnterprise.Library.LLBLGen.Audit" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add BrainEnterprise.Library.LLBLGen.Audit --version 1.0.0
                    
#r "nuget: BrainEnterprise.Library.LLBLGen.Audit, 1.0.0"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package BrainEnterprise.Library.LLBLGen.Audit@1.0.0
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=BrainEnterprise.Library.LLBLGen.Audit&version=1.0.0
                    
Install as a Cake Addin
#tool nuget:?package=BrainEnterprise.Library.LLBLGen.Audit&version=1.0.0
                    
Install as a Cake Tool

BrainEnterprise.Library.LLBLGen.Audit

Libreria per il tracciamento automatico delle modifiche alle Entity LLBLGen Pro su file JSON.

Funzionalita'

  • Traccia operazioni Insert, Update e Delete sulle Entity
  • Salvataggio su file JSON con rotazione giornaliera
  • Filtri configurabili per entita', campi e tipi di operazione
  • Supporto per whitelist/blacklist di entita'
  • Identificazione applicazione, versione e ambiente
  • Personalizzazione dell'utente corrente tramite callback

Installazione

Aggiungere il riferimento al progetto e la dipendenza a LLBLGen Pro Runtime.

Utilizzo

Configurazione Base

// Inizializzazione semplice con ApplicationId
AuditConfiguration.Initialize("MyApp");

// Assegnare l'auditor all'adapter
using (var adapter = new DataAccessAdapter())
{
    adapter.Auditor = AuditConfiguration.CreateAuditor();
    // ... operazioni CRUD
}

Configurazione con Builder Fluent

AuditConfiguration.Configure()
    .WithApplication("MyApp", "1.0.0", "Production")
    .WithLogDirectory("C:\\Logs\\Audit")
    .WithFilePattern("audit_{date}.json")
    .OnlyEntities("CustomerEntity", "OrderEntity")      // Whitelist
    .ExcludeFields("Password", "CreditCardNumber")      // Esclusione globale
    .ExcludeFieldsFor("UserEntity", "PasswordHash")     // Esclusione per entita'
    .ExcludeDeletes()                                   // Solo Insert e Update
    .Apply();

Configurazione Manuale Completa

var config = new AuditFilterConfig
{
    ApplicationId = "MyApp",
    ApplicationVersion = "1.0.0",
    EnvironmentName = "Production",
    FilterMode = AuditFilterMode.WhiteListOnly,
    EntityNames = new HashSet<string> { "CustomerEntity", "OrderEntity" },
    GlobalExcludedFields = new HashSet<string> { "Password", "ModifiedDate" },
    AuditedOperations = new HashSet<AuditOperationType>
    {
        AuditOperationType.Insert,
        AuditOperationType.Update
    }
};

AuditConfiguration.Initialize("AuditLogs", "audit_{date}.json", config);

Personalizzazione Utente Corrente

Per default viene usato System.Environment.UserName. E' possibile personalizzare l'utente tramite la proprieta' GetCurrentUserFunc:

var config = new AuditFilterConfig
{
    ApplicationId = "MyWebApp",
    GetCurrentUserFunc = () => HttpContext.Current?.User?.Identity?.Name
};

AuditConfiguration.Initialize("AuditLogs", "audit_{date}.json", config);

Oppure con un sistema di autenticazione personalizzato:

config.GetCurrentUserFunc = () =>
    SecurityContext.CurrentSession?.PrimaryUser?.Name ?? "Anonymous";

Modalita' di Filtro

Modalita' Descrizione
AuditAll Audita tutte le entita' (default)
WhiteListOnly Audita solo le entita' specificate
BlackListExclude Audita tutte tranne le entita' specificate

Formato Output JSON

Ogni riga del file di log e' un oggetto JSON:

{
  "applicationId": "MyApp",
  "applicationVersion": "1.0.0",
  "environmentName": "Production",
  "timestamp": "2024-01-15 10:30:45.123",
  "userName": "john.doe",
  "machineName": "SERVER01",
  "entityName": "CustomerEntity",
  "operationType": "Insert",
  "primaryKeyValues": { "Id": 123 },
  "entitySnapshot": { "Id": 123, "Name": "Acme Corp", "Email": "info@acme.com" }
}

Tipi di Operazione

Tipo Descrizione
Insert Nuova entita' inserita (include snapshot completo)
FieldChange Singolo campo modificato (include OldValue e NewValue)
UpdateCompleted Update completato (include conteggio campi modificati)
Delete Entita' eliminata (include snapshot completo)

Struttura File

BrainEnterprise.Library.LLBLGen.Audit/
├── AuditConfiguration.cs      # Configurazione statica e factory
├── AuditConfigBuilder.cs      # Builder fluent
├── AuditFilterConfig.cs       # Classe di configurazione filtri
├── AuditFilterMode.cs         # Enum modalita' filtro
├── AuditOperationType.cs      # Enum tipi operazione
├── AuditEntry.cs              # Modello entry di audit
└── FileAuditor.cs             # Implementazione IAuditor

Dipendenze

  • LLBLGen Pro Runtime Framework
  • Newtonsoft.Json

Note

  • I file di log vengono creati automaticamente nella directory specificata
  • Il pattern {date} nel nome file viene sostituito con la data corrente (yyyy-MM-dd)
  • I valori binari vengono rappresentati come [Binary: N bytes]
  • Le date vengono formattate come yyyy-MM-dd HH:mm:ss.fff
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 is compatible.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.0 175 2/5/2026

First release of BrainEnterprise.Library.LLBLGen.Audit