Audit.NET.Redis 27.0.0

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

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

Audit.NET.Redis

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

Store the audit events in a Redis database as Strings, List, SortedSet, Hash, publish to a PubSub channel or add to a Redis Stream.

Install

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

PM> Install-Package Audit.NET.Redis

NuGet Status NuGet Count

Usage

Please see the Audit.NET Readme

Configuration

To set the Redis data provider globally, use the fluent configuration API, for example:

Audit.Core.Configuration.Setup()
    .UseRedis(redis => redis
        .ConnectionString(RedisCnnString)
        .AsString(str => str
            .Key(ev => $"{Guid.NewGuid()}")));

If you need to set different providers/configuration per scope, you can use the RedisDataProviderHelper to easily get a new Redis Data Provider via the fluent API, for example:

    var dp = new RedisDataProviderHelper(RedisCnnString)
        .AsString(str => str
            .Key(ev => $"{Guid.NewGuid()}"));

    using (AuditScope.Create(new AuditScopeOptions() { DataProvider = dp }))
    {
       // ...
    }

Common settings

  • ConnectionString indicates the redis connection string, based on StackExchange.Redis configuration.
  • ConfigurationOptions indicates the redis connection configuration options, when you need to provide custom connection options. Alternative to ConnectionString.
  • Serializer indicates a custom serialization method for the audit events. By default the events are serialized as JSON encoded as UTF-8.

Modes

This data provider allows to store the events in different ways.

Redis String

Store each audit event as a redis string.

Setup sample:

// Store audits as strings.
Audit.Core.Configuration.Setup()
    .UseRedis(redis => redis
        .ConnectionString("localhost:6379,allowAdmin=true")
        .AsString(str => str
            .Key(ev => $"{ev.EventType}:{Guid.NewGuid()}")));

Mandatory settings

  • Use the Key method to indicate the redis key where the event will be stored, this key can depend on the AuditEvent object.

Optional settings

  • TimeToLive specifies the Time To Live for the Redis Key. Default is no TTL.
  • Database specifies the database ID to use. Default is database 0.
  • AttachTask attaches an additional redis command to the execution.

Redis Stream

Adds each audit event to a Redis Stream.

Setup sample:

// Store audits as strings.
Audit.Core.Configuration.Setup()
    .UseRedis(redis => redis
        .ConnectionString("localhost")
        .AsStream(stream => stream
            .Key("MyAuditStream")
            .MaxLength(5000)
            .WithCustomField("Date", ev => DateTime.UtcNow.ToString())));

Mandatory settings

  • Use the Key method to indicate the stream redis key, this key can depend on the AuditEvent object.

Optional settings

  • Database specifies the database ID to use. Default is database 0.
  • AttachTask attaches an additional redis command to the execution.
  • MaxLength specifies the maximum quantity of events that the stream will store. Older elements will be deleted. Default is NULL for no-limit.
  • DefaultAuditEventFieldName specifies the default field name that will contain the AuditEvent JSON representation in the stream entry. Default is "AuditEvent".
  • WithCustomField allows specifying custom fields to be stored in the stream entry. By default, only the field named "AuditEvent" is stored, containing the JSON representation of the Audit Event.

Redis Hash

Store each audit event as a field in a redis hash.

Setup sample:

// Store audits in hashes per each EventType.
Audit.Core.Configuration.Setup()
    .UseRedis(redis => redis
        .ConnectionString(RedisCnnString)
        .AsHash(hash => hash
            .Key(ev => $"{ev.EventType}")
            .HashField(ev => $"{Guid.NewGuid()}")));

Mandatory settings:

  • Key to indicate the redis key where the hash will be stored, this key can depend on the AuditEvent object.
  • HashField to indicate the redis field inside the hash where the event will be stored.

Optional settings

  • TimeToLive specifies the Time To Live for the Redis Hash. Default is no TTL.
  • Database specifies the database ID to use. Default is database 0.
  • AttachTask attaches an additional redis command to the execution.

Redis List

Store each audit event as a member in a redis list.

Setup sample:

// Store audits in lists per each EventType, with a maximum of 1000 events per list.
Audit.Core.Configuration.Setup()
    .UseRedis(redis => redis
        .ConnectionString(RedisCnnString)
        .AsList(list => list
            .Key(ev => $"{ev.EventType}")
            .MaxLength(1000)));

Mandatory settings:

  • Key to indicate the redis key where the list will be stored, this key can depend on the AuditEvent object.

Optional settings:

  • MaxLength to indicate the maximum quantity of events that the list will store. Older elements will be deleted. Default is no-limit.
  • TimeToLive specifies the Time To Live for the Redis List. Default is no TTL.
  • Database specifies the database ID to use. Default is database 0.
  • AttachTask attaches an additional redis command to the execution.

Redis Sorted Set

Store each audit event as a member in a redis sorted set.

Setup sample:

// Store audits in sorted sets per each EventType, maintaining only the events from the last 30 days.
Audit.Core.Configuration.Setup()
    .UseRedis(redis => redis
        .ConnectionString(RedisCnnString)
        .AsSortedSet(sset => sset
            .Key(ev => $"{ev.EventType}")
            .Score(ev => ev.StartDate.Ticks)
            .MinScore(ev => DateTime.UtcNow.AddDays(-30).Ticks)));

Mandatory settings:

  • Key to indicate the redis key where the sorted set will be stored, this key can depend on the AuditEvent object.
  • Score to indicate the score as a double that the event will have, can depend on the AuditEvent object.

Optional settings:

  • MinScore specifies a function that returns the minimum score allowed for the sorted set. Audits with score less than the minimum will be deleted. This deletion takes place when a new event is stored.
  • MaxScore specifies a function that returns the maximum score allowed for the sorted set.
  • MaxRank specifies a function that returns the maximum rank allowed for the sorted set. Max>0: Maintain only the top N scored elements. Max<0: Maintain only the bottom N scored elements.
  • TimeToLive specifies the Time To Live for the Redis Sorted Set. Default is no TTL.
  • Database specifies the database ID to use. Default is database 0.
  • AttachTask attaches an additional redis command to the execution.

Redis PubSub

Sends the audit events to a redis PubSub channel.

Setup sample:

// Send audits to PubSub channels.
Audit.Core.Configuration.Setup()
    .UseRedis(redis => redis
        .ConnectionString(RedisCnnString)
        .AsPubSub(pub => pub
            .Channel(ev => $"audits:{ev.EventType}")));

Mandatory settings:

  • Channel to indicate the channel name to use for publishing the events.

Query events

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

var event = Configuration.DataProvider.GetEvent("eventId");
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 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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

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.1.1 83 10/28/2024
27.1.0 78 10/24/2024
27.0.3 2,113 9/25/2024
27.0.2 94 9/19/2024
27.0.1 117 9/4/2024
27.0.0 103 9/3/2024
26.0.1 181 8/22/2024
26.0.0 92 7/19/2024
25.0.7 113 7/4/2024
25.0.6 100 6/24/2024
25.0.5 115 6/18/2024
25.0.4 2,543 3/24/2024
25.0.3 134 3/13/2024
25.0.2 123 3/12/2024
25.0.1 126 2/28/2024
25.0.0 1,039 2/16/2024
24.0.1 135 2/12/2024
24.0.0 113 2/12/2024
23.0.0 1,080 12/14/2023
22.1.0 119 12/9/2023
22.0.2 146 12/1/2023
22.0.1 1,259 11/16/2023
22.0.0 233 11/14/2023
21.1.0 177 10/9/2023
21.0.4 2,037 9/15/2023
21.0.3 589 7/9/2023
21.0.2 164 7/6/2023
21.0.1 168 5/27/2023
21.0.0 231 4/15/2023
20.2.4 265 3/27/2023
20.2.3 261 3/17/2023
20.2.2 270 3/14/2023
20.2.1 269 3/11/2023
20.2.0 251 3/7/2023
20.1.6 290 2/23/2023
20.1.5 309 2/9/2023
20.1.4 4,383 1/28/2023
20.1.3 358 12/21/2022
20.1.2 339 12/14/2022
20.1.1 327 12/12/2022
20.1.0 362 12/4/2022
20.0.4 374 11/30/2022
20.0.3 2,556 10/28/2022
20.0.2 455 10/26/2022
20.0.1 493 10/21/2022
20.0.0 1,610 10/1/2022
19.4.1 1,189 9/10/2022
19.4.0 504 9/2/2022
19.3.0 491 8/23/2022
19.2.2 2,097 8/11/2022
19.2.1 514 8/6/2022
19.2.0 1,426 7/24/2022
19.1.4 3,391 5/23/2022
19.1.3 499 5/22/2022
19.1.2 493 5/18/2022
19.1.1 864 4/28/2022
19.1.0 604 4/10/2022
19.0.7 3,560 3/13/2022
19.0.6 583 3/7/2022
19.0.5 1,008 1/28/2022
19.0.4 564 1/23/2022
19.0.3 3,460 12/14/2021
19.0.2 404 12/11/2021
19.0.1 845 11/20/2021
19.0.0 436 11/11/2021
19.0.0-rc.net60.2 170 9/26/2021
19.0.0-rc.net60.1 215 9/16/2021
18.1.6 777 9/26/2021
18.1.5 531 9/7/2021
18.1.4 458 9/6/2021
18.1.3 510 8/19/2021
18.1.2 549 8/8/2021
18.1.1 497 8/5/2021
18.1.0 500 8/1/2021
18.0.1 534 7/30/2021
18.0.0 534 7/26/2021
17.0.8 541 7/7/2021
17.0.7 512 6/16/2021
17.0.6 504 6/5/2021
17.0.5 496 5/28/2021
17.0.4 486 5/4/2021
17.0.3 458 5/1/2021
17.0.2 495 4/22/2021
17.0.1 465 4/18/2021
17.0.0 520 3/26/2021
16.5.6 488 3/25/2021
16.5.5 466 3/23/2021
16.5.4 502 3/9/2021
16.5.3 454 2/26/2021
16.5.2 476 2/23/2021
16.5.1 498 2/21/2021
16.5.0 510 2/17/2021
16.4.5 488 2/15/2021
16.4.4 473 2/5/2021
16.4.3 485 1/27/2021
16.4.2 518 1/22/2021
16.4.1 533 1/21/2021
16.4.0 510 1/11/2021
16.3.3 577 1/8/2021
16.3.2 530 1/3/2021
16.3.1 555 12/31/2020
16.3.0 519 12/30/2020
16.2.1 490 12/27/2020
16.2.0 534 10/13/2020
16.1.5 546 10/4/2020
16.1.4 581 9/17/2020
16.1.3 692 9/13/2020
16.1.2 585 9/9/2020
16.1.1 593 9/3/2020
16.1.0 578 8/19/2020
16.0.3 631 8/15/2020
16.0.2 620 8/9/2020
16.0.1 639 8/8/2020
16.0.0 574 8/7/2020
15.3.0 678 7/23/2020
15.2.3 589 7/14/2020
15.2.2 610 5/19/2020
15.2.1 608 5/12/2020
15.2.0 641 5/9/2020
15.1.1 638 5/4/2020
15.1.0 656 4/13/2020
15.0.5 628 3/18/2020
15.0.4 652 2/28/2020
15.0.3 620 2/26/2020
15.0.2 700 1/20/2020
15.0.1 659 1/10/2020
15.0.0 670 12/17/2019
14.9.1 664 11/30/2019
14.9.0 647 11/29/2019
14.8.1 661 11/26/2019
14.8.0 708 11/20/2019
14.7.0 666 10/9/2019
14.6.6 649 10/8/2019
14.6.5 658 9/27/2019
14.6.4 667 9/21/2019
14.6.3 694 8/12/2019
14.6.2 721 8/3/2019
14.6.1 716 8/3/2019
14.6.0 686 7/26/2019
14.5.7 688 7/18/2019
14.5.6 725 7/10/2019
14.5.5 682 7/1/2019
14.5.4 688 6/17/2019
14.5.3 723 6/5/2019
14.5.2 737 5/30/2019
14.5.1 710 5/28/2019
14.5.0 762 5/24/2019
14.4.0 742 5/22/2019
14.3.4 700 5/14/2019
14.3.3 711 5/9/2019
14.3.2 735 4/30/2019
14.3.1 728 4/27/2019
14.3.0 798 4/24/2019
14.2.3 728 4/17/2019
14.2.2 725 4/10/2019
14.2.1 709 4/5/2019
14.2.0 728 3/16/2019
14.1.1 748 3/8/2019
14.1.0 811 2/11/2019
14.0.4 830 1/31/2019
14.0.3 856 1/22/2019
14.0.2 876 12/15/2018
14.0.1 862 11/29/2018
14.0.0 904 11/19/2018
13.3.0 881 11/16/2018
13.2.2 883 11/15/2018
13.2.1 924 11/13/2018
13.2.0 916 10/31/2018
13.1.5 891 10/31/2018
13.1.4 894 10/25/2018
13.1.3 880 10/18/2018
13.1.2 994 9/12/2018
13.1.1 942 9/11/2018
13.1.0 939 9/11/2018
13.0.0 1,082 8/29/2018
12.3.6 1,006 8/29/2018
12.3.5 1,011 8/22/2018
12.3.4 994 8/21/2018
12.3.3 25,725 8/21/2018
12.3.2 1,003 8/20/2018
12.3.1 1,031 8/20/2018
12.3.0 1,025 8/20/2018
12.2.2 1,064 8/15/2018
12.2.1 1,056 8/9/2018
12.2.0 1,022 8/8/2018
12.1.11 1,010 7/30/2018
12.1.10 1,039 7/20/2018
12.1.9 1,130 7/10/2018
12.1.8 1,029 7/2/2018
12.1.7 1,117 6/7/2018
12.1.6 1,040 6/4/2018
12.1.5 1,109 6/2/2018
12.1.4 1,012 5/25/2018
12.1.3 1,216 5/16/2018
12.1.2 1,065 5/15/2018
12.1.1 1,187 5/14/2018
12.1.0 1,151 5/9/2018
12.0.7 1,219 5/5/2018
12.0.6 1,231 5/4/2018
12.0.5 1,166 5/3/2018
12.0.4 1,214 4/30/2018
12.0.3 1,228 4/30/2018
12.0.2 1,157 4/27/2018
12.0.1 1,056 4/25/2018
12.0.0 1,065 4/22/2018
11.2.0 1,101 4/11/2018
11.1.0 1,209 4/8/2018
11.0.8 1,182 3/26/2018
11.0.7 1,150 3/20/2018
11.0.6 1,134 3/7/2018
11.0.5 1,090 2/22/2018
11.0.4 1,175 2/14/2018
11.0.3 1,145 2/12/2018
11.0.2 1,151 2/9/2018
11.0.1 1,077 1/29/2018
11.0.0 1,136 1/15/2018
10.0.3 1,510 12/29/2017
10.0.2 1,153 12/26/2017
10.0.1 1,184 12/18/2017
10.0.0 1,142 12/18/2017
9.3.0 1,132 12/17/2017
9.2.0 1,107 12/17/2017
9.1.3 1,132 12/5/2017
9.1.2 1,117 11/27/2017
9.1.1 1,101 11/21/2017
9.1.0 1,106 11/21/2017
9.0.1 1,151 11/11/2017
9.0.0 1,165 11/10/2017
8.7.0 1,130 11/9/2017
8.6.0 1,104 11/9/2017
8.5.0 1,124 10/3/2017
8.4.0 1,139 10/3/2017
8.3.1 1,407 9/8/2017
8.3.0 1,141 9/8/2017
8.2.0 1,110 9/4/2017
8.1.0 1,151 8/22/2017
8.0.0 1,222 8/19/2017
7.1.3 1,138 8/14/2017
7.1.2 1,184 8/2/2017