ServiceDebugBehavior Class


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Enables debugging and help information features for a Windows Communication Foundation (WCF) service.

Namespace:   System.ServiceModel.Description
Assembly:  System.ServiceModel (in System.ServiceModel.dll)


public class ServiceDebugBehavior : IServiceBehavior


Initializes a new instance of the ServiceDebugBehavior class.


Gets or sets high-level access to the definition of a binding.


Gets or sets a value that controls whether Windows Communication Foundation (WCF) publishes an HTML help page at the address controlled by the HttpHelpPageUrl property.


Gets or sets the location at which the HTML help file is published.


Gets or sets high-level access to the definition of a binding.


Gets or sets a value that specifies whether Windows Communication Foundation (WCF) returns an HTML help file over HTTPS at the address controlled by the HttpsHelpPageUrl property.


Gets or sets the location at which an HTML file is published for retrieval using HTTPS.


Gets or sets a value that specifies whether to include managed exception information in the detail of SOAP faults returned to the client for debugging purposes.


Determines whether the specified object is equal to the current object.(Inherited from Object.)


Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)


Serves as the default hash function. (Inherited from Object.)


Gets the Type of the current instance.(Inherited from Object.)


Creates a shallow copy of the current Object.(Inherited from Object.)


Returns a string that represents the current object.(Inherited from Object.)

Use the ServiceDebugBehavior properties from a configuration file or programmatically to enable the flow of managed exception information to the client for debugging purposes as well as the publication of HTML information files for users browsing the service in Web browsers.

Set the IncludeExceptionDetailInFaults property to true to instruct WCF to return managed exception information in SOAP faults to clients for debugging purposes.


Returning managed exception information to clients can be a security risk because exception details expose information about the internal service implementation that could be used by unauthorized clients. In addition, although the ServiceDebugBehavior properties can also be set programmatically, it can be easy to forget to disable IncludeExceptionDetailInFaults when deploying.

Because of the security issues involved, it is strongly recommended that:

  • You use an application configuration file to set the value of the IncludeExceptionDetailInFaults property to true.

  • You only do so only in controlled debugging scenarios.

For more information about the security issues related to managed exception information, see Specifying and Handling Faults in Contracts and Services.

The HttpHelpPageEnabled and HttpsHelpPageEnabled properties instruct the service to publish HTML help files when the service is viewed using an HTML browser.

The HttpHelpPageUrl and HttpsHelpPageUrl properties control the location of the HTML help page that is viewed.

To enable or disable one of the ServiceDebugBehavior features using a configuration file:

  1. Add a behaviorConfiguration attribute to the <service> element for your WCF service. Endpoint behaviors are configured on <endpoint> elements; service behaviors on <service> elements.

  2. Add to or create a <serviceBehaviors> section and add a <behavior> of <endpointBehaviors> element to that with the name that matches the behaviorConfiguration attribute value from step 1. Endpoint behaviors are configured using an <endpointBehaviors> element; service behaviors are configured using a <serviceBehaviors> element.

  3. Add a <serviceDebug> element to the <behavior> of <endpointBehaviors> element from step 2 and enable or disable the various properties appropriate to your scenario.

For a specific example, see the Example section.

The following code example shows how to use a configuration file to enable the HTML help page feature and return exception information inside a SOAP fault back to the client for debugging purposes, in addition to enabling metadata support. This configuration file shows the following basic steps to adding support for the ServiceDebugBehavior features:

.NET Framework
Available since 3.0

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top