IAuditContextProvider interface

Namespace: Tenantry.Pro.EfCore · Package: Tenantry.Pro.EfCore · API reference

Says who made the changes a save records, and what ties them to the request or job that made them: the AuditEntry.Actor, AuditEntry.CorrelationId and AuditEntry.Data of each entry.

The default gives no actor, and the current trace's id (Current) as the correlation id. To name the user, register your own, with any lifetime, for example from IHttpContextAccessor in an ASP.NET Core application:

builder.Services.AddHttpContextAccessor();
builder.Services.AddSingleton<IAuditContextProvider, HttpAuditContextProvider>();

It is called once for each save that has changes to record, before the changes are sent, in the code that saves, so a failure stops the save. It is resolved from the saving context's scope (under AddDbContext, the scope the context was created in), or from a scope created for the call when the context has none of its own (pooled, or from an IDbContextFactory): there, read what you need from ambient state, such as IHttpContextAccessor, rather than from scoped services.

public interface IAuditContextProvider

MethodsCopy Anchor Link

GetContext(DbContext)Copy Anchor Link

Gets who is making the changes context is about to save.

AuditContext GetContext(DbContext context)

Parameters:

• context DbContext: The context that is saving.

Returns: AuditContext: The actor, correlation id and data for every entry of the save.