Audit.DynamicProxy 25.0.5

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

// Install Audit.DynamicProxy as a Cake Tool
#tool nuget:?package=Audit.DynamicProxy&version=25.0.5

Audit.DynamicProxy

Dynamic Proxy Extension for Audit.NET library.

Generate Audit Logs by intercepting operations on virtually any class.

Audit.DynamicProxy provides the infrastructure to create audit logs for a class without changing its code. It relies on Castle DynamicProxy library to intercept and record the operation calls (methods and properties) including caller info and arguments.

Install

NuGet Package

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

PM> Install-Package Audit.DynamicProxy

NuGet Status NuGet Count

Usage

To enable the audit log for an instance of a class, create a proxy for the class by calling the AuditProxy.Create<>() method.

This will return a proxied audit-enabled instance that you should use instead of the real instance. Each operation on the proxy (access to a property or method call) will generate an Audit Event.

Suppose you have a MyRepository instance that you want to audit, like this:

public class MyDataAccess
{
    IMyRepository _repository = new MyRepository(); // <- Audit this object

    public async Task<int> InsertUserAsync(string userName)
    {
        return await _repository.InsertUserAsync(userName);
    }
    // ...
}

To enable the audit on the _repository object, intercept its assignation by calling AuditProxy.Create<>():

public class MyDataAccess
{
    IMyRepository _repository = AuditProxy.Create<IMyRepository>(new MyRepository()); // Audited!

    public async Task<int> InsertUserAsync(string userName)
    {
        return await _repository.InsertUserAsync(userName);
    }
    // ...
}

You can also intercept conditionally, for example to avoid auditing when a debugger is attached:

public class MyDataAccess
{
    IMyRepository _repository = new MyRepository();

    public MyDataAccess()
    {
        if (!Debugger.IsAttached)
        {
            // Audit only when no debugger is attached
            _repository = AuditProxy.Create<IMyRepository>(_repository);
        }
    }
}

Creating proxies

The AuditProxy.Create<>() method returns an auditable proxy object that inherits from the proxied class/implements proxied interface and forwards calls to the real object.

This is the method signature:

T AuditProxy.Create<T>(T instance, InterceptionSettings settings = null)

Give special attention to the generic type argument T, it can be:

  • An interface: Will generate an interface proxy to log all the interface member calls. (Recommended)
  • A class type: Will generate a class proxy to log virtual member calls. Non-virtual methods can't be automatically audited.

When using an interface proxy, the interception is limited to the members of the interface. And when using a class proxy, the interception is limited to its virtual members.

The instance argument is an instance of the object to be audited.

The settings argument allows you to change the default settings. See settings section for more information.

Settings

The InterceptionSettings class include the following settings:

  • EventType: A string that identifies the event type. Default is "{class}.{method}". Can contain the following placeholders:
    • {class}: Replaced by the class name
    • {method}: Replaced by the method name
  • IgnoreProperties: A boolean indicating whether the audit should ignore the property getters and setters. If true, the property accesses will not be logged. Default is false
  • IgnoreEvents: A boolean indicating whether the audit should ignore the event attach and detach operations. If true, the event accesses will not be logged. Default is false
  • MethodFilter: A function that takes a MethodInfo and returns a boolean indicating whether the method should be taken into account for the logging. Use this setting to have fine grained control over the methods that should be audited. By default all methods are included.
  • AuditDataProvider: Allows to set a specific audit data provider for this instance. By default the globally configured data provider is used. See Audit.NET Data Providers section for more information.

AuditIgnore Attribute

You can exclude specific members, arguments or return values from the audit, by decorating them with the AuditIgnore attribute. For example:

public class MyRepository : IMyRepository
{
    //Ignore a method (no events will be generated for this method)
    [AuditIgnore] 
    public User GetUser(string userName)
    {
       ...
    }

    //Ignore an argument (argument value will not be included in the output)
    public User FindUser(int type, [AuditIgnore] Filter filter)
    {
        ...
    }

    //Exclude the return value (result will not be included in the output)
    [return:AuditIgnore] 
    public List<User> SearchUsers(string text)
    {
        ...
    }
}

Customization

You can access the current audit scope from an audited member by getting the static AuditProxy.CurrentScope property.

The static property AuditProxy.CurrentScope returns the scope for the current running thread and should be accessed from the same thread as the executing audited operation. Calling this from a different thread will lead to an unexpected result. On async methods, you should only access this propery before any await ocurrence.

For example:

public class MyRepository : IMyRepository
{
    public async Task<int> InsertUserAsync(string userName)
    {
        var auditScope = AuditProxy.CurrentScope;   // Get the current scope
        auditScope.SetCustomField("TestField", Guid.NewGuid()); // Set a custom field
        
        //... existing code to insert user ...

        if (pleaseDoNotLog)
        {
            auditScope.Discard(); // Discard the event
        }

        return await _repository.InsertUserAsync(userName);
    }
}

Output

Audit.DynamicProxy output includes:

  • Execution time and duration (async-aware)
  • Environment information such as user, machine, domain and locale.
  • Method parameters (input and output)
  • Return object
  • Exception details
  • Comments and Custom Fields provided

With this information you can know who did the operation, and also measure performance, observe exceptions thrown and get statistics about usage of your classes.

Async calls are logged when the asynchronous call ends; as a continuation task, so the Audit Event includes the actual duration and result.

Output Details

The following table describes the Audit.DynamicProxy output fields:

AuditInterceptEvent

Describes an operation call event

Field Name Type Description
ClassName string Name of class where the operation is defined
MethodName string Name of the audited method
IsAsync boolean A boolean indicating whether the audited method is async
AsyncStatus string If the method is async, this will contain the final Task status (Canceled, Faulted, RanToCompletion)
InstanceQualifiedName string Full qualified name of the class
MethodSignature string The complete method signature
PropertyName string Name of the property modified (if any)
EventName string Name of the event modified (if any)
Arguments argument array The operation arguments (input and output parameters)
Success boolean Indicates if the operation completed succesfully
Exception string The exception details when an exception is thrown
Result argument object The result of the operation

AuditInterceptArgument

Describes an operation argument

Field Name Type Description
Index string Argument index
Name string Argument name
Type string Argument type
Value object Input argument value
OutputValue object Output argument value (Only for ref or out parameters)

Output Samples

Successful async method call:
{
  "EventType": "MyRepository.InsertUserAsync",
  "Environment": {
    "UserName": "Federico",
    "MachineName": "HP",
    "DomainName": "HP",
    "CallingMethodName": "Audit.DynamicProxy.AuditInterceptor.Intercept()",
    "AssemblyName": "Audit.DynamicProxy, Version=4.5.2.0, Culture=neutral, PublicKeyToken=null",
    "Culture": "en-GB"
  },
  "StartDate": "2016-09-30T12:00:35.7073819-05:00",
  "EndDate": "2016-09-30T12:00:36.7168197-05:00",
  "Duration": 1009,
  "InterceptEvent": {
    "ClassName": "MyRepository",
    "MethodName": "InsertUserAsync",
    "IsAsync": true,
    "AsyncStatus": "RanToCompletion",
    "InstanceQualifiedName": "Audit.DynamicProxy.UnitTest.MyRepository, Audit.DynamicProxy.UnitTest, Version=3.0.0.0, Culture=neutral, PublicKeyToken=null",
    "MethodSignature": "System.Threading.Tasks.Task`1[System.Int32] InsertUserAsync(System.String)",
    "Arguments": [
      {
        "Index": 0,
        "Name": "userName",
        "Type": "String",
        "Value": "thepirat000"
      }
    ],
    "Success": true,
    "Result": {
      "Type": "Task<Int32>",
      "Value": 142857
    }
  }
}
Failed async method call:
{
  "EventType": "MyRepository.InsertUserAsync",
  "Environment": {
    "UserName": "Federico",
    "MachineName": "HP",
    "DomainName": "HP",
    "CallingMethodName": "Audit.DynamicProxy.AuditInterceptor.Intercept()",
    "AssemblyName": "Audit.DynamicProxy, Version=4.5.2.0, Culture=neutral, PublicKeyToken=null",
    "Exception": "COMException: Exception from HRESULT: 0xE0434352",
    "Culture": "en-GB"
  },
  "StartDate": "2016-09-30T12:18:34.5093824-05:00",
  "EndDate": "2016-09-30T12:18:35.5388113-05:00",
  "Duration": 1029,
  "InterceptEvent": {
    "ClassName": "MyRepository",
    "MethodName": "InsertUserAsync",
    "IsAsync": true,
    "AsyncStatus": "Faulted",
    "InstanceQualifiedName": "Audit.DynamicProxy.UnitTest.MyRepository, Audit.DynamicProxy.UnitTest, Version=3.0.0.0, Culture=neutral, PublicKeyToken=null",
    "MethodSignature": "System.Threading.Tasks.Task`1[System.Int32] InsertUserAsync(System.String)",
    "Arguments": [
      {
        "Index": 0,
        "Name": "userName",
        "Type": "String",
        "Value": null
      }
    ],
    "Success": false,
    "Exception": "(ArgumentNullException) UserName cannot be null",
    "Result": null
  }
}
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 (1)

Showing the top 1 popular GitHub repositories that depend on Audit.DynamicProxy:

Repository Stars
thepirat000/Audit.NET
An extensible framework to audit executing operations in .NET and .NET Core.
Version Downloads Last updated
25.0.6 41 6/24/2024
25.0.5 74 6/18/2024
25.0.4 332 3/24/2024
25.0.3 150 3/13/2024
25.0.2 96 3/12/2024
25.0.1 151 2/28/2024
25.0.0 132 2/16/2024
24.0.1 131 2/12/2024
24.0.0 91 2/12/2024
23.0.0 578 12/14/2023
22.1.0 136 12/9/2023
22.0.2 173 12/1/2023
22.0.1 205 11/16/2023
22.0.0 126 11/14/2023
21.1.0 2,672 10/9/2023
21.0.4 3,369 9/15/2023
21.0.3 1,219 7/9/2023
21.0.2 199 7/6/2023
21.0.1 533 5/27/2023
21.0.0 7,394 4/15/2023
20.2.4 1,293 3/27/2023
20.2.3 369 3/17/2023
20.2.2 297 3/14/2023
20.2.1 307 3/11/2023
20.2.0 329 3/7/2023
20.1.6 647 2/23/2023
20.1.5 3,137 2/9/2023
20.1.4 12,231 1/28/2023
20.1.3 391 12/21/2022
20.1.2 368 12/14/2022
20.1.1 420 12/12/2022
20.1.0 469 12/4/2022
20.0.4 408 11/30/2022
20.0.3 775 10/28/2022
20.0.2 514 10/26/2022
20.0.1 555 10/21/2022
20.0.0 644 10/1/2022
19.4.1 645 9/10/2022
19.4.0 594 9/2/2022
19.3.0 573 8/23/2022
19.2.2 617 8/11/2022
19.2.1 629 8/6/2022
19.2.0 704 7/24/2022
19.1.4 1,174 5/23/2022
19.1.3 567 5/22/2022
19.1.2 584 5/18/2022
19.1.1 722 4/28/2022
19.1.0 709 4/10/2022
19.0.7 744 3/13/2022
19.0.6 637 3/7/2022
19.0.5 689 1/28/2022
19.0.4 629 1/23/2022
19.0.3 646 12/14/2021
19.0.2 491 12/11/2021
19.0.1 920 11/20/2021
19.0.0 565 11/11/2021
19.0.0-rc.net60.2 177 9/26/2021
19.0.0-rc.net60.1 214 9/16/2021
18.1.6 1,006 9/26/2021
18.1.5 582 9/7/2021
18.1.4 533 9/6/2021
18.1.3 542 8/19/2021
18.1.2 625 8/8/2021
18.1.1 547 8/5/2021
18.1.0 587 8/1/2021
18.0.1 577 7/30/2021
18.0.0 580 7/26/2021
17.0.8 631 7/7/2021
17.0.7 1,791 6/16/2021
17.0.6 582 6/5/2021
17.0.5 611 5/28/2021
17.0.4 619 5/4/2021
17.0.3 573 5/1/2021
17.0.2 548 4/22/2021
17.0.1 576 4/18/2021
17.0.0 615 3/26/2021
16.5.6 615 3/25/2021
16.5.5 588 3/23/2021
16.5.4 599 3/9/2021
16.5.3 553 2/26/2021
16.5.2 575 2/23/2021
16.5.1 606 2/21/2021
16.5.0 552 2/17/2021
16.4.5 546 2/15/2021
16.4.4 531 2/5/2021
16.4.3 573 1/27/2021
16.4.2 633 1/22/2021
16.4.1 631 1/21/2021
16.4.0 619 1/11/2021
16.3.3 636 1/8/2021
16.3.2 630 1/3/2021
16.3.1 590 12/31/2020
16.3.0 560 12/30/2020
16.2.1 575 12/27/2020
16.2.0 834 10/13/2020
16.1.5 778 10/4/2020
16.1.4 972 9/17/2020
16.1.3 819 9/13/2020
16.1.2 682 9/9/2020
16.1.1 754 9/3/2020
16.1.0 715 8/19/2020
16.0.3 708 8/15/2020
16.0.2 735 8/9/2020
16.0.1 756 8/8/2020
16.0.0 652 8/7/2020
15.3.0 1,333 7/23/2020
15.2.3 714 7/14/2020
15.2.2 770 5/19/2020
15.2.1 749 5/12/2020
15.2.0 1,285 5/9/2020
15.1.1 765 5/4/2020
15.1.0 1,563 4/13/2020
15.0.5 3,024 3/18/2020
15.0.4 835 2/28/2020
15.0.3 739 2/26/2020
15.0.2 824 1/20/2020
15.0.1 844 1/10/2020
15.0.0 742 12/17/2019
14.9.1 794 11/30/2019
14.9.0 787 11/29/2019
14.8.1 789 11/26/2019
14.8.0 743 11/20/2019
14.7.0 775 10/9/2019
14.6.6 749 10/8/2019
14.6.5 758 9/27/2019
14.6.4 762 9/21/2019
14.6.3 901 8/12/2019
14.6.2 840 8/3/2019
14.6.1 736 8/3/2019
14.6.0 828 7/26/2019
14.5.7 818 7/18/2019
14.5.6 1,201 7/10/2019
14.5.5 799 7/1/2019
14.5.4 764 6/17/2019
14.5.3 837 6/5/2019
14.5.2 869 5/30/2019
14.5.1 863 5/28/2019
14.5.0 831 5/24/2019
14.4.0 1,532 5/22/2019
14.3.4 875 5/14/2019
14.3.3 826 5/9/2019
14.3.2 863 4/30/2019
14.3.1 871 4/27/2019
14.3.0 843 4/24/2019
14.2.3 853 4/17/2019
14.2.2 896 4/10/2019
14.2.1 904 4/5/2019
14.2.0 922 3/16/2019
14.1.1 869 3/8/2019
14.1.0 1,155 2/11/2019
14.0.4 2,398 1/31/2019
14.0.3 1,012 1/22/2019
14.0.2 954 12/15/2018
14.0.1 994 11/29/2018
14.0.0 1,023 11/19/2018
13.3.0 1,015 11/16/2018
13.2.2 1,005 11/15/2018
13.2.1 1,015 11/13/2018
13.2.0 1,087 10/31/2018
13.1.5 1,055 10/31/2018
13.1.4 1,030 10/25/2018
13.1.3 1,325 10/18/2018
13.1.2 1,141 9/12/2018
13.1.1 1,115 9/11/2018
13.1.0 1,081 9/11/2018
13.0.0 1,088 8/29/2018
12.3.6 1,139 8/29/2018
12.3.5 1,104 8/22/2018
12.3.4 1,156 8/21/2018
12.3.3 25,832 8/21/2018
12.3.2 1,105 8/20/2018
12.3.1 1,135 8/20/2018
12.3.0 1,122 8/20/2018
12.2.2 1,181 8/15/2018
12.2.1 1,160 8/9/2018
12.2.0 1,125 8/8/2018
12.1.11 1,090 7/30/2018
12.1.10 8,126 7/20/2018
12.1.9 1,212 7/10/2018
12.1.8 1,136 7/2/2018
12.1.7 1,326 6/7/2018
12.1.6 1,179 6/4/2018
12.1.5 1,200 6/2/2018
12.1.4 1,173 5/25/2018
12.1.3 1,411 5/16/2018
12.1.2 1,237 5/15/2018
12.1.1 1,284 5/14/2018
12.1.0 1,134 5/9/2018
12.0.7 1,365 5/5/2018
12.0.6 1,338 5/4/2018
12.0.5 1,317 5/3/2018
12.0.4 1,328 4/30/2018
12.0.3 1,157 4/30/2018
12.0.2 1,249 4/27/2018
12.0.1 1,122 4/25/2018
12.0.0 1,109 4/22/2018
11.2.0 1,314 4/11/2018
11.1.0 1,238 4/8/2018
11.0.8 1,274 3/26/2018
11.0.7 1,243 3/20/2018
11.0.6 1,206 3/7/2018
11.0.5 1,198 2/22/2018
11.0.4 1,264 2/14/2018
11.0.3 1,293 2/12/2018
11.0.2 1,169 2/9/2018
11.0.1 1,267 1/29/2018
11.0.0 1,571 1/15/2018
10.0.3 1,256 12/29/2017
10.0.2 1,268 12/26/2017
10.0.1 1,317 12/18/2017
10.0.0 1,172 12/18/2017
9.3.0 1,310 12/17/2017
9.2.0 1,297 12/17/2017
9.1.3 1,267 12/5/2017
9.1.2 1,271 11/27/2017
9.1.1 1,227 11/21/2017
9.1.0 1,216 11/21/2017
9.0.1 1,205 11/11/2017
9.0.0 1,253 11/10/2017
8.7.0 1,246 11/9/2017
8.6.0 1,220 11/9/2017
8.5.0 1,246 10/3/2017
8.4.0 1,243 10/3/2017
8.3.1 1,507 9/8/2017
8.3.0 1,284 9/8/2017
8.2.0 1,310 9/4/2017
8.1.0 1,314 8/22/2017
8.0.0 1,436 8/19/2017
7.1.3 1,284 8/14/2017
7.1.2 1,231 8/2/2017
7.1.1 1,208 7/26/2017
7.1.0 1,306 7/5/2017
7.0.9 1,319 6/28/2017
7.0.8 1,340 6/19/2017
7.0.6 1,364 4/7/2017
7.0.5 1,308 3/21/2017
7.0.4 1,280 3/21/2017
7.0.3 1,309 3/20/2017
7.0.2 1,292 3/13/2017
7.0.0 1,300 3/1/2017
6.2.0 1,407 2/25/2017
6.1.0 1,307 2/14/2017
6.0.0 1,429 2/9/2017
5.3.0 1,332 2/5/2017
5.2.0 1,283 1/26/2017
5.1.0 1,289 1/19/2017
5.0.0 1,288 1/7/2017
4.11.0 1,280 1/5/2017
4.10.0 1,293 12/31/2016
4.9.0 1,246 12/26/2016
4.8.0 1,252 12/17/2016
4.7.0 1,295 12/8/2016
4.6.5 1,311 12/4/2016
4.6.4 1,272 11/25/2016
4.6.2 1,292 11/18/2016
4.6.1 1,257 11/15/2016
4.6.0 1,270 11/11/2016
4.5.9 1,455 11/2/2016
4.5.8 1,345 11/2/2016
4.5.7 1,254 10/26/2016
4.5.6 1,239 10/6/2016
4.5.5 1,257 10/3/2016
4.5.4 1,240 10/2/2016
4.5.3 1,264 9/30/2016
4.5.2 1,299 9/28/2016
4.5.1 1,257 9/28/2016
4.5.0 1,287 9/28/2016