Audit.NET.SqlServer 25.0.0

dotnet add package Audit.NET.SqlServer --version 25.0.0
NuGet\Install-Package Audit.NET.SqlServer -Version 25.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="Audit.NET.SqlServer" Version="25.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Audit.NET.SqlServer --version 25.0.0
#r "nuget: Audit.NET.SqlServer, 25.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.
// Install Audit.NET.SqlServer as a Cake Addin
#addin nuget:?package=Audit.NET.SqlServer&version=25.0.0

// Install Audit.NET.SqlServer as a Cake Tool
#tool nuget:?package=Audit.NET.SqlServer&version=25.0.0

Audit.NET.SqlServer

Sql Server provider for Audit.NET library (An extensible framework to audit executing operations in .NET).

Store the audit events in a SQL Table, in JSON format.

Install

NuGet Package To install the package run the following command on the Package Manager Console:

PM> Install-Package Audit.NET.SqlServer

NuGet Status NuGet Count

Usage

Please see the Audit.NET Readme

Configuration

Set the static Audit.Core.Configuration.DataProvider property to set the Sql Server data provider, or call the UseSqlServer method on the fluent configuration. This should be done before any AuditScope creation, i.e. during application startup.

For example:

Audit.Core.Configuration.DataProvider = new SqlDataProvider()
{
    ConnectionString = "data source=localhost;initial catalog=Audit;integrated security=true;",
    Schema = "dbo",
    TableName = "Event",
    IdColumnName = "EventId",
    JsonColumnName = "JsonData",
    LastUpdatedDateColumnName = "LastUpdatedDate",
    CustomColumns = new List<CustomColumn>()
    {
        new CustomColumn("EventType", ev => ev.EventType)
    }
};

Or by using the fluent configuration API:

Audit.Core.Configuration.Setup()
    .UseSqlServer(config => config
        .ConnectionString("data source=localhost;initial catalog=Audit;integrated security=true;")
        .Schema("dbo")
        .TableName("Event")
        .IdColumnName("EventId")
        .JsonColumnName("JsonData")
        .LastUpdatedColumnName("LastUpdatedDate")
        .CustomColumn("EventType", ev => ev.EventType)        
        .CustomColumn("User", ev => ev.Environment.UserName));

You can provide any of the settings as a function of the Audit Event, for example to use a connection string per machine, and different table names:

Audit.Core.Configuration.Setup()
    .UseSqlServer(config => config
        .ConnectionString(ev => GetCnnString(ev.Environment.MachineName))
        .TableName(ev => ev.EventType == "Order" ? "OrderAudits" : "Audits"));

Provider Options

  • ConnectionString: The SQL Server connection string.
  • DbConnection: The DbConnection to use, alternative to ConnectionString when you need more control or configuration over the DB connection. (optional, only for .NET Framework)
  • Schema: The SQL schema for the table. (optional)
  • TableName: The audit events table name.
  • IdColumnName: The column name of the event identifier (the primary key).
  • JsonColumnName: The column name of the event table where the audit event JSON will be stored. (optional)
  • LastUpdatedDateColumnName: The datetime column name to update when replacing events. (optional)
  • CustomColumn: Additional columns to store information from the audit event. (optional)
  • SetDatabaseInitializerNull: To set the database initializer to NULL on the internal DbContext. (optional, only for .NET Framework)
  • DbContextOptions: To set custom options for the internal EntityFramework DbContext (optional, only for .NET Core)

Query events

This provider implements GetEvent and GetEventAsync methods to obtain an audit event by id:

var event = sqlDataProvider.GetEvent(1000);

Table constraints

  • The table should exists.
  • The table should have a single ID column (Unique or Primary key).
  • The type of the ID column should be convertible to NVARCHAR.

For example:

CREATE TABLE [Event]
(
    [EventId] BIGINT IDENTITY(1,1) NOT NULL,
    [InsertedDate] DATETIME NOT NULL DEFAULT(GETUTCDATE()),
    [LastUpdatedDate] DATETIME NULL,
    [JsonData] NVARCHAR(MAX) NOT NULL,
    [EventType] NVARCHAR(100) NOT NULL,
    CONSTRAINT PK_Event PRIMARY KEY (EventId)
)
GO

If you use Azure SQL Server or Sql Server 2016, you can create indexes on the JSON fields, for example creating a schemabinded view:

CREATE VIEW dbo.[v_Event] WITH SCHEMABINDING
AS
SELECT EventId, 
    InsertedDate,
    CAST(JSON_VALUE(JsonData, '$.EventType') AS NVARCHAR(255)) AS [EventType],
    CAST(JSON_VALUE(JsonData, '$.ReferenceId') AS NVARCHAR(255)) AS [ReferenceId],
    JSON_VALUE(JsonData, '$.Target.Type') As [TargetType],
    COALESCE(JSON_VALUE(JsonData, '$.Target.Old'), JSON_QUERY(JsonData, '$.Target.Old')) AS [TargetOld],
    COALESCE(JSON_VALUE(JsonData, '$.Target.New'), JSON_QUERY(JsonData, '$.Target.New')) AS [TargetNew],
    JSON_QUERY(JsonData, '$.Comments') AS [Comments],
    [JsonData]
FROM dbo.[Event]
GO

CREATE UNIQUE CLUSTERED INDEX PK_V_EVENT ON [v_Event] (EventId)
GO
CREATE INDEX IX_V_EVENT_EventType_ReferenceId ON [v_Event] (EventType, ReferenceId)
GO
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  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 is compatible.  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 is compatible.  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. 
.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 is compatible. 
.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)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (3)

Showing the top 3 NuGet packages that depend on Audit.NET.SqlServer:

Package Downloads
RezisFramework

Package Description

Jetstream.Infrastructure.Audit

Project that contains the classes and interfaces used in creating a base auditing structure for API projects.

Tamimi.QService.Audit

Package Description

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
25.0.0 335 2/16/2024
24.0.1 561 2/12/2024
24.0.0 81 2/12/2024
23.0.0 6,097 12/14/2023
22.1.0 888 12/9/2023
22.0.2 2,044 12/1/2023
22.0.1 1,921 11/16/2023
22.0.0 716 11/14/2023
21.1.0 9,202 10/9/2023
21.0.4 5,878 9/15/2023
21.0.3 24,555 7/9/2023
21.0.2 316 7/6/2023
21.0.1 9,911 5/27/2023
21.0.0 10,571 4/15/2023
20.2.4 14,295 3/27/2023
20.2.3 3,060 3/17/2023
20.2.2 1,618 3/14/2023
20.2.1 3,323 3/11/2023
20.2.0 605 3/7/2023
20.1.6 3,079 2/23/2023
20.1.5 20,715 2/9/2023
20.1.4 3,203 1/28/2023
20.1.3 11,060 12/21/2022
20.1.2 10,824 12/14/2022
20.1.1 704 12/12/2022
20.1.0 1,042 12/4/2022
20.0.4 1,937 11/30/2022
20.0.3 6,706 10/28/2022
20.0.2 1,222 10/26/2022
20.0.1 1,044 10/21/2022
20.0.0 115,552 10/1/2022
19.4.1 18,757 9/10/2022
19.4.0 9,409 9/2/2022
19.3.0 14,217 8/23/2022
19.2.2 4,534 8/11/2022
19.2.1 3,925 8/6/2022
19.2.0 8,444 7/24/2022
19.1.4 27,818 5/23/2022
19.1.3 648 5/22/2022
19.1.2 752 5/18/2022
19.1.1 12,754 4/28/2022
19.1.0 6,521 4/10/2022
19.0.7 26,424 3/13/2022
19.0.6 2,877 3/7/2022
19.0.5 61,365 1/28/2022
19.0.4 3,586 1/23/2022
19.0.3 25,726 12/14/2021
19.0.2 610 12/11/2021
19.0.1 10,166 11/20/2021
19.0.0 2,805 11/11/2021
19.0.0-rc.net60.2 276 9/26/2021
19.0.0-rc.net60.1 219 9/16/2021
18.1.6 16,335 9/26/2021
18.1.5 4,463 9/7/2021
18.1.4 1,169 9/6/2021
18.1.3 4,452 8/19/2021
18.1.2 2,368 8/8/2021
18.1.1 1,043 8/5/2021
18.1.0 3,077 8/1/2021
18.0.1 2,406 7/30/2021
18.0.0 1,904 7/26/2021
17.0.8 3,554 7/7/2021
17.0.7 6,811 6/16/2021
17.0.6 1,506 6/5/2021
17.0.5 1,886 5/28/2021
17.0.4 6,454 5/4/2021
17.0.3 848 5/1/2021
17.0.2 1,016 4/22/2021
17.0.1 1,712 4/18/2021
17.0.0 5,000 3/26/2021
16.5.6 3,090 3/25/2021
16.5.5 1,730 3/23/2021
16.5.4 2,228 3/9/2021
16.5.3 7,242 2/26/2021
16.5.2 1,258 2/23/2021
16.5.1 779 2/21/2021
16.5.0 646 2/17/2021
16.4.5 754 2/15/2021
16.4.4 4,454 2/5/2021
16.4.3 5,465 1/27/2021
16.4.2 3,511 1/22/2021
16.4.1 1,650 1/21/2021
16.4.0 12,863 1/11/2021
16.3.3 713 1/8/2021
16.3.2 1,006 1/3/2021
16.3.1 887 12/31/2020
16.3.0 15,271 12/30/2020
16.2.1 2,520 12/27/2020
16.2.0 27,088 10/13/2020
16.1.5 3,762 10/4/2020
16.1.4 4,448 9/17/2020
16.1.3 1,591 9/13/2020
16.1.2 1,073 9/9/2020
16.1.1 1,735 9/3/2020
16.1.0 3,563 8/19/2020
16.0.3 767 8/15/2020
16.0.2 7,013 8/9/2020
16.0.1 975 8/8/2020
16.0.0 11,268 8/7/2020
15.3.0 35,177 7/23/2020
15.2.3 2,705 7/14/2020
15.2.2 37,394 5/19/2020
15.2.1 7,887 5/12/2020
15.2.0 1,512 5/9/2020
15.1.1 15,118 5/4/2020
15.1.0 4,395 4/13/2020
15.0.5 16,825 3/18/2020
15.0.4 2,416 2/28/2020
15.0.3 1,179 2/26/2020
15.0.2 6,657 1/20/2020
15.0.1 1,848 1/10/2020
15.0.0 4,298 12/17/2019
14.9.1 7,031 11/30/2019
14.9.0 775 11/29/2019
14.8.1 1,132 11/26/2019
14.8.0 11,303 11/20/2019
14.7.0 33,851 10/9/2019
14.6.6 836 10/8/2019
14.6.5 4,619 9/27/2019
14.6.4 742 9/21/2019
14.6.3 12,889 8/12/2019
14.6.2 2,277 8/3/2019
14.6.1 353 8/3/2019
14.6.0 15,265 7/26/2019
14.5.7 3,491 7/18/2019
14.5.6 4,054 7/10/2019
14.5.5 1,218 7/1/2019
14.5.4 1,224 6/17/2019
14.5.3 15,124 6/5/2019
14.5.2 19,117 5/30/2019
14.5.1 1,311 5/28/2019
14.5.0 1,429 5/24/2019
14.4.0 1,873 5/22/2019
14.3.4 3,580 5/14/2019
14.3.3 2,549 5/9/2019
14.3.2 1,315 4/30/2019
14.3.1 948 4/27/2019
14.3.0 1,106 4/24/2019
14.2.3 6,933 4/17/2019
14.2.2 996 4/10/2019
14.2.1 925 4/5/2019
14.2.0 3,377 3/16/2019
14.1.1 935 3/8/2019
14.1.0 4,737 2/11/2019
14.0.4 2,149 1/31/2019
14.0.3 1,606 1/22/2019
14.0.2 10,558 12/15/2018
14.0.1 2,162 11/29/2018
14.0.0 1,374 11/19/2018
13.3.0 1,142 11/16/2018
13.2.2 1,003 11/15/2018
13.2.1 1,730 11/13/2018
13.2.0 2,352 10/31/2018
13.1.5 1,145 10/31/2018
13.1.4 7,191 10/25/2018
13.1.3 1,286 10/18/2018
13.1.2 4,581 9/12/2018
13.1.1 1,355 9/11/2018
13.1.0 1,045 9/11/2018
13.0.0 7,286 8/29/2018
12.3.6 1,174 8/29/2018
12.3.5 32,954 8/22/2018
12.3.4 1,152 8/21/2018
12.3.3 25,952 8/21/2018
12.3.2 1,194 8/20/2018
12.3.1 1,137 8/20/2018
12.3.0 1,106 8/20/2018
12.2.2 2,495 8/15/2018
12.2.1 3,723 8/9/2018
12.2.0 1,217 8/8/2018
12.1.11 1,934 7/30/2018
12.1.10 1,217 7/20/2018
12.1.9 1,546 7/10/2018
12.1.8 1,376 7/2/2018
12.1.7 4,639 6/7/2018
12.1.6 4,035 6/4/2018
12.1.5 1,561 6/2/2018
12.1.4 1,688 5/25/2018
12.1.3 2,667 5/16/2018
12.1.2 1,408 5/15/2018
12.1.1 1,411 5/14/2018
12.1.0 1,808 5/9/2018
12.0.7 1,485 5/5/2018
12.0.6 1,428 5/4/2018
12.0.5 1,408 5/3/2018
12.0.4 1,438 4/30/2018
12.0.3 1,475 4/30/2018
12.0.2 1,421 4/27/2018
12.0.1 1,547 4/25/2018
12.0.0 1,284 4/22/2018
11.2.0 1,925 4/11/2018
11.1.0 10,011 4/8/2018
11.0.8 1,506 3/26/2018
11.0.7 1,434 3/20/2018
11.0.6 4,800 3/7/2018
11.0.5 1,545 2/22/2018
11.0.4 2,392 2/14/2018
11.0.3 1,442 2/12/2018
11.0.2 1,482 2/9/2018
11.0.1 2,839 1/29/2018
11.0.0 2,051 1/15/2018
10.0.3 2,310 12/29/2017
10.0.2 1,320 12/26/2017
10.0.1 1,502 12/18/2017
10.0.0 1,267 12/18/2017
9.3.0 1,418 12/17/2017
9.2.0 1,280 12/17/2017
9.1.3 3,585 12/5/2017
9.1.2 1,667 11/27/2017
9.1.1 1,963 11/21/2017
9.1.0 1,290 11/21/2017
9.0.1 1,400 11/11/2017
9.0.0 1,287 11/10/2017
8.7.0 1,371 11/9/2017
8.6.0 1,274 11/9/2017
8.5.0 9,153 10/3/2017
8.4.0 1,284 10/3/2017
8.3.1 5,032 9/8/2017
8.3.0 1,325 9/8/2017
8.2.0 1,346 9/4/2017
8.1.0 1,980 8/22/2017
8.0.0 1,510 8/19/2017
7.1.3 1,432 8/14/2017
7.1.2 1,791 8/2/2017
7.1.1 1,705 7/26/2017
7.1.0 2,580 7/5/2017
7.0.9 1,429 6/28/2017
7.0.8 1,522 6/19/2017
7.0.6 11,253 4/7/2017
7.0.5 1,484 3/21/2017
7.0.4 1,403 3/21/2017
7.0.3 1,415 3/20/2017
7.0.2 1,508 3/13/2017
7.0.0 1,607 3/1/2017
6.2.0 3,119 2/25/2017
6.1.0 5,459 2/14/2017
6.0.0 1,419 2/9/2017
5.3.0 1,287 2/5/2017
5.2.0 1,780 1/26/2017
5.1.0 1,287 1/19/2017
5.0.0 1,289 1/7/2017
4.11.0 1,253 1/5/2017
4.10.0 1,229 12/31/2016
4.9.0 1,256 12/26/2016
4.8.0 1,307 12/17/2016
4.7.0 1,368 12/8/2016
4.6.5 1,308 12/4/2016
4.6.4 1,377 11/25/2016
4.6.2 1,373 11/18/2016
4.6.1 1,302 11/15/2016
4.6.0 1,251 11/11/2016
4.5.9 1,715 11/2/2016
4.5.8 1,255 11/2/2016
4.5.7 1,305 10/26/2016
4.5.6 1,383 10/6/2016
4.5.5 1,319 10/3/2016
4.5.4 1,268 10/2/2016
4.5.3 1,251 9/30/2016
4.5.2 1,275 9/28/2016
4.5.1 1,230 9/28/2016
4.5.0 1,252 9/28/2016
4.4.0 1,394 9/23/2016
4.3.0 1,395 9/22/2016
4.2.0 1,539 9/19/2016
4.1.0 1,262 9/13/2016
4.0.1 1,222 9/9/2016
4.0.0 1,242 9/9/2016
3.6.0 1,266 9/7/2016
3.4.0 1,278 9/7/2016
3.3.0 1,249 9/4/2016
3.2.0 1,223 9/3/2016
3.1.0 1,287 9/2/2016
3.0.0 1,518 8/31/2016
2.6.0 1,314 8/29/2016
2.5.0 1,285 8/27/2016
2.4.0 1,545 8/26/2016
2.3.0 1,216 8/23/2016
2.1.0 1,266 8/22/2016
2.0.0 1,300 8/21/2016
1.0.0.4 1,305 8/19/2016
1.0.0.3 1,506 8/18/2016
1.0.0.2 1,601 8/18/2016
1.0.0.1 1,272 8/18/2016
1.0.0 1,525 8/18/2016