WebAuditEvent Class

Definition

Namespace:

System.Web.Management

Assembly:

System.Web.dll

Serves as the base class for all ASP.NET health-monitoring audit events.

public ref class WebAuditEvent : System::Web::Management::WebManagementEvent

public class WebAuditEvent : System.Web.Management.WebManagementEvent

type WebAuditEvent = class
    inherit WebManagementEvent

Public Class WebAuditEvent
Inherits WebManagementEvent

Inheritance

Object

WebBaseEvent

WebManagementEvent

WebAuditEvent

Derived

System.Web.Management.WebFailureAuditEvent

System.Web.Management.WebSuccessAuditEvent

Examples

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

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

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

        // Invoked in case of events identified only by their event code.
        public SampleWebAuditEvent(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 SampleWebAuditEvent(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 SampleWebAuditEvent.
        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()
        {
            // Obtain the Web request information.
            // No customization is allowed here.
            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(
                "******** SampleWebAuditEvent Information 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(
                "******** SampleWebAuditEvent Information End ********");

            formatter.IndentationLevel -= 1;
        }
    }
}

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


' Implements a custom WebAuditEvent class. 

Public Class SampleWebAuditEvent
    Inherits System.Web.Management.WebAuditEvent
    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
    
    
    ' 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
    
    ' Raises the SampleWebAuditEvent.
    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
    
    
    ' Obtains the current thread information.
    Public Function GetRequestInformation() As WebRequestInformation 
        ' Obtain the Web request information.
        ' No customization is allowed here.
        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("******** SampleWebAuditEvent Information 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("******** SampleWebAuditEvent Information End ********")
        
        formatter.IndentationLevel -= 1
    
    End Sub
End Class

The following is an excerpt of the configuration file that enables ASP.NET to use the 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="SampleWebAuditEvent"   
      type="SamplesAspNet.SampleWebAuditEvent,  
      webauditevent,Version=1.0.1663.31140,   
      Culture=neutral,   
      PublicKeyToken=0d1fa0f69d94de96,   
      processorArchitecture=MSIL"/>  
  </eventMappings>  

  <rules>  
    <add name="Custom Audit Default"  
      eventName="SampleWebAuditEvent"  
      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 WebAuditEvent class is the base class from which the ASP.NET health-monitoring audit-event classes derive. The audit events generate information about security-related operations in a Web application and provide both a success and failure event for each audited operation.

The health-monitoring system can audit both successful and unsuccessful events, which means an application can be monitored for both normal and malfunctioning conditions. By default, only the failure audit events are recorded.

The following operations are audited by ASP.NET, and may generate success-or-failure health-monitoring audit events:

• Login attempts made by users of an ASP.NET application. For more details about this auditing, see WebAuthenticationSuccessAuditEvent and WebSuccessAuditEvent.

• Security-related events, such as authentication failures, failed resource access attempts, and other security-related events. The log of these events can be useful when investigating an intrusion or attack on the application. By default, no auditing support is provided for authorization failures of anonymous users. For more details about failure event audits, see WebAuthenticationFailureAuditEvent and WebFailureAuditEvent.

• Custom events raised by an ASP.NET application. You can audit custom events by extending the functionality provided by the WebAuditEvent class and derived classes

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 WebAuditEvent class, see the example provided in this topic.

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

WebAuditEvent(String, Object, Int32, Int32)	Initializes a new instance of the WebAuditEvent class with specified event parameters.
WebAuditEvent(String, Object, Int32)	Initializes a new instance of the WebAuditEvent class using the supplied parameters.

Properties

EventCode	Gets the code value associated with the event. (Inherited from WebBaseEvent)
EventDetailCode	Gets the event detail code. (Inherited from WebBaseEvent)
EventID	Gets the identifier associated with the event. (Inherited from WebBaseEvent)
EventOccurrence	Gets a counter that represents the number of times the event has occurred. (Inherited from WebBaseEvent)
EventSequence	Gets the number of times the event has been raised by the application. (Inherited from WebBaseEvent)
EventSource	Gets the object that raises the event. (Inherited from WebBaseEvent)
EventTime	Gets the time when the event was raised. (Inherited from WebBaseEvent)
EventTimeUtc	Gets the time when the event was raised. (Inherited from WebBaseEvent)
Message	Gets the message that describes the event. (Inherited from WebBaseEvent)
ProcessInformation	Gets information about the ASP.NET application-hosting process. (Inherited from WebManagementEvent)
RequestInformation	Get the information associated with the Web request.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
FormatCustomEventDetails(WebEventFormatter)	Provides standard formatting of the event information. (Inherited from WebBaseEvent)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
IncrementPerfCounters()	Used internally to increment performance counters. (Inherited from WebBaseEvent)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
Raise()	Raises an event by notifying any configured provider that the event has occurred. (Inherited from WebBaseEvent)
ToString()	Formats event information for display purposes. (Inherited from WebBaseEvent)
ToString(Boolean, Boolean)	Formats event information for display purposes. (Inherited from WebBaseEvent)

See also

• WebManagementEvent
• WebFailureAuditEvent
• WebAuthenticationFailureAuditEvent
• WebSuccessAuditEvent
• WebAuthenticationSuccessAuditEvent
• WebViewStateFailureAuditEvent
• WebEventCodes
• ASP.NET Health Monitoring Overview