Audit.WCF 22.0.0

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

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

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)

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.

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 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:

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 Fault details when the operation fails
Result Object The result object value
InputParameters Array of AuditWcfEventElement Input parameters object values
OutputParameters Array of AuditWcfEventElement Output parameters object values

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 The detail object related to the fault

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:

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": []
	}
}
Product Compatible and additional computed target framework versions.
.NET Framework net45 is compatible.  net451 was computed.  net452 was computed.  net46 was computed.  net461 was computed.  net462 was computed.  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
27.5.0 211 3/5/2025
27.4.1 177 2/9/2025
27.4.0 99 1/29/2025
27.3.3 100 1/21/2025
27.3.2 156 12/11/2024
27.3.1 91 12/10/2024
27.3.0 98 12/8/2024
27.2.0 131 11/23/2024
27.1.1 94 10/28/2024
27.1.0 315 10/24/2024
27.0.3 112 9/25/2024
27.0.2 119 9/19/2024
27.0.1 115 9/4/2024
27.0.0 112 9/3/2024
26.0.1 349 8/22/2024
26.0.0 132 7/19/2024
25.0.7 147 7/4/2024
25.0.6 112 6/24/2024
25.0.5 118 6/18/2024
25.0.4 185 3/24/2024
25.0.3 210 3/13/2024
25.0.2 191 3/12/2024
25.0.1 213 2/28/2024
25.0.0 245 2/16/2024
24.0.1 287 2/12/2024
24.0.0 258 2/12/2024
23.0.0 532 12/14/2023
22.1.0 463 12/9/2023
22.0.2 466 12/1/2023
22.0.1 486 11/16/2023
22.0.0 476 11/14/2023
21.1.0 541 10/9/2023
21.0.4 569 9/15/2023
21.0.3 752 7/9/2023
21.0.2 684 7/6/2023
21.0.1 760 5/27/2023
21.0.0 802 4/15/2023
20.2.4 863 3/27/2023
20.2.3 798 3/17/2023
20.2.2 843 3/14/2023
20.2.1 822 3/11/2023
20.2.0 836 3/7/2023
20.1.6 853 2/23/2023
20.1.5 875 2/9/2023
20.1.4 875 1/28/2023
20.1.3 912 12/21/2022
20.1.2 975 12/14/2022
20.1.1 953 12/12/2022
20.1.0 936 12/4/2022
20.0.4 1,018 11/30/2022
20.0.3 1,065 10/28/2022
20.0.2 1,029 10/26/2022
20.0.1 1,064 10/21/2022
20.0.0 1,102 10/1/2022
19.4.1 1,133 9/10/2022
19.4.0 1,113 9/2/2022
19.3.0 1,086 8/23/2022
19.2.2 1,067 8/11/2022
19.2.1 1,127 8/6/2022
19.2.0 1,103 7/24/2022
19.1.4 1,351 5/23/2022
19.1.3 1,153 5/22/2022
19.1.2 1,213 5/18/2022
19.1.1 1,212 4/28/2022
19.1.0 1,143 4/10/2022
19.0.7 1,900 3/13/2022
19.0.6 1,200 3/7/2022
19.0.5 1,258 1/28/2022
19.0.4 1,209 1/23/2022
19.0.3 1,092 12/14/2021
19.0.2 1,081 12/11/2021
19.0.1 1,433 11/20/2021
19.0.0 1,135 11/11/2021
19.0.0-rc.net60.2 181 9/26/2021
19.0.0-rc.net60.1 231 9/16/2021
18.1.6 1,189 9/26/2021
18.1.5 2,393 9/7/2021
18.1.4 1,128 9/6/2021
18.1.3 1,137 8/19/2021
18.1.2 1,193 8/8/2021
18.1.1 1,199 8/5/2021
18.1.0 1,273 8/1/2021
18.0.1 1,199 7/30/2021
18.0.0 1,197 7/26/2021
17.0.8 1,183 7/7/2021
17.0.7 1,174 6/16/2021
17.0.6 1,138 6/5/2021
17.0.5 1,182 5/28/2021
17.0.4 1,245 5/4/2021
17.0.3 1,229 5/1/2021
17.0.2 1,167 4/22/2021
17.0.1 1,161 4/18/2021
17.0.0 1,183 3/26/2021
16.5.6 1,167 3/25/2021
16.5.5 1,141 3/23/2021
16.5.4 1,180 3/9/2021
16.5.3 1,206 2/26/2021
16.5.2 1,190 2/23/2021
16.5.1 1,182 2/21/2021
16.5.0 1,176 2/17/2021
16.4.5 1,200 2/15/2021
16.4.4 1,180 2/5/2021
16.4.3 1,132 1/27/2021
16.4.2 1,191 1/22/2021
16.4.1 1,172 1/21/2021
16.4.0 1,186 1/11/2021
16.3.3 1,197 1/8/2021
16.3.2 1,209 1/3/2021
16.3.1 1,252 12/31/2020
16.3.0 1,176 12/30/2020
16.2.1 1,227 12/27/2020
16.2.0 1,489 10/13/2020
16.1.5 1,326 10/4/2020
16.1.4 1,325 9/17/2020
16.1.3 1,341 9/13/2020
16.1.2 1,225 9/9/2020
16.1.1 1,257 9/3/2020
16.1.0 1,260 8/19/2020
16.0.3 1,290 8/15/2020
16.0.2 1,250 8/9/2020
16.0.1 1,352 8/8/2020
16.0.0 1,255 8/7/2020
15.3.0 2,161 7/23/2020
15.2.3 1,357 7/14/2020
15.2.2 1,352 5/19/2020
15.2.1 1,315 5/12/2020
15.2.0 1,330 5/9/2020
15.1.1 1,393 5/4/2020
15.1.0 1,418 4/13/2020
15.0.5 1,300 3/18/2020
15.0.4 1,327 2/28/2020
15.0.3 1,322 2/26/2020
15.0.2 1,410 1/20/2020
15.0.1 1,356 1/10/2020
15.0.0 1,384 12/17/2019
14.9.1 1,372 11/30/2019
14.9.0 1,305 11/29/2019
14.8.1 1,338 11/26/2019
14.8.0 1,344 11/20/2019
14.7.0 4,424 10/9/2019
14.6.6 1,290 10/8/2019
14.6.5 1,316 9/27/2019
14.6.4 1,389 9/21/2019
14.6.3 1,760 8/12/2019
14.6.2 1,407 8/3/2019
14.6.1 1,439 8/3/2019
14.6.0 1,432 7/26/2019
14.5.7 1,436 7/18/2019
14.5.6 1,398 7/10/2019
14.5.5 1,396 7/1/2019
14.5.4 1,461 6/17/2019
14.5.3 1,442 6/5/2019
14.5.2 1,415 5/30/2019
14.5.1 1,406 5/28/2019
14.5.0 1,536 5/24/2019
14.4.0 1,484 5/22/2019
14.3.4 1,427 5/14/2019
14.3.3 1,365 5/9/2019
14.3.2 1,590 4/30/2019
14.3.1 1,421 4/27/2019
14.3.0 1,477 4/24/2019
14.2.3 1,490 4/17/2019
14.2.2 1,441 4/10/2019
14.2.1 1,448 4/5/2019
14.2.0 1,480 3/16/2019
14.1.1 1,498 3/8/2019
14.1.0 1,595 2/11/2019
14.0.4 1,601 1/31/2019
14.0.3 1,537 1/22/2019
14.0.2 1,697 12/15/2018
14.0.1 1,621 11/29/2018
14.0.0 1,594 11/19/2018
13.3.0 1,666 11/16/2018
13.2.2 1,618 11/15/2018
13.2.1 1,536 11/13/2018
13.2.0 1,595 10/31/2018
13.1.5 1,546 10/31/2018
13.1.4 1,582 10/25/2018
13.1.3 1,622 10/18/2018
13.1.2 1,760 9/12/2018
13.1.1 1,666 9/11/2018
13.1.0 1,678 9/11/2018
13.0.0 1,669 8/29/2018
12.3.6 1,615 8/29/2018
12.3.5 1,698 8/22/2018
12.3.4 1,721 8/21/2018
12.3.3 26,437 8/21/2018
12.3.2 1,682 8/20/2018
12.3.1 1,714 8/20/2018
12.3.0 1,704 8/20/2018
12.2.2 1,725 8/15/2018
12.2.1 1,775 8/9/2018
12.2.0 1,720 8/8/2018
12.1.11 1,701 7/30/2018
12.1.10 1,773 7/20/2018
12.1.9 1,921 7/10/2018
12.1.8 3,168 7/2/2018
12.1.7 1,909 6/7/2018
12.1.6 1,807 6/4/2018
12.1.5 1,877 6/2/2018
12.1.4 1,809 5/25/2018
12.1.3 2,237 5/16/2018
12.1.2 1,835 5/15/2018
12.1.1 1,998 5/14/2018
12.1.0 1,932 5/9/2018
12.0.7 1,974 5/5/2018
12.0.6 1,798 5/4/2018
12.0.5 1,942 5/3/2018
12.0.4 1,987 4/30/2018
12.0.3 1,967 4/30/2018
12.0.2 1,969 4/27/2018
12.0.1 1,952 4/25/2018
12.0.0 1,812 4/22/2018
11.2.0 2,022 4/11/2018
11.1.0 1,838 4/8/2018
11.0.8 1,943 3/26/2018
11.0.7 1,789 3/20/2018
11.0.6 1,964 3/7/2018
11.0.5 2,091 2/22/2018
11.0.4 1,954 2/14/2018
11.0.3 1,933 2/12/2018
11.0.2 1,944 2/9/2018
11.0.1 1,847 1/29/2018
11.0.0 1,924 1/15/2018
10.0.3 1,934 12/29/2017
10.0.2 1,785 12/26/2017
10.0.1 1,954 12/18/2017
10.0.0 1,823 12/18/2017
9.3.0 1,931 12/17/2017
9.2.0 1,921 12/17/2017
9.1.3 1,913 12/5/2017
9.1.2 1,795 11/27/2017
9.1.1 1,872 11/21/2017
9.1.0 1,786 11/21/2017
9.0.1 1,765 11/11/2017
9.0.0 1,771 11/10/2017
8.7.0 1,801 11/9/2017
8.6.0 1,753 11/9/2017
8.5.0 1,785 10/3/2017
8.4.0 1,834 10/3/2017
8.3.1 2,203 9/8/2017
8.3.0 1,832 9/8/2017
8.2.0 1,813 9/4/2017
8.1.0 1,878 8/22/2017
8.0.0 1,971 8/19/2017
7.1.3 1,804 8/14/2017
7.1.2 1,812 8/2/2017
7.1.1 1,751 7/26/2017
7.1.0 1,810 7/5/2017
7.0.9 1,770 6/28/2017
7.0.8 1,890 6/19/2017
7.0.6 1,842 4/7/2017
7.0.5 1,772 3/21/2017
7.0.4 1,805 3/21/2017
7.0.3 1,793 3/20/2017
7.0.2 1,793 3/13/2017
7.0.0 1,865 3/1/2017
6.2.0 1,871 2/25/2017
6.1.0 1,886 2/14/2017
6.0.0 1,923 2/9/2017
5.3.0 1,830 2/5/2017
5.2.0 1,764 1/26/2017
5.1.0 1,800 1/19/2017
5.0.0 1,810 1/7/2017
4.11.0 1,871 1/5/2017
4.10.0 1,867 12/31/2016
4.9.0 1,789 12/26/2016
4.8.0 3,525 12/17/2016
4.7.0 1,898 12/8/2016
4.6.5 1,825 12/4/2016
4.6.4 1,812 11/25/2016
4.6.2 3,516 11/18/2016
4.6.1 1,878 11/15/2016
4.6.0 1,827 11/11/2016
4.5.9 3,741 11/2/2016
4.5.8 1,961 11/2/2016
4.5.7 3,641 10/26/2016
4.5.6 1,863 10/6/2016
4.5.5 1,855 10/3/2016
4.5.4 1,806 10/2/2016
4.5.3 1,838 9/30/2016
4.5.2 3,607 9/28/2016
4.5.1 3,531 9/28/2016
4.5.0 3,476 9/28/2016
4.4.0 3,654 9/23/2016
4.3.0 1,950 9/22/2016
4.2.0 2,100 9/19/2016
4.1.1 1,870 9/13/2016
4.1.0 1,852 9/13/2016