Clywell.Core.Audit.EntityFramework
1.0.1
dotnet add package Clywell.Core.Audit.EntityFramework --version 1.0.1
NuGet\Install-Package Clywell.Core.Audit.EntityFramework -Version 1.0.1
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="Clywell.Core.Audit.EntityFramework" Version="1.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Clywell.Core.Audit.EntityFramework" Version="1.0.1" />
<PackageReference Include="Clywell.Core.Audit.EntityFramework" />
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 Clywell.Core.Audit.EntityFramework --version 1.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Clywell.Core.Audit.EntityFramework, 1.0.1"
#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 Clywell.Core.Audit.EntityFramework@1.0.1
#: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=Clywell.Core.Audit.EntityFramework&version=1.0.1
#tool nuget:?package=Clywell.Core.Audit.EntityFramework&version=1.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Clywell.Core.Audit
Audit trail abstractions and EF Core implementation for .NET — entity change tracking, manual audit logging, and pluggable audit persistence.
Installation
dotnet add package Clywell.Core.Audit
For automatic EF Core change tracking:
dotnet add package Clywell.Core.Audit.EntityFramework
Packages
| Package | Description |
|---|---|
Clywell.Core.Audit |
Audit abstractions — models, interfaces, and direct audit API. Zero infrastructure dependency. |
Clywell.Core.Audit.EntityFramework |
EF Core implementation — automatic change tracking via SaveChangesInterceptor. |
Quick Start
Manual Audit Logging
services.AddAudit();
services.AddScoped<IAuditLogger, MyAuditLogger>();
Implement IAuditLogger to define where audit records are persisted:
public class MyAuditLogger : IAuditLogger
{
public Task LogAsync(IReadOnlyList<AuditEntry> entries, CancellationToken ct)
{
// Persist to database, queue, file, etc.
return Task.CompletedTask;
}
}
Automatic EF Core Change Tracking
services.AddAudit(options =>
{
options.AuditOnly<Order>();
options.AuditOnly<Product>();
});
services.AddScoped<IAuditLogger, MyAuditLogger>();
services.AddAuditEntityFramework();
services.AddDbContext<AppDbContext>((sp, options) =>
{
options.UseSqlServer(connectionString)
.UseAuditInterceptor(sp);
});
Notes
IAuditLoggeris required. Register your implementation in DI before writing audit records.SaveChangesAsyncis required for EF interception. SynchronousSaveChanges()is intentionally not supported byAuditSaveChangesInterceptor.AddAuditEntityFramework()registers the interceptor; attach it to each DbContext withUseAuditInterceptor(sp).
Compatibility
- .NET target:
net10.0 - EF integration dependency:
Microsoft.EntityFrameworkCore
Key Concepts
- Delta-only tracking: For
Updatedactions, only properties that actually changed are recorded. - Scoped resolution: The interceptor is a singleton but resolves
IAuditLogger,IAuditUserProvider, andIAuditTimestampProviderper-invocation — safe for scoped dependencies. - Database-generated keys: For
Createdactions with identity columns,EntityIdreflects the temporary key (e.g.,"0") since interception occurs before the database assigns the final value.
License
MIT — see LICENSE.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net10.0 is compatible. 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. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net10.0
- Clywell.Core.Audit (>= 1.0.1)
- Microsoft.EntityFrameworkCore (>= 10.0.5)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.