Audit.NET.DynamoDB
27.0.3
dotnet add package Audit.NET.DynamoDB --version 27.0.3
NuGet\Install-Package Audit.NET.DynamoDB -Version 27.0.3
<PackageReference Include="Audit.NET.DynamoDB" Version="27.0.3" />
paket add Audit.NET.DynamoDB --version 27.0.3
#r "nuget: Audit.NET.DynamoDB, 27.0.3"
// Install Audit.NET.DynamoDB as a Cake Addin #addin nuget:?package=Audit.NET.DynamoDB&version=27.0.3 // Install Audit.NET.DynamoDB as a Cake Tool #tool nuget:?package=Audit.NET.DynamoDB&version=27.0.3
Audit.NET.DynamoDB
Amazon Dynamo DB provider for Audit.NET library (An extensible framework to audit executing operations in .NET).
Store the audit events in Dynamo DB tables using the AWSSDK.DynamoDBv2 library.
Install
NuGet Package To install the package run the following command on the Package Manager Console:
PM> Install-Package Audit.NET.DynamoDB
Usage
Please see the Audit.NET Readme
Configuration
Set the static Audit.Core.Configuration.DataProvider
property to set the Dynamo DB data provider, or call the UseDynamoDB
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 DynamoDataProvider()
{
Client = new Lazy<IAmazonDynamoDB>(() => new AmazonDynamoDBClient(new AmazonDynamoDBConfig()
{
ServiceURL = "http://localhost:8000"
})),
TableNameBuilder = ev => "MyTable"
};
Or even shorter using the constructor overload that accepts a fluent API:
Audit.Core.Configuration.DataProvider = new DynamoDataProvider(config => config
.UseUrl("http://localhost:8000")
.Table("MyTable"));
Or by using the global setup extension UseDynamoDB()
:
Audit.Core.Configuration.Setup()
.UseDynamoDB(config => config
.UseUrl("http://localhost:8000")
.Table(ev => ev.EventType));
You can provide the table name setting as a string or as a function of the Audit Event.
Provider Options
- Client: The DynamoDB client creator
AmazonDynamoDBClient
. - TableNameBuilder: A function of the audit event that returns the Table Name to use.
- CustomAttributes: A dictionary with additional fields to be included in the document and as custom fields on the audit event.
Fluent API Methods
The provider options can be set with a fluent API described by the following methods:
Connection level
- WithClient(): Use the given DynamoDB client instance (
AmazonDynamoDBClient
). - UseConfig(): Alternative to
WithClient()
, to use a DynamoDB client with the given settings (AmazonDynamoDBConfig
). - UseUrl(): Alternative to use a DynamoDB client only specifying the service URL.
Table level
- Table(): To specify the table name (as a string or a function of the audit event).
Attributes level
- SetAttribute(): To specify additional top-level attributes on the document before saving.
Query events
This provider implements GetEvent
and GetEventAsync
methods to obtain an audit event by id:
var event = dynamoDataProvider.GetEvent((Primitive)1234);
The
eventId
parameter on the genericGetEvent(object eventId)
must be of typePrimitive
,DynamoDBEntry
or an array of any of these two types. The first (or only) element must be the Hash key, and the second element should be the range key (or NULL if not using a range).
There are more convenient overloads of the GetEvent
/GetEventAsync
methods that accepts the Primitives without needing to cast the parameters:
// Get event with the given HASH and RANGE
var event = dynamoDataProvider.GetEvent("A001-005283", 2018);
// Get event with the given HASH
var event = dynamoDataProvider.GetEvent("A001-005283");
Constraints
This provider has the following constraints:
- The table to store the audit events must exists on DynamoDB.
- Its indexes must consist of top-level properties of the audit event.
(Note you can add properties to the AuditEvent as Custom Fields with the
SetAttribute()
method on the provider configuration)
The following is an example of a table creation using the AWSSDK.DynamoDBv2 library:
var config = new AmazonDynamoDBConfig() { ServiceURL = "http://localhost:8000" };
var client = new AmazonDynamoDBClient(config);
await client.CreateTableAsync(new CreateTableRequest()
{
TableName = "AuditEvents",
KeySchema = new List<KeySchemaElement>()
{
new KeySchemaElement("EventId", KeyType.HASH),
new KeySchemaElement("EventType", KeyType.RANGE)
},
AttributeDefinitions = new List<AttributeDefinition>()
{
new AttributeDefinition("EventId", ScalarAttributeType.S),
new AttributeDefinition("EventType", ScalarAttributeType.S)
},
ProvisionedThroughput = new ProvisionedThroughput(1, 1)
});
In this case, the primary key is defined as a Hash and a Range key, with EventId
being the hash, and EventType
being the range.
Both must be top-level properties of the Audit Event,
but since the EventId
is not a built-in property, you can configure it as a Custom Field:
Audit.Core.Configuration.Setup()
.UseDynamoDB(config => config
.UseUrl(url)
.Table("AuditEvents")
.SetAttribute("EventId", ev => Guid.NewGuid()));
Or you can use a global Custom Action instead with the same outcome:
Audit.Core.Configuration.AddCustomAction(ActionType.OnScopeCreated, scope =>
{
scope.SetCustomField("EventId", Guid.NewGuid());
});
Product | Versions 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 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. |
.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. |
-
.NETFramework 4.6.2
- Audit.NET (>= 27.0.3)
- AWSSDK.DynamoDBv2 (>= 3.7.300.17)
-
.NETStandard 2.0
- Audit.NET (>= 27.0.3)
- AWSSDK.DynamoDBv2 (>= 3.7.300.17)
-
net6.0
- Audit.NET (>= 27.0.3)
- AWSSDK.DynamoDBv2 (>= 3.7.300.17)
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 |
---|---|---|
27.0.3 | 525 | 9/25/2024 |
27.0.2 | 113 | 9/19/2024 |
27.0.1 | 1,171 | 9/4/2024 |
27.0.0 | 89 | 9/3/2024 |
26.0.1 | 2,090 | 8/22/2024 |
26.0.0 | 675 | 7/19/2024 |
25.0.7 | 199 | 7/4/2024 |
25.0.6 | 167 | 6/24/2024 |
25.0.5 | 804 | 6/18/2024 |
25.0.4 | 5,497 | 3/24/2024 |
25.0.3 | 160 | 3/13/2024 |
25.0.2 | 109 | 3/12/2024 |
25.0.1 | 221 | 2/28/2024 |
25.0.0 | 137 | 2/16/2024 |
24.0.1 | 134 | 2/12/2024 |
24.0.0 | 105 | 2/12/2024 |
23.0.0 | 587 | 12/14/2023 |
22.1.0 | 213 | 12/9/2023 |
22.0.2 | 314 | 12/1/2023 |
22.0.1 | 223 | 11/16/2023 |
22.0.0 | 172 | 11/14/2023 |
21.1.0 | 440 | 10/9/2023 |
21.0.4 | 268 | 9/15/2023 |
21.0.3 | 119,887 | 7/9/2023 |
21.0.2 | 209 | 7/6/2023 |
21.0.1 | 2,575 | 5/27/2023 |
21.0.0 | 29,219 | 4/15/2023 |
20.2.4 | 2,578 | 3/27/2023 |
20.2.3 | 337 | 3/17/2023 |
20.2.2 | 343 | 3/14/2023 |
20.2.1 | 354 | 3/11/2023 |
20.2.0 | 332 | 3/7/2023 |
20.1.6 | 3,365 | 2/23/2023 |
20.1.5 | 705 | 2/9/2023 |
20.1.4 | 385 | 1/28/2023 |
20.1.3 | 34,884 | 12/21/2022 |
20.1.2 | 354 | 12/14/2022 |
20.1.1 | 364 | 12/12/2022 |
20.1.0 | 391 | 12/4/2022 |
20.0.4 | 833 | 11/30/2022 |
20.0.3 | 800 | 10/28/2022 |
20.0.2 | 480 | 10/26/2022 |
20.0.1 | 501 | 10/21/2022 |
20.0.0 | 1,023 | 10/1/2022 |
19.4.1 | 3,586 | 9/10/2022 |
19.4.0 | 523 | 9/2/2022 |
19.3.0 | 500 | 8/23/2022 |
19.2.2 | 1,752 | 8/11/2022 |
19.2.1 | 539 | 8/6/2022 |
19.2.0 | 710 | 7/24/2022 |
19.1.4 | 14,417 | 5/23/2022 |
19.1.3 | 533 | 5/22/2022 |
19.1.2 | 560 | 5/18/2022 |
19.1.1 | 598 | 4/28/2022 |
19.1.0 | 539 | 4/10/2022 |
19.0.7 | 581 | 3/13/2022 |
19.0.6 | 596 | 3/7/2022 |
19.0.5 | 18,413 | 1/28/2022 |
19.0.4 | 561 | 1/23/2022 |
19.0.3 | 664 | 12/14/2021 |
19.0.2 | 424 | 12/11/2021 |
19.0.1 | 1,163 | 11/20/2021 |
19.0.0 | 2,970 | 11/11/2021 |
19.0.0-rc.net60.2 | 165 | 9/26/2021 |
19.0.0-rc.net60.1 | 214 | 9/16/2021 |
18.1.6 | 1,656 | 9/26/2021 |
18.1.5 | 565 | 9/7/2021 |
18.1.4 | 460 | 9/6/2021 |
18.1.3 | 511 | 8/19/2021 |
18.1.2 | 554 | 8/8/2021 |
18.1.1 | 521 | 8/5/2021 |
18.1.0 | 591 | 8/1/2021 |
18.0.1 | 535 | 7/30/2021 |
18.0.0 | 646 | 7/26/2021 |
17.0.8 | 4,689 | 7/7/2021 |
17.0.7 | 834 | 6/16/2021 |
17.0.6 | 521 | 6/5/2021 |
17.0.5 | 1,868 | 5/28/2021 |
17.0.4 | 661 | 5/4/2021 |
17.0.3 | 539 | 5/1/2021 |
17.0.2 | 511 | 4/22/2021 |
17.0.1 | 501 | 4/18/2021 |
17.0.0 | 547 | 3/26/2021 |
16.5.6 | 519 | 3/25/2021 |
16.5.5 | 484 | 3/23/2021 |
16.5.4 | 613 | 3/9/2021 |
16.5.3 | 1,160 | 2/26/2021 |
16.5.2 | 521 | 2/23/2021 |
16.5.1 | 542 | 2/21/2021 |
16.5.0 | 514 | 2/17/2021 |
16.4.5 | 518 | 2/15/2021 |
16.4.4 | 535 | 2/5/2021 |
16.4.3 | 521 | 1/27/2021 |
16.4.2 | 531 | 1/22/2021 |
16.4.1 | 603 | 1/21/2021 |
16.4.0 | 527 | 1/11/2021 |
16.3.3 | 578 | 1/8/2021 |
16.3.2 | 538 | 1/3/2021 |
16.3.1 | 593 | 12/31/2020 |
16.3.0 | 499 | 12/30/2020 |
16.2.1 | 529 | 12/27/2020 |
16.2.0 | 1,120 | 10/13/2020 |
16.1.5 | 17,101 | 10/4/2020 |
16.1.4 | 654 | 9/17/2020 |
16.1.3 | 732 | 9/13/2020 |
16.1.2 | 634 | 9/9/2020 |
16.1.1 | 662 | 9/3/2020 |
16.1.0 | 685 | 8/19/2020 |
16.0.3 | 747 | 8/15/2020 |
16.0.2 | 724 | 8/9/2020 |
16.0.1 | 726 | 8/8/2020 |
16.0.0 | 626 | 8/7/2020 |
15.3.0 | 746 | 7/23/2020 |
15.2.3 | 795 | 7/14/2020 |
15.2.2 | 1,554 | 5/19/2020 |
15.2.1 | 689 | 5/12/2020 |
15.2.0 | 724 | 5/9/2020 |
15.1.1 | 708 | 5/4/2020 |
15.1.0 | 741 | 4/13/2020 |
15.0.5 | 829 | 3/18/2020 |
15.0.4 | 723 | 2/28/2020 |
15.0.3 | 708 | 2/26/2020 |
15.0.2 | 801 | 1/20/2020 |
15.0.1 | 758 | 1/10/2020 |
15.0.0 | 761 | 12/17/2019 |
14.9.1 | 7,709 | 11/30/2019 |
14.9.0 | 697 | 11/29/2019 |
14.8.1 | 742 | 11/26/2019 |
14.8.0 | 697 | 11/20/2019 |
14.7.0 | 23,182 | 10/9/2019 |
14.6.6 | 741 | 10/8/2019 |
14.6.5 | 759 | 9/27/2019 |
14.6.4 | 738 | 9/21/2019 |
14.6.3 | 789 | 8/12/2019 |
14.6.2 | 776 | 8/3/2019 |
14.6.1 | 796 | 8/3/2019 |
14.6.0 | 747 | 7/26/2019 |
14.5.7 | 810 | 7/18/2019 |
14.5.6 | 790 | 7/10/2019 |
14.5.5 | 775 | 7/1/2019 |
14.5.4 | 793 | 6/17/2019 |
14.5.3 | 841 | 6/5/2019 |
14.5.2 | 799 | 5/30/2019 |
14.5.1 | 819 | 5/28/2019 |
14.5.0 | 764 | 5/24/2019 |
14.4.0 | 807 | 5/22/2019 |
14.3.4 | 828 | 5/14/2019 |
14.3.3 | 818 | 5/9/2019 |
14.3.2 | 815 | 4/30/2019 |
14.3.1 | 842 | 4/27/2019 |
14.3.0 | 833 | 4/24/2019 |
14.2.3 | 807 | 4/17/2019 |
14.2.2 | 835 | 4/10/2019 |
14.2.1 | 820 | 4/5/2019 |
14.2.0 | 806 | 3/16/2019 |
14.1.1 | 858 | 3/8/2019 |
14.1.0 | 940 | 2/11/2019 |
14.0.4 | 938 | 1/31/2019 |
14.0.3 | 920 | 1/22/2019 |
14.0.2 | 954 | 12/15/2018 |
14.0.1 | 998 | 11/29/2018 |
14.0.0 | 969 | 11/19/2018 |
13.3.0 | 971 | 11/16/2018 |
13.2.2 | 963 | 11/15/2018 |
13.2.1 | 1,001 | 11/13/2018 |
13.2.0 | 971 | 10/31/2018 |
13.1.5 | 1,024 | 10/31/2018 |
13.1.4 | 1,054 | 10/25/2018 |
13.1.3 | 1,003 | 10/18/2018 |
13.1.2 | 1,086 | 9/12/2018 |
13.1.1 | 1,031 | 9/11/2018 |
13.1.0 | 1,070 | 9/11/2018 |
13.0.0 | 1,059 | 8/29/2018 |
12.3.6 | 1,058 | 8/29/2018 |