Audit.WCF 29.0.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package Audit.WCF --version 29.0.0
                    
NuGet\Install-Package Audit.WCF -Version 29.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.WCF" Version="29.0.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Audit.WCF" Version="29.0.0" />
                    
Directory.Packages.props
<PackageReference Include="Audit.WCF" />
                    
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.WCF --version 29.0.0
                    
#r "nuget: Audit.WCF, 29.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.
#:package Audit.WCF@29.0.0
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Audit.WCF&version=29.0.0
                    
Install as a Cake Addin
#tool nuget:?package=Audit.WCF&version=29.0.0
                    
Install as a Cake Tool

Audit.WCF

WCF Audit Extension for Audit.NET library.

Generate Audit Logs for Windows Communication Foundation (WCF) service calls.

Audit.Wcf provides the server-side infrastructure to log interactions with WCF services. It records detailed information of the service method calls.

If you are looking for client-side audit, please check the Audit.WCF.Client library.

Install

NuGet Package

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

PM> Install-Package Audit.Wcf

NuGet Status NuGet Count

Usage

Decorate your WCF service class or methods with the Audit.WCF.AuditBehavior attribute.

For example:

[AuditBehavior(EventType = "{contract}.{operation}")]
public class OrderService : IOrderService
{
  public async Task<GetOrderResponse> GetOrder(GetOrderRequest request)
  {
    ...
  }
}

You can also decorate the specific methods you want to audit, for example:

public class OrderService : IOrderService
{
  [AuditBehavior]
  public async Task<GetOrderResponse> GetOrder(GetOrderRequest request)
  {
    ...
  }
}

If you can't (or do not want) to change the service code, you can also enable the audit mechanism by adding the AuditBehavior extension to your service host configuration file.

For example:

<configuration>
  <system.serviceModel>
    ...
    <extensions>
      <behaviorExtensions>
	      <add name="auditBehavior" type="Audit.WCF.AuditBehavior, Audit.WCF" />
      </behaviorExtensions>
    </extensions>

    <behaviors>
      <serviceBehaviors>
	      <behavior>
	        <auditBehavior eventType="{contract}.{operation}" />
	      </behavior>
      </serviceBehaviors>
    </behaviors>
    ...
  </system.serviceModel>
</configuration>

Configuration

The AuditBehavior attribute or extension can be configured with the following properties:

  • EventTypeName: A string that identifies the event type. Can contain the following placeholders:
    • {contract}: Replaced with the contract name (service interface name)
    • {operation}: Replaces with the operation name (service method name)
  • AuditDataProvider: Allows to set a specific audit data provider. By default the globally configured data provider is used. See Audit.NET Data Providers section for more information.
  • AuditScopeFactory: Allows to set a specific audit scope factory. By default the globally configured AuditScopeFactory is used.

To globally configure the output persistence mechanism, use the Audit.Core.Configuration class. For more details please see Event Output Configuration.

For example:

Audit.Core.Configuration.Setup()
	.UseFileLogProvider(config => config.Directory(@"C:\Logs"));

This should be done prior to the AuditScope creation, i.e. during application startup.

If you want to configure an Audit Data Provider per service instance, you can add a public instance property named AuditDataProvider to your service class and make it return the provider you want, for example:

[AuditBehavior]
public class OrderService : IOrderService
{
    public AuditDataProvider AuditDataProvider
    {
        get
        {
            return new Audit.Core.Providers.FileDataProvider()
            {
                DirectoryPath = @"C:\Logs"
            };
        }
    }
}

The library will automatically detect the property and use the given data provider for that service instance.

You can do the same with the AuditScopeFactory property to provide a custom IAuditScopeFactory instance.


## Output

`Audit.Wcf` output includes:

- Execution time and duration
- Environment information such as user, machine, domain and locale.
- Authenticated username (identity name)
- Client IP address
- Contract and Operation details
- Method parameters (in and out)
- Response object
- Faults and Exceptions details
- [Comments and Custom Fields](#custom-fields-and-comments) provided

With this information, you can not just know who did the operation, but also measure performance, observe exceptions thrown or get statistics about usage of your WCF service.

## Output details

The following table describes the `Audit.Wcf` output fields:

- ### [AuditWcfEvent](https://github.com/thepirat000/Audit.NET/blob/master/src/Audit.WCF/AuditWcfEvent.cs)

Describes an audited WCF event

| Field Name | Type | Description | 
| ------------ | ---------------- |  -------------- |
| ContractName | string | Name of the contract (service interface) |
| OperationName | string | Name of the operation (service method) |
| InstanceQualifiedName | string | Assembly qualified type name of the service instance |
| IsAsync | boolean | Indicates if the operation is asynchronous |
| MethodSignature | string | Signature of the audited method |
| Action | string | Action absolute address |
| ReplyAction | string |Reply action absolute address |
| IdentityName | string | Name of the current identity (username) |
| ClientAddress | string | Client address (IP) |
| HostAddress | string | Serice host address |
| Success | boolean | Indicates if the operation completed succesfully |
| Fault | [AuditWcfEventFault](#AuditWcfEventFault) | Fault details when the operation fails |
| Result | Object | The result object value |
| InputParameters | Array of [AuditWcfEventElement](#AuditWcfEventElement) | Input parameters object values |
| OutputParameters | Array of [AuditWcfEventElement](#AuditWcfEventElement) | Output parameters object values |

- ### [AuditWcfEventFault](https://github.com/thepirat000/Audit.NET/blob/master/src/Audit.WCF/AuditWcfEventFault.cs)

Describes a WCF fault/exception

| Field Name | Type | Description | 
| ------------ | ---------------- |  -------------- |
| FaultType | string | Fault type (Exception / Fault) |
| Exception | string | Exception details |
| FaultCode | string | The fault code |
| FaultAction | string | The fault action name |
| FaultReason | string | The fault reason |
| FaultDetails | [AuditWcfEventElement](#AuditWcfEventElement) | The detail object related to the fault |

- ### [AuditWcfEventElement](https://github.com/thepirat000/Audit.NET/blob/master/src/Audit.WCF/AuditWcfEventElement.cs)

Describes an element/object related to the WCF audit event.

| Field Name | Type | Description | 
| ------------ | ---------------- |  -------------- |
| Type | string | The object type name |
| Value | Object | The object value |

## Customization

You can access the `AuditScope` object for customization from the audited methods, by the static property `Audit.WCF.AuditBehavior.CurrentAuditScope`. 

For example:
```c#
using Audit.WCF;

[AuditBehavior]
public class OrderService : IOrderService
{
    public GetOrderResponse GetOrder(GetOrderRequest request)
    {
        AuditBehavior.CurrentAuditScope.Comment("some comment");
        AuditBehavior.CurrentAuditScope.SetCustomField("User", MySession.CurrentUser);
        ...
    }
}

See Audit.NET documentation about Custom Field and Comments for more information.

Output Sample

{
	"EventType": "IOrderService.GetOrder",
	"Environment": {
		"UserName": "Federico",
		"MachineName": "HP",
		"DomainName": "HP",
		"CallingMethodName": "WCF_IIS.IOrderService.GetData()",
		"AssemblyName": "WCF_IIS, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null",
		"Exception": null,
		"Culture": "en-GB"
	},
	"StartDate": "2016-09-13T01:31:58.6843094-05:00",
	"EndDate": "2016-09-13T01:31:58.6858324-05:00",
	"Duration": 2,
	"WcfEvent": {
		"ContractName": "IOrderService",
		"OperationName": "GetOrder",
		"InstanceQualifiedName": "WCF_IIS.OrderService, WCF_IIS, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null",
		"MethodSignature": "WCF_IIS.GetOrderResponse GetOrder(WCF_IIS.GetOrderRequest)",
		"Action": "http://tempuri.org/IOrderService/GetOrder",
		"ReplyAction": "http://tempuri.org/IOrderService/GetOrderResponse",
		"ClientAddress": "::1",
		"HostAddress": "http://localhost:8733/Design_Time_Addresses/WCF_IIS/OrderService/",
		"InputParameters": [{
			"Type": "GetOrderRequest",
			"Value": {
				"OrderId": 123
			}
		}],
		"Success": true,
		"Result": {
			"Type": "GetOrderResponse",
			"Value": {
				"Success": true,
				"Errors": null,
				"Order": {
					"OrderId": 123,
					"CustomerName": "customer",
					"Total": 10.0
				}
			}
		},
		"OutputParameters": []
	}
}

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 Framework net462 is compatible.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 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
30.0.2 170 6/26/2025
30.0.1 169 5/29/2025
30.0.0 150 5/27/2025
29.0.1 161 5/8/2025
29.0.0 156 5/6/2025
28.0.0 155 5/5/2025
27.5.3 178 4/23/2025
27.5.2 192 4/9/2025
27.5.1 101 4/4/2025
27.5.0 262 3/5/2025
27.4.1 210 2/9/2025
27.4.0 122 1/29/2025
27.3.3 123 1/21/2025
27.3.2 176 12/11/2024
27.3.1 113 12/10/2024
27.3.0 119 12/8/2024
27.2.0 157 11/23/2024
27.1.1 114 10/28/2024
27.1.0 334 10/24/2024
27.0.3 134 9/25/2024
27.0.2 140 9/19/2024
27.0.1 135 9/4/2024
27.0.0 129 9/3/2024
26.0.1 369 8/22/2024
26.0.0 155 7/19/2024
25.0.7 164 7/4/2024
25.0.6 138 6/24/2024
25.0.5 135 6/18/2024
25.0.4 204 3/24/2024
25.0.3 228 3/13/2024
25.0.2 213 3/12/2024
25.0.1 237 2/28/2024
25.0.0 269 2/16/2024
24.0.1 305 2/12/2024
24.0.0 280 2/12/2024
23.0.0 555 12/14/2023
22.1.0 481 12/9/2023
22.0.2 484 12/1/2023
22.0.1 504 11/16/2023
22.0.0 491 11/14/2023
21.1.0 570 10/9/2023
21.0.4 590 9/15/2023
21.0.3 793 7/9/2023
21.0.2 723 7/6/2023
21.0.1 792 5/27/2023
21.0.0 836 4/15/2023
20.2.4 894 3/27/2023
20.2.3 837 3/17/2023
20.2.2 876 3/14/2023
20.2.1 864 3/11/2023
20.2.0 869 3/7/2023
20.1.6 885 2/23/2023
20.1.5 907 2/9/2023
20.1.4 920 1/28/2023
20.1.3 955 12/21/2022
20.1.2 1,007 12/14/2022
20.1.1 985 12/12/2022
20.1.0 972 12/4/2022
20.0.4 1,057 11/30/2022
20.0.3 1,100 10/28/2022
20.0.2 1,065 10/26/2022
20.0.1 1,098 10/21/2022
20.0.0 1,136 10/1/2022
19.4.1 1,168 9/10/2022
19.4.0 1,147 9/2/2022
19.3.0 1,122 8/23/2022
19.2.2 1,110 8/11/2022
19.2.1 1,164 8/6/2022
19.2.0 1,143 7/24/2022
19.1.4 1,404 5/23/2022
19.1.3 1,196 5/22/2022
19.1.2 1,268 5/18/2022
19.1.1 1,257 4/28/2022
19.1.0 1,188 4/10/2022
19.0.7 2,525 3/13/2022
19.0.6 1,243 3/7/2022
19.0.5 1,304 1/28/2022
19.0.4 1,255 1/23/2022
19.0.3 1,139 12/14/2021
19.0.2 1,127 12/11/2021
19.0.1 1,481 11/20/2021
19.0.0 1,188 11/11/2021
19.0.0-rc.net60.2 222 9/26/2021
19.0.0-rc.net60.1 280 9/16/2021
18.1.6 1,235 9/26/2021
18.1.5 2,454 9/7/2021
18.1.4 1,175 9/6/2021
18.1.3 1,186 8/19/2021
18.1.2 1,242 8/8/2021
18.1.1 1,247 8/5/2021
18.1.0 1,319 8/1/2021
18.0.1 1,246 7/30/2021
18.0.0 1,247 7/26/2021
17.0.8 1,232 7/7/2021
17.0.7 1,222 6/16/2021
17.0.6 1,189 6/5/2021
17.0.5 1,241 5/28/2021
17.0.4 1,305 5/4/2021
17.0.3 1,282 5/1/2021
17.0.2 1,220 4/22/2021
17.0.1 1,212 4/18/2021
17.0.0 1,235 3/26/2021
16.5.6 1,222 3/25/2021
16.5.5 1,194 3/23/2021
16.5.4 1,236 3/9/2021
16.5.3 1,262 2/26/2021
16.5.2 1,245 2/23/2021
16.5.1 1,235 2/21/2021
16.5.0 1,229 2/17/2021
16.4.5 1,258 2/15/2021
16.4.4 1,232 2/5/2021
16.4.3 1,187 1/27/2021
16.4.2 1,245 1/22/2021
16.4.1 1,224 1/21/2021
16.4.0 1,237 1/11/2021
16.3.3 1,251 1/8/2021
16.3.2 1,268 1/3/2021
16.3.1 1,308 12/31/2020
16.3.0 1,231 12/30/2020
16.2.1 1,281 12/27/2020
16.2.0 1,552 10/13/2020
16.1.5 1,377 10/4/2020
16.1.4 1,380 9/17/2020
16.1.3 1,395 9/13/2020
16.1.2 1,278 9/9/2020
16.1.1 1,316 9/3/2020
16.1.0 1,314 8/19/2020
16.0.3 1,344 8/15/2020
16.0.2 1,309 8/9/2020
16.0.1 1,404 8/8/2020
16.0.0 1,309 8/7/2020
15.3.0 2,214 7/23/2020
15.2.3 1,420 7/14/2020
15.2.2 1,417 5/19/2020
15.2.1 1,379 5/12/2020
15.2.0 1,388 5/9/2020
15.1.1 1,453 5/4/2020
15.1.0 1,478 4/13/2020
15.0.5 1,360 3/18/2020
15.0.4 1,384 2/28/2020
15.0.3 1,379 2/26/2020
15.0.2 1,467 1/20/2020
15.0.1 1,415 1/10/2020
15.0.0 1,444 12/17/2019
14.9.1 1,429 11/30/2019
14.9.0 1,378 11/29/2019
14.8.1 1,397 11/26/2019
14.8.0 1,406 11/20/2019
14.7.0 6,463 10/9/2019
14.6.6 1,351 10/8/2019
14.6.5 1,375 9/27/2019
14.6.4 1,452 9/21/2019
14.6.3 1,822 8/12/2019
14.6.2 1,466 8/3/2019
14.6.1 1,499 8/3/2019
14.6.0 1,501 7/26/2019
14.5.7 1,497 7/18/2019
14.5.6 1,458 7/10/2019
14.5.5 1,458 7/1/2019
14.5.4 1,524 6/17/2019
14.5.3 1,503 6/5/2019
14.5.2 1,475 5/30/2019
14.5.1 1,481 5/28/2019
14.5.0 1,601 5/24/2019
14.4.0 1,545 5/22/2019
14.3.4 1,492 5/14/2019
14.3.3 1,425 5/9/2019
14.3.2 1,655 4/30/2019
14.3.1 1,481 4/27/2019
14.3.0 1,540 4/24/2019
14.2.3 1,552 4/17/2019
14.2.2 1,504 4/10/2019
14.2.1 1,508 4/5/2019
14.2.0 1,541 3/16/2019
14.1.1 1,565 3/8/2019
14.1.0 1,655 2/11/2019
14.0.4 1,663 1/31/2019
14.0.3 1,597 1/22/2019
14.0.2 1,761 12/15/2018
14.0.1 1,682 11/29/2018
14.0.0 1,659 11/19/2018
13.3.0 1,733 11/16/2018
13.2.2 1,684 11/15/2018
13.2.1 1,601 11/13/2018
13.2.0 1,662 10/31/2018
13.1.5 1,612 10/31/2018
13.1.4 1,649 10/25/2018
13.1.3 1,687 10/18/2018
13.1.2 1,828 9/12/2018
13.1.1 1,745 9/11/2018
13.1.0 1,750 9/11/2018
13.0.0 1,744 8/29/2018
12.3.6 1,686 8/29/2018
12.3.5 1,771 8/22/2018
12.3.4 1,791 8/21/2018
12.3.3 26,513 8/21/2018
12.3.2 1,759 8/20/2018
12.3.1 1,787 8/20/2018
12.3.0 1,776 8/20/2018
12.2.2 1,798 8/15/2018
12.2.1 1,849 8/9/2018
12.2.0 1,840 8/8/2018
12.1.11 1,824 7/30/2018
12.1.10 1,896 7/20/2018
12.1.9 2,110 7/10/2018
12.1.8 3,430 7/2/2018
12.1.7 2,096 6/7/2018
12.1.6 1,930 6/4/2018
12.1.5 2,060 6/2/2018
12.1.4 1,947 5/25/2018
12.1.3 2,437 5/16/2018
12.1.2 1,967 5/15/2018
12.1.1 2,197 5/14/2018
12.1.0 2,112 5/9/2018
12.0.7 2,156 5/5/2018
12.0.6 1,921 5/4/2018
12.0.5 2,125 5/3/2018
12.0.4 2,165 4/30/2018
12.0.3 2,153 4/30/2018
12.0.2 2,150 4/27/2018
12.0.1 2,138 4/25/2018
12.0.0 1,939 4/22/2018
11.2.0 2,205 4/11/2018
11.1.0 1,964 4/8/2018
11.0.8 2,123 3/26/2018
11.0.7 1,909 3/20/2018
11.0.6 2,143 3/7/2018
11.0.5 2,219 2/22/2018
11.0.4 2,136 2/14/2018
11.0.3 2,110 2/12/2018
11.0.2 2,123 2/9/2018
11.0.1 1,975 1/29/2018
11.0.0 2,106 1/15/2018
10.0.3 2,114 12/29/2017
10.0.2 1,906 12/26/2017
10.0.1 2,131 12/18/2017
10.0.0 1,943 12/18/2017
9.3.0 2,108 12/17/2017
9.2.0 2,102 12/17/2017
9.1.3 2,039 12/5/2017
9.1.2 1,917 11/27/2017
9.1.1 1,995 11/21/2017
9.1.0 1,910 11/21/2017
9.0.1 1,886 11/11/2017
9.0.0 1,892 11/10/2017
8.7.0 1,921 11/9/2017
8.6.0 1,875 11/9/2017
8.5.0 1,906 10/3/2017
8.4.0 1,962 10/3/2017
8.3.1 2,508 9/8/2017
8.3.0 1,954 9/8/2017
8.2.0 1,934 9/4/2017
8.1.0 2,007 8/22/2017
8.0.0 2,150 8/19/2017
7.1.3 1,929 8/14/2017
7.1.2 1,935 8/2/2017
7.1.1 1,877 7/26/2017
7.1.0 1,935 7/5/2017
7.0.9 1,891 6/28/2017
7.0.8 2,013 6/19/2017
7.0.6 1,966 4/7/2017
7.0.5 1,893 3/21/2017
7.0.4 1,929 3/21/2017
7.0.3 1,916 3/20/2017
7.0.2 1,921 3/13/2017
7.0.0 1,995 3/1/2017
6.2.0 1,995 2/25/2017
6.1.0 2,009 2/14/2017
6.0.0 2,052 2/9/2017
5.3.0 1,955 2/5/2017
5.2.0 1,890 1/26/2017
5.1.0 1,926 1/19/2017
5.0.0 1,933 1/7/2017
4.11.0 1,998 1/5/2017
4.10.0 1,993 12/31/2016
4.9.0 1,912 12/26/2016
4.8.0 3,654 12/17/2016
4.7.0 2,028 12/8/2016
4.6.5 1,954 12/4/2016
4.6.4 1,942 11/25/2016
4.6.2 3,641 11/18/2016
4.6.1 2,005 11/15/2016
4.6.0 1,950 11/11/2016
4.5.9 3,865 11/2/2016
4.5.8 2,082 11/2/2016
4.5.7 3,770 10/26/2016
4.5.6 1,987 10/6/2016
4.5.5 1,988 10/3/2016
4.5.4 1,933 10/2/2016
4.5.3 1,960 9/30/2016
4.5.2 3,734 9/28/2016
4.5.1 3,654 9/28/2016
4.5.0 3,604 9/28/2016
4.4.0 3,841 9/23/2016
4.3.0 2,074 9/22/2016
4.2.0 2,229 9/19/2016
4.1.1 1,997 9/13/2016
4.1.0 1,975 9/13/2016