Export (0) Print
Expand All

WebFailureAuditEvent Class

Provides information about security failures.

Namespace:  System.Web.Management
Assembly:  System.Web (in System.Web.dll)

public class WebFailureAuditEvent : WebAuditEvent

The WebFailureAuditEvent type exposes the following members.

  NameDescription
Protected methodWebFailureAuditEvent(String, Object, Int32)Infrastructure. Initializes a new instance of the WebFailureAuditEvent class using the supplied parameters.
Protected methodWebFailureAuditEvent(String, Object, Int32, Int32)Infrastructure. Initializes a new instance of the WebFailureAuditEvent class using the supplied parameters.
Top

  NameDescription
Public propertyEventCodeGets the code value associated with the event. (Inherited from WebBaseEvent.)
Public propertyEventDetailCodeGets the event detail code. (Inherited from WebBaseEvent.)
Public propertyEventIDGets the identifier associated with the event. (Inherited from WebBaseEvent.)
Public propertyEventOccurrenceGets a counter that represents the number of times the event has occurred. (Inherited from WebBaseEvent.)
Public propertyEventSequenceGets the number of times the event has been raised by the application. (Inherited from WebBaseEvent.)
Public propertyEventSourceGets the object that raises the event. (Inherited from WebBaseEvent.)
Public propertyEventTimeGets the time when the event was raised. (Inherited from WebBaseEvent.)
Public propertyEventTimeUtcGets the time when the event was raised. (Inherited from WebBaseEvent.)
Public propertyMessageGets the message that describes the event. (Inherited from WebBaseEvent.)
Public propertyProcessInformationGets information about the ASP.NET application-hosting process. (Inherited from WebManagementEvent.)
Public propertyRequestInformationGet the information associated with the Web request. (Inherited from WebAuditEvent.)
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodFormatCustomEventDetailsProvides standard formatting of the event information. (Inherited from WebBaseEvent.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodIncrementPerfCountersInfrastructure. Increments the Audit Failure Events Raised performance counter. (Overrides WebBaseEvent.IncrementPerfCounters().)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodRaise()Raises an event by notifying any configured provider that the event has occurred. (Inherited from WebBaseEvent.)
Public methodToString()Formats event information for display purposes. (Inherited from WebBaseEvent.)
Public methodToString(Boolean, Boolean)Formats event information for display purposes. (Inherited from WebBaseEvent.)
Top

ASP.NET health monitoring allows production and operations staff to manage deployed Web applications. The System.Web.Management namespace contains the health event types responsible for packaging application health-status data and the provider types responsible for processing this data. It also contains supporting types that help during the management of health events.

The WebFailureAuditEvent class is used when a security operation fails. An example of this is a failed URL authorization for a Web request.

By default, ASP.NET is configured to raise the WebFailureAuditEvent event for the following features:

When a WebFailureAuditEvent event is raised, ASP.NET health monitoring increments the related Audit Failure Events Raised performance counter and then checks the healthMonitoring configuration section to determine whether any providers subscribe to the event. If providers subscribe to the event, ASP.NET dispatches the event to them for processing.

NoteNote

To view the Audit Failure Events Raised performance counter in System Monitor (PerfMon), in the Add Counters window, select ASP.NET from the Performance object drop-down list, select the Audit Failure Events Raised performance counter, and click the Add button. For more information, see Using the System Monitor (PerfMon) with ASP.NET Applications in the IIS documentation on MSDN.

NoteNote

In most cases you will be able to use the ASP.NET health-monitoring types as implemented, and you will control the health-monitoring system by specifying values in the healthMonitoring configuration section. You can also derive from the health-monitoring types to create your own custom events and providers. For an example of deriving from the WebFailureAuditEvent class, see the Example section.

Notes to Inheritors

When formatting your custom event information for display, override the FormatCustomEventDetails method rather than the ToString method. This will avoid overwriting or tampering with sensitive system information.

The following code example demonstrates how to derive from the WebFailureAuditEvent class to create a custom audit event.


using System;
using System.Text;
using System.Web;
using System.Web.Management;

namespace SamplesAspNet
{
    // Implements a custom WebFailureAuditEvent class.  
    public class SampleWebFailureAuditEvent : 
        System.Web.Management.WebFailureAuditEvent
    {
        private string customCreatedMsg, customRaisedMsg;


        // Invoked in case of events identified only by their event code. 
        public SampleWebFailureAuditEvent(string msg, object eventSource,
            int eventCode):
        base(msg, eventSource, eventCode)
        {
            // Perform custom initialization.
            customCreatedMsg =
                string.Format("Event created at: {0}",
                DateTime.Now.TimeOfDay.ToString());
        }


        // Invoked in case of events identified by their event code and  
        // event detailed code. 
        public SampleWebFailureAuditEvent(string msg, object eventSource,
            int eventCode, int detailedCode):
        base(msg, eventSource, eventCode, detailedCode)
        {
            // Perform custom initialization.
            customCreatedMsg =
            string.Format("Event created at: {0}",
                DateTime.Now.TimeOfDay.ToString());
        }



        // Raises the SampleWebFailureAuditEvent. 
        public override void Raise()
        {
            // Perform custom processing.
            customRaisedMsg =
                string.Format("Event raised at: {0}", 
                DateTime.Now.TimeOfDay.ToString());

            // Raise the event.
            WebBaseEvent.Raise(this);
        }


        // Obtains the current thread information. 
        public WebRequestInformation GetRequestInformation()
        {
            // No customization is allowed. 
            return RequestInformation;
        }


        //Formats Web request event information. 
        //This method is invoked indirectly by the provider  
        //using one of the overloaded ToString methods. 
        public override void FormatCustomEventDetails(WebEventFormatter formatter)
        {
            base.FormatCustomEventDetails(formatter);

            // Add custom data.
            formatter.AppendLine("");

            formatter.IndentationLevel += 1;
            formatter.AppendLine(
                "******** SampleWebFailureAuditEvent Start ********");
            formatter.AppendLine(string.Format("Request path: {0}",
                RequestInformation.RequestPath));
            formatter.AppendLine(string.Format("Request Url: {0}",
                RequestInformation.RequestUrl));

            // Display custom event timing.
            formatter.AppendLine(customCreatedMsg);
            formatter.AppendLine(customRaisedMsg);

            formatter.AppendLine(
                "******** SampleWebFailureAuditEvent End ********");

            formatter.IndentationLevel -= 1;

        }
    }

}

The following configuration excerpt shows how to enable ASP.NET to use the WebFailureAuditEvent event.

<healthMonitoring 
enabled="true"
heartBeatInterval="0"> 
<providers>
<add name="EventLogProvider" 
type="System.Web.Management.EventLogWebEventProvider,
System.Web,Version=2.0.3600.0,Culture=neutral,
PublicKeyToken=b03f5f7f11d50a3a"/>
</providers>

<eventMappings>
<add  name="SampleWebFailureAuditEvent" 
type="SamplesAspNet.SampleWebFailureAuditEvent,
webfailureauditevent,Version=1.0.1663.31140, 
Culture=neutral, 
PublicKeyToken=0d1fa0f69d94de96, 
processorArchitecture=MSIL"/>
</eventMappings>

<rules>
<add name="Custom Failure Audit Default"
eventName=" SampleWebFailureAuditEvent "
provider="EventLogProvider"
profile="Default"/>  
</rules>

</healthMonitoring>

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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