Audit.NET.SqlServer 27.5.3

There is a newer version of this package available.
See the version list below for details.
dotnet add package Audit.NET.SqlServer --version 27.5.3
                    
NuGet\Install-Package Audit.NET.SqlServer -Version 27.5.3
                    
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="27.5.3" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Audit.NET.SqlServer" Version="27.5.3" />
                    
Directory.Packages.props
<PackageReference Include="Audit.NET.SqlServer" />
                    
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 Audit.NET.SqlServer --version 27.5.3
                    
#r "nuget: Audit.NET.SqlServer, 27.5.3"
                    
#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.
#addin nuget:?package=Audit.NET.SqlServer&version=27.5.3
                    
Install Audit.NET.SqlServer as a Cake Addin
#tool nuget:?package=Audit.NET.SqlServer&version=27.5.3
                    
Install Audit.NET.SqlServer as a Cake Tool

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.
  • DbContextOptions: To set custom options to use with the default Audit EF DbContext. This setting is ignored if a DbContext instance is provided.
  • DbContext: Specifies a custom EntityFramework DbContext for querying and inserting audit events. When this option is provided, the ConnectionString, DbConnection, and DbContextOptions settings are ignored.
  • 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)

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

ZZZ Projects - Sponsorship

Entity Framework Extensions and Dapper Plus are major sponsors and are proud to contribute to the development of Audit.NET

Combine the power of auditing with the speed of Bulk Operations to get the best of both worlds — audit and performance.

Entity Framework Extensions - Sponsor

Dapper Plus - Sponsor

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.  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 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)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (5)

Showing the top 5 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

Segugio

Una libreria per la gestione di audit con più provider.

iClick.Infrastructure

iClick.Infrastructure serves as the foundational layer of the iClick application, providing core infrastructure services such as database access, external service integrations, background job handling, and repository implementations. It acts as the bridge between the domain and external systems, ensuring clean separation of concerns and adherence to scalable architecture principles.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
30.0.1 1,707 25 days ago
30.0.0 476 a month ago
29.0.1 2,244 a month ago
29.0.0 2,389 2 months ago
28.0.0 1,528 2 months ago
27.5.3 1,849 2 months ago
27.5.2 2,480 2 months ago
27.5.1 548 3 months ago
27.5.0 12,413 4 months ago
27.4.1 7,101 4 months ago
27.4.0 3,083 5 months ago
27.3.3 14,801 5 months ago
27.3.2 19,493 6 months ago
27.3.1 201 6 months ago
27.3.0 1,293 7 months ago
27.2.0 35,025 7 months ago
27.1.1 39,349 8 months ago
27.1.0 1,187 8 months ago
27.0.3 24,083 9 months ago
27.0.2 8,349 9 months ago
27.0.1 44,172 10 months ago
27.0.0 1,689 10 months ago
26.0.1 14,882 8/22/2024
26.0.0 28,952 7/19/2024
25.0.7 79,854 7/4/2024
25.0.6 2,762 6/24/2024
25.0.5 6,496 6/18/2024
25.0.4 125,307 3/24/2024
25.0.3 2,523 3/13/2024
25.0.2 253 3/12/2024
25.0.1 4,263 2/28/2024
25.0.0 8,662 2/16/2024
24.0.1 3,807 2/12/2024
24.0.0 155 2/12/2024
23.0.0 24,951 12/14/2023
22.1.0 2,960 12/9/2023
22.0.2 2,286 12/1/2023
22.0.1 5,057 11/16/2023
22.0.0 3,356 11/14/2023
21.1.0 14,940 10/9/2023
21.0.4 22,018 9/15/2023
21.0.3 68,149 7/9/2023
21.0.2 388 7/6/2023
21.0.1 12,248 5/27/2023
21.0.0 21,117 4/15/2023
20.2.4 21,171 3/27/2023
20.2.3 8,286 3/17/2023
20.2.2 2,337 3/14/2023
20.2.1 5,908 3/11/2023
20.2.0 1,835 3/7/2023
20.1.6 6,036 2/23/2023
20.1.5 22,840 2/9/2023
20.1.4 3,913 1/28/2023
20.1.3 14,376 12/21/2022
20.1.2 12,080 12/14/2022
20.1.1 836 12/12/2022
20.1.0 1,449 12/4/2022
20.0.4 2,453 11/30/2022
20.0.3 7,792 10/28/2022
20.0.2 1,634 10/26/2022
20.0.1 1,225 10/21/2022
20.0.0 177,782 10/1/2022
19.4.1 27,018 9/10/2022
19.4.0 11,542 9/2/2022
19.3.0 18,059 8/23/2022
19.2.2 5,687 8/11/2022
19.2.1 6,451 8/6/2022
19.2.0 22,402 7/24/2022
19.1.4 38,842 5/23/2022
19.1.3 718 5/22/2022
19.1.2 849 5/18/2022
19.1.1 21,103 4/28/2022
19.1.0 6,961 4/10/2022
19.0.7 30,695 3/13/2022
19.0.6 3,515 3/7/2022
19.0.5 80,399 1/28/2022
19.0.4 3,967 1/23/2022
19.0.3 30,939 12/14/2021
19.0.2 1,403 12/11/2021
19.0.1 11,070 11/20/2021
19.0.0 2,911 11/11/2021
19.0.0-rc.net60.2 340 9/26/2021
19.0.0-rc.net60.1 279 9/16/2021
18.1.6 17,943 9/26/2021
18.1.5 5,536 9/7/2021
18.1.4 1,545 9/6/2021
18.1.3 4,635 8/19/2021
18.1.2 2,628 8/8/2021
18.1.1 1,114 8/5/2021
18.1.0 3,143 8/1/2021
18.0.1 3,076 7/30/2021
18.0.0 2,235 7/26/2021
17.0.8 5,493 7/7/2021
17.0.7 8,660 6/16/2021
17.0.6 1,578 6/5/2021
17.0.5 2,103 5/28/2021
17.0.4 6,940 5/4/2021
17.0.3 930 5/1/2021
17.0.2 1,135 4/22/2021
17.0.1 1,823 4/18/2021
17.0.0 5,531 3/26/2021
16.5.6 4,317 3/25/2021
16.5.5 1,869 3/23/2021
16.5.4 2,415 3/9/2021
16.5.3 7,375 2/26/2021
16.5.2 1,500 2/23/2021
16.5.1 869 2/21/2021
16.5.0 733 2/17/2021
16.4.5 829 2/15/2021
16.4.4 6,496 2/5/2021
16.4.3 5,561 1/27/2021
16.4.2 3,673 1/22/2021
16.4.1 1,737 1/21/2021
16.4.0 14,842 1/11/2021
16.3.3 801 1/8/2021
16.3.2 1,153 1/3/2021
16.3.1 983 12/31/2020
16.3.0 22,005 12/30/2020
16.2.1 2,627 12/27/2020
16.2.0 30,367 10/13/2020
16.1.5 3,847 10/4/2020
16.1.4 5,877 9/17/2020
16.1.3 1,674 9/13/2020
16.1.2 1,162 9/9/2020
16.1.1 1,818 9/3/2020
16.1.0 3,951 8/19/2020
16.0.3 851 8/15/2020
16.0.2 7,703 8/9/2020
16.0.1 1,062 8/8/2020
16.0.0 13,700 8/7/2020
15.3.0 37,690 7/23/2020
15.2.3 2,989 7/14/2020
15.2.2 48,341 5/19/2020
15.2.1 8,760 5/12/2020
15.2.0 1,627 5/9/2020
15.1.1 16,448 5/4/2020
15.1.0 6,234 4/13/2020
15.0.5 17,040 3/18/2020
15.0.4 2,562 2/28/2020
15.0.3 1,260 2/26/2020
15.0.2 7,911 1/20/2020
15.0.1 1,957 1/10/2020
15.0.0 4,469 12/17/2019
14.9.1 7,618 11/30/2019
14.9.0 864 11/29/2019
14.8.1 1,236 11/26/2019
14.8.0 14,795 11/20/2019
14.7.0 43,692 10/9/2019
14.6.6 1,396 10/8/2019
14.6.5 4,716 9/27/2019
14.6.4 840 9/21/2019
14.6.3 13,850 8/12/2019
14.6.2 2,471 8/3/2019
14.6.1 445 8/3/2019
14.6.0 17,010 7/26/2019
14.5.7 5,081 7/18/2019
14.5.6 4,149 7/10/2019
14.5.5 1,361 7/1/2019
14.5.4 1,316 6/17/2019
14.5.3 15,235 6/5/2019
14.5.2 23,742 5/30/2019
14.5.1 1,589 5/28/2019
14.5.0 1,562 5/24/2019
14.4.0 1,975 5/22/2019
14.3.4 3,926 5/14/2019
14.3.3 2,651 5/9/2019
14.3.2 1,576 4/30/2019
14.3.1 1,045 4/27/2019
14.3.0 1,222 4/24/2019
14.2.3 7,361 4/17/2019
14.2.2 1,098 4/10/2019
14.2.1 1,037 4/5/2019
14.2.0 3,511 3/16/2019
14.1.1 1,026 3/8/2019
14.1.0 4,890 2/11/2019
14.0.4 2,312 1/31/2019
14.0.3 1,724 1/22/2019
14.0.2 11,833 12/15/2018
14.0.1 2,297 11/29/2018
14.0.0 1,529 11/19/2018
13.3.0 1,276 11/16/2018
13.2.2 1,140 11/15/2018
13.2.1 1,873 11/13/2018
13.2.0 2,481 10/31/2018
13.1.5 1,286 10/31/2018
13.1.4 8,714 10/25/2018
13.1.3 1,422 10/18/2018
13.1.2 5,483 9/12/2018
13.1.1 1,548 9/11/2018
13.1.0 1,207 9/11/2018
13.0.0 9,951 8/29/2018
12.3.6 1,324 8/29/2018
12.3.5 33,094 8/22/2018
12.3.4 1,306 8/21/2018
12.3.3 26,165 8/21/2018
12.3.2 1,335 8/20/2018
12.3.1 1,288 8/20/2018
12.3.0 1,248 8/20/2018
12.2.2 2,643 8/15/2018
12.2.1 3,975 8/9/2018
12.2.0 1,420 8/8/2018
12.1.11 2,138 7/30/2018
12.1.10 1,433 7/20/2018
12.1.9 1,829 7/10/2018
12.1.8 1,591 7/2/2018
12.1.7 4,841 6/7/2018
12.1.6 6,055 6/4/2018
12.1.5 1,841 6/2/2018
12.1.4 2,051 5/25/2018
12.1.3 2,863 5/16/2018
12.1.2 1,615 5/15/2018
12.1.1 1,692 5/14/2018
12.1.0 2,099 5/9/2018
12.0.7 1,772 5/5/2018
12.0.6 1,664 5/4/2018
12.0.5 1,684 5/3/2018
12.0.4 1,722 4/30/2018
12.0.3 1,748 4/30/2018
12.0.2 1,713 4/27/2018
12.0.1 1,827 4/25/2018
12.0.0 1,495 4/22/2018
11.2.0 2,224 4/11/2018
11.1.0 10,331 4/8/2018
11.0.8 1,805 3/26/2018
11.0.7 1,714 3/20/2018
11.0.6 5,108 3/7/2018
11.0.5 1,753 2/22/2018
11.0.4 3,631 2/14/2018
11.0.3 1,721 2/12/2018
11.0.2 1,771 2/9/2018
11.0.1 3,133 1/29/2018
11.0.0 2,349 1/15/2018
10.0.3 2,615 12/29/2017
10.0.2 1,536 12/26/2017
10.0.1 1,793 12/18/2017
10.0.0 1,489 12/18/2017
9.3.0 1,726 12/17/2017
9.2.0 1,486 12/17/2017
9.1.3 3,838 12/5/2017
9.1.2 2,738 11/27/2017
9.1.1 2,233 11/21/2017
9.1.0 1,501 11/21/2017
9.0.1 1,622 11/11/2017
9.0.0 1,503 11/10/2017
8.7.0 1,574 11/9/2017
8.6.0 1,491 11/9/2017
8.5.0 9,891 10/3/2017
8.4.0 1,487 10/3/2017
8.3.1 5,538 9/8/2017
8.3.0 1,525 9/8/2017
8.2.0 1,560 9/4/2017
8.1.0 2,199 8/22/2017
8.0.0 1,815 8/19/2017
7.1.3 1,647 8/14/2017
7.1.2 2,027 8/2/2017
7.1.1 2,658 7/26/2017
7.1.0 3,079 7/5/2017
7.0.9 1,656 6/28/2017
7.0.8 1,733 6/19/2017
7.0.6 11,874 4/7/2017
7.0.5 1,704 3/21/2017
7.0.4 1,618 3/21/2017
7.0.3 1,623 3/20/2017
7.0.2 1,720 3/13/2017
7.0.0 1,904 3/1/2017
6.2.0 3,379 2/25/2017
6.1.0 5,672 2/14/2017
6.0.0 1,629 2/9/2017
5.3.0 1,508 2/5/2017
5.2.0 2,009 1/26/2017
5.1.0 1,508 1/19/2017
5.0.0 1,497 1/7/2017
4.11.0 1,485 1/5/2017
4.10.0 1,455 12/31/2016
4.9.0 1,471 12/26/2016
4.8.0 1,515 12/17/2016
4.7.0 1,592 12/8/2016
4.6.5 1,521 12/4/2016
4.6.4 1,597 11/25/2016
4.6.2 1,599 11/18/2016
4.6.1 1,515 11/15/2016
4.6.0 1,468 11/11/2016
4.5.9 1,928 11/2/2016
4.5.8 1,474 11/2/2016
4.5.7 1,515 10/26/2016
4.5.6 1,584 10/6/2016
4.5.5 1,532 10/3/2016
4.5.4 1,484 10/2/2016
4.5.3 1,486 9/30/2016
4.5.2 1,490 9/28/2016
4.5.1 1,448 9/28/2016
4.5.0 1,470 9/28/2016
4.4.0 1,681 9/23/2016
4.3.0 1,616 9/22/2016
4.2.0 1,746 9/19/2016
4.1.0 1,485 9/13/2016
4.0.1 1,440 9/9/2016
4.0.0 1,452 9/9/2016
3.6.0 1,490 9/7/2016
3.4.0 1,501 9/7/2016
3.3.0 1,477 9/4/2016
3.2.0 1,450 9/3/2016
3.1.0 1,509 9/2/2016
3.0.0 1,909 8/31/2016
2.6.0 1,531 8/29/2016
2.5.0 1,509 8/27/2016
2.4.0 2,022 8/26/2016
2.3.0 1,463 8/23/2016
2.1.0 1,495 8/22/2016
2.0.0 1,533 8/21/2016
1.0.0.4 1,524 8/19/2016
1.0.0.3 1,892 8/18/2016
1.0.0.2 2,078 8/18/2016
1.0.0.1 1,499 8/18/2016
1.0.0 2,661 8/18/2016