WebFailureAuditEvent WebFailureAuditEvent WebFailureAuditEvent WebFailureAuditEvent Class

Definition

Provides information about security failures.

public ref class WebFailureAuditEvent : System::Web::Management::WebAuditEvent
public class WebFailureAuditEvent : System.Web.Management.WebAuditEvent
type WebFailureAuditEvent = class
    inherit WebAuditEvent
Public Class WebFailureAuditEvent
Inherits WebAuditEvent
Inheritance
Derived

Examples

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;

        }
    }

}
Imports System.Text
Imports System.Web
Imports System.Web.Management


' Implements a custom WebFailureAuditEvent class. 

Public Class SampleWebFailureAuditEvent
    Inherits System.Web.Management.WebFailureAuditEvent
    Private customCreatedMsg, customRaisedMsg As String
    
    
    
    ' Invoked in case of events identified only by their event code.
    Public Sub New(ByVal msg As String, _
    ByVal eventSource As Object, ByVal eventCode As Integer)
        MyBase.New(msg, eventSource, eventCode)
        ' Perform custom initialization.
        customCreatedMsg = String.Format("Event created at: {0}", _
        DateTime.Now.TimeOfDay.ToString())

    End Sub 'New
    
    
    ' Invoked in case of events identified by their event code and 
    ' event detailed code.
    Public Sub New(ByVal msg As String, ByVal eventSource As Object, _
    ByVal eventCode As Integer, ByVal detailedCode As Integer)
        MyBase.New(msg, eventSource, eventCode, detailedCode)
        ' Perform custom initialization.
        customCreatedMsg = String.Format("Event created at: {0}", _
        DateTime.Now.TimeOfDay.ToString())

    End Sub 'New
    
    
    
    ' Raises the SampleWebFailureAuditEvent.
    Public Overrides Sub Raise() 
        ' Perform custom processing.
        customRaisedMsg = String.Format("Event raised at: {0}", _
        DateTime.Now.TimeOfDay.ToString())
        
        ' Raise the event.
        WebBaseEvent.Raise(Me)
    
    End Sub 'Raise
    
    
    ' Obtains the current thread information.
    Public Function GetRequestInformation() As WebRequestInformation 
        ' No customization is allowed.
        Return RequestInformation
    
    End Function 'GetRequestInformation
    
    
    'Formats Web request event information.
    'This method is invoked indirectly by the provider 
    'using one of the overloaded ToString methods.
    Public Overrides Sub FormatCustomEventDetails(ByVal formatter _
    As WebEventFormatter)
        MyBase.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

    End Sub 'FormatCustomEventDetails 

End Class 'SampleWebFailureAuditEvent

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>  

Remarks

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.

Note

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.

Note

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(WebEventFormatter) method rather than the ToString method. This will avoid overwriting or tampering with sensitive system information.

Constructors

WebFailureAuditEvent(String, Object, Int32) WebFailureAuditEvent(String, Object, Int32) WebFailureAuditEvent(String, Object, Int32) WebFailureAuditEvent(String, Object, Int32)

Initializes a new instance of the WebFailureAuditEvent class using the supplied parameters.

WebFailureAuditEvent(String, Object, Int32, Int32) WebFailureAuditEvent(String, Object, Int32, Int32) WebFailureAuditEvent(String, Object, Int32, Int32) WebFailureAuditEvent(String, Object, Int32, Int32)

Initializes a new instance of the WebFailureAuditEvent class using the supplied parameters.

Methods

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
FormatCustomEventDetails(WebEventFormatter) FormatCustomEventDetails(WebEventFormatter) FormatCustomEventDetails(WebEventFormatter) FormatCustomEventDetails(WebEventFormatter)

Provides standard formatting of the event information.

(Inherited from WebBaseEvent)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

Gets the Type of the current instance.

(Inherited from Object)
IncrementPerfCounters() IncrementPerfCounters() IncrementPerfCounters() IncrementPerfCounters()

Increments the Audit Failure Events Raised performance counter.

MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
Raise() Raise() Raise() Raise()

Raises an event by notifying any configured provider that the event has occurred.

(Inherited from WebBaseEvent)
ToString() ToString() ToString() ToString()

Formats event information for display purposes.

(Inherited from WebBaseEvent)
ToString(Boolean, Boolean) ToString(Boolean, Boolean) ToString(Boolean, Boolean) ToString(Boolean, Boolean)

Formats event information for display purposes.

(Inherited from WebBaseEvent)

Properties

EventCode EventCode EventCode EventCode

Gets the code value associated with the event.

(Inherited from WebBaseEvent)
EventDetailCode EventDetailCode EventDetailCode EventDetailCode

Gets the event detail code.

(Inherited from WebBaseEvent)
EventID EventID EventID EventID

Gets the identifier associated with the event.

(Inherited from WebBaseEvent)
EventOccurrence EventOccurrence EventOccurrence EventOccurrence

Gets a counter that represents the number of times the event has occurred.

(Inherited from WebBaseEvent)
EventSequence EventSequence EventSequence EventSequence

Gets the number of times the event has been raised by the application.

(Inherited from WebBaseEvent)
EventSource EventSource EventSource EventSource

Gets the object that raises the event.

(Inherited from WebBaseEvent)
EventTime EventTime EventTime EventTime

Gets the time when the event was raised.

(Inherited from WebBaseEvent)
EventTimeUtc EventTimeUtc EventTimeUtc EventTimeUtc

Gets the time when the event was raised.

(Inherited from WebBaseEvent)
Message Message Message Message

Gets the message that describes the event.

(Inherited from WebBaseEvent)
ProcessInformation ProcessInformation ProcessInformation ProcessInformation

Gets information about the ASP.NET application-hosting process.

(Inherited from WebManagementEvent)
RequestInformation RequestInformation RequestInformation RequestInformation

Get the information associated with the Web request.

(Inherited from WebAuditEvent)

Applies to

See also