Audit.WCF 30.0.1

There is a newer version of this package available.
See the version list below for details.
dotnet add package Audit.WCF --version 30.0.1
                    
NuGet\Install-Package Audit.WCF -Version 30.0.1
                    
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="30.0.1" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Audit.WCF" Version="30.0.1" />
                    
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 30.0.1
                    
#r "nuget: Audit.WCF, 30.0.1"
                    
#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@30.0.1
                    
#: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=30.0.1
                    
Install as a Cake Addin
#tool nuget:?package=Audit.WCF&version=30.0.1
                    
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 165 6/26/2025
30.0.1 168 5/29/2025
30.0.0 149 5/27/2025
29.0.1 159 5/8/2025
29.0.0 154 5/6/2025
28.0.0 153 5/5/2025
27.5.3 178 4/23/2025
27.5.2 192 4/9/2025
27.5.1 99 4/4/2025
27.5.0 261 3/5/2025
27.4.1 210 2/9/2025
27.4.0 121 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 118 12/8/2024
27.2.0 155 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 137 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 569 10/9/2023
21.0.4 590 9/15/2023
21.0.3 792 7/9/2023
21.0.2 721 7/6/2023
21.0.1 791 5/27/2023
21.0.0 835 4/15/2023
20.2.4 892 3/27/2023
20.2.3 835 3/17/2023
20.2.2 874 3/14/2023
20.2.1 862 3/11/2023
20.2.0 867 3/7/2023
20.1.6 883 2/23/2023
20.1.5 905 2/9/2023
20.1.4 918 1/28/2023
20.1.3 952 12/21/2022
20.1.2 1,005 12/14/2022
20.1.1 983 12/12/2022
20.1.0 970 12/4/2022
20.0.4 1,055 11/30/2022
20.0.3 1,096 10/28/2022
20.0.2 1,064 10/26/2022
20.0.1 1,097 10/21/2022
20.0.0 1,134 10/1/2022
19.4.1 1,166 9/10/2022
19.4.0 1,146 9/2/2022
19.3.0 1,121 8/23/2022
19.2.2 1,108 8/11/2022
19.2.1 1,162 8/6/2022
19.2.0 1,141 7/24/2022
19.1.4 1,402 5/23/2022
19.1.3 1,195 5/22/2022
19.1.2 1,264 5/18/2022
19.1.1 1,256 4/28/2022
19.1.0 1,186 4/10/2022
19.0.7 2,518 3/13/2022
19.0.6 1,241 3/7/2022
19.0.5 1,302 1/28/2022
19.0.4 1,254 1/23/2022
19.0.3 1,137 12/14/2021
19.0.2 1,125 12/11/2021
19.0.1 1,479 11/20/2021
19.0.0 1,186 11/11/2021
19.0.0-rc.net60.2 221 9/26/2021
19.0.0-rc.net60.1 277 9/16/2021
18.1.6 1,234 9/26/2021
18.1.5 2,453 9/7/2021
18.1.4 1,174 9/6/2021
18.1.3 1,185 8/19/2021
18.1.2 1,241 8/8/2021
18.1.1 1,246 8/5/2021
18.1.0 1,318 8/1/2021
18.0.1 1,245 7/30/2021
18.0.0 1,246 7/26/2021
17.0.8 1,231 7/7/2021
17.0.7 1,221 6/16/2021
17.0.6 1,188 6/5/2021
17.0.5 1,239 5/28/2021
17.0.4 1,304 5/4/2021
17.0.3 1,281 5/1/2021
17.0.2 1,219 4/22/2021
17.0.1 1,211 4/18/2021
17.0.0 1,234 3/26/2021
16.5.6 1,221 3/25/2021
16.5.5 1,193 3/23/2021
16.5.4 1,235 3/9/2021
16.5.3 1,261 2/26/2021
16.5.2 1,244 2/23/2021
16.5.1 1,234 2/21/2021
16.5.0 1,228 2/17/2021
16.4.5 1,256 2/15/2021
16.4.4 1,231 2/5/2021
16.4.3 1,186 1/27/2021
16.4.2 1,243 1/22/2021
16.4.1 1,223 1/21/2021
16.4.0 1,236 1/11/2021
16.3.3 1,250 1/8/2021
16.3.2 1,266 1/3/2021
16.3.1 1,307 12/31/2020
16.3.0 1,230 12/30/2020
16.2.1 1,280 12/27/2020
16.2.0 1,551 10/13/2020
16.1.5 1,376 10/4/2020
16.1.4 1,379 9/17/2020
16.1.3 1,394 9/13/2020
16.1.2 1,277 9/9/2020
16.1.1 1,314 9/3/2020
16.1.0 1,313 8/19/2020
16.0.3 1,343 8/15/2020
16.0.2 1,308 8/9/2020
16.0.1 1,403 8/8/2020
16.0.0 1,308 8/7/2020
15.3.0 2,214 7/23/2020
15.2.3 1,419 7/14/2020
15.2.2 1,415 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,376 11/29/2019
14.8.1 1,397 11/26/2019
14.8.0 1,406 11/20/2019
14.7.0 6,453 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,457 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,503 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,662 1/31/2019
14.0.3 1,597 1/22/2019
14.0.2 1,760 12/15/2018
14.0.1 1,681 11/29/2018
14.0.0 1,658 11/19/2018
13.3.0 1,732 11/16/2018
13.2.2 1,683 11/15/2018
13.2.1 1,600 11/13/2018
13.2.0 1,661 10/31/2018
13.1.5 1,611 10/31/2018
13.1.4 1,648 10/25/2018
13.1.3 1,686 10/18/2018
13.1.2 1,827 9/12/2018
13.1.1 1,744 9/11/2018
13.1.0 1,749 9/11/2018
13.0.0 1,743 8/29/2018
12.3.6 1,685 8/29/2018
12.3.5 1,770 8/22/2018
12.3.4 1,790 8/21/2018
12.3.3 26,512 8/21/2018
12.3.2 1,757 8/20/2018
12.3.1 1,786 8/20/2018
12.3.0 1,775 8/20/2018
12.2.2 1,797 8/15/2018
12.2.1 1,848 8/9/2018
12.2.0 1,838 8/8/2018
12.1.11 1,822 7/30/2018
12.1.10 1,893 7/20/2018
12.1.9 2,106 7/10/2018
12.1.8 3,427 7/2/2018
12.1.7 2,092 6/7/2018
12.1.6 1,928 6/4/2018
12.1.5 2,057 6/2/2018
12.1.4 1,944 5/25/2018
12.1.3 2,434 5/16/2018
12.1.2 1,965 5/15/2018
12.1.1 2,194 5/14/2018
12.1.0 2,109 5/9/2018
12.0.7 2,153 5/5/2018
12.0.6 1,919 5/4/2018
12.0.5 2,122 5/3/2018
12.0.4 2,162 4/30/2018
12.0.3 2,149 4/30/2018
12.0.2 2,147 4/27/2018
12.0.1 2,134 4/25/2018
12.0.0 1,936 4/22/2018
11.2.0 2,202 4/11/2018
11.1.0 1,962 4/8/2018
11.0.8 2,120 3/26/2018
11.0.7 1,907 3/20/2018
11.0.6 2,140 3/7/2018
11.0.5 2,216 2/22/2018
11.0.4 2,133 2/14/2018
11.0.3 2,107 2/12/2018
11.0.2 2,120 2/9/2018
11.0.1 1,972 1/29/2018
11.0.0 2,103 1/15/2018
10.0.3 2,111 12/29/2017
10.0.2 1,904 12/26/2017
10.0.1 2,128 12/18/2017
10.0.0 1,941 12/18/2017
9.3.0 2,104 12/17/2017
9.2.0 2,099 12/17/2017
9.1.3 2,037 12/5/2017
9.1.2 1,914 11/27/2017
9.1.1 1,992 11/21/2017
9.1.0 1,907 11/21/2017
9.0.1 1,884 11/11/2017
9.0.0 1,890 11/10/2017
8.7.0 1,919 11/9/2017
8.6.0 1,873 11/9/2017
8.5.0 1,903 10/3/2017
8.4.0 1,957 10/3/2017
8.3.1 2,497 9/8/2017
8.3.0 1,950 9/8/2017
8.2.0 1,930 9/4/2017
8.1.0 2,003 8/22/2017
8.0.0 2,145 8/19/2017
7.1.3 1,925 8/14/2017
7.1.2 1,932 8/2/2017
7.1.1 1,873 7/26/2017
7.1.0 1,932 7/5/2017
7.0.9 1,887 6/28/2017
7.0.8 2,009 6/19/2017
7.0.6 1,961 4/7/2017
7.0.5 1,889 3/21/2017
7.0.4 1,924 3/21/2017
7.0.3 1,912 3/20/2017
7.0.2 1,917 3/13/2017
7.0.0 1,990 3/1/2017
6.2.0 1,991 2/25/2017
6.1.0 2,004 2/14/2017
6.0.0 2,047 2/9/2017
5.3.0 1,950 2/5/2017
5.2.0 1,886 1/26/2017
5.1.0 1,922 1/19/2017
5.0.0 1,929 1/7/2017
4.11.0 1,994 1/5/2017
4.10.0 1,989 12/31/2016
4.9.0 1,907 12/26/2016
4.8.0 3,650 12/17/2016
4.7.0 2,024 12/8/2016
4.6.5 1,950 12/4/2016
4.6.4 1,936 11/25/2016
4.6.2 3,637 11/18/2016
4.6.1 2,001 11/15/2016
4.6.0 1,946 11/11/2016
4.5.9 3,861 11/2/2016
4.5.8 2,078 11/2/2016
4.5.7 3,765 10/26/2016
4.5.6 1,983 10/6/2016
4.5.5 1,982 10/3/2016
4.5.4 1,928 10/2/2016
4.5.3 1,956 9/30/2016
4.5.2 3,729 9/28/2016
4.5.1 3,650 9/28/2016
4.5.0 3,600 9/28/2016
4.4.0 3,833 9/23/2016
4.3.0 2,069 9/22/2016
4.2.0 2,224 9/19/2016
4.1.1 1,992 9/13/2016
4.1.0 1,970 9/13/2016