WebRequestEvent WebRequestEvent WebRequestEvent WebRequestEvent Class

Definition

Defines the base class for events providing Web-request information.

public ref class WebRequestEvent : System::Web::Management::WebManagementEvent
public class WebRequestEvent : System.Web.Management.WebManagementEvent
type WebRequestEvent = class
    inherit WebManagementEvent
Public Class WebRequestEvent
Inherits WebManagementEvent
Inheritance

Examples

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


using System;
using System.Text;
using System.Web;
using System.Web.Management;
using System.Web.UI;
using System.Web.UI.WebControls;

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

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


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

        }


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

            // Raise the event.
            base.Raise();
        }


        //Formats Web request event information.
        public override void FormatCustomEventDetails(
            WebEventFormatter formatter)
        {
            // Add custom data.
            formatter.AppendLine("");

            formatter.IndentationLevel += 1;
            formatter.AppendLine(
                "* Custom Request Information Start *");

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

            formatter.AppendLine(
                "* Custom Request Information End *");

            formatter.IndentationLevel -= 1;

        }

    }
}
Imports System
Imports System.Text
Imports System.Web
Imports System.Web.Management
Imports System.Web.UI
Imports System.Web.UI.WebControls


' Implements a custom WebRequestEvent. 
Public Class SampleWebRequestEvent
    Inherits System.Web.Management.WebRequestEvent
    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}", _
        EventTime.ToString())

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

    End Sub 'New
    

    ' Raises the SampleWebRequestEvent.
    Public Overrides Sub Raise() 
        ' Perform custom processing.
        customRaisedMsg = String.Format( _
        "Event raised at: {0}", _
        EventTime.ToString())
        
        ' Raise the event.
        MyBase.Raise()
    
    End Sub 'Raise
    
    
    'Formats Web request event information.
    Public Overrides Sub FormatCustomEventDetails( _
    ByVal formatter As WebEventFormatter)
        ' Add custom data.
        formatter.AppendLine("")

        formatter.IndentationLevel += 1
        formatter.AppendLine( _
        "* Custom Request Information Start *")

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

        formatter.AppendLine( _
        "* Custom Request Information End *")

        formatter.IndentationLevel -= 1

    End Sub 'FormatCustomEventDetails 
End Class 'SampleWebRequestEvent

The following is an excerpt of the configuration file that enables ASP.NET to use the custom event.

<healthMonitoring   
  enabled="true" heartBeatInterval="0">  
  <providers>  
    <!-- Define the custom provider that   
         processes custom Web request events. -->  
    <add name="SampleWebEventProvider"   
type="SamplesAspNet.SampleEventProvider,webeventprovider,Version=1.0.1573.18094, Culture=neutral, PublicKeyToken=b5a57a9a9d487cf4, processorArchitecture=MSIL"/>  
  </providers>  

  <eventMappings>  
    <!--  Define the event source that   
         issues custom events.   -->  
    <add  name="SampleWebRequestEvent"   
type="SamplesAspNet.SampleWebRequestEvent,webrequestevent,Version=1.0.1573.23947, Culture=neutral, PublicKeyToken=e717d983a78c8ddb, processorArchitecture=MSIL"/>  
    </eventMappings>  

  <rules>  
        <!-- Associate custom event with   
        related custom provider -->  
    <add   
      name="CustomWebRequestEvent"  
      eventName="SampleWebRequestEvent"   
      provider="SampleWebEventProvider"   
      profile="Critical"/>  
  </rules>  
</healthMonitoring>  

Remarks

The WebRequestEvent is raised at every Web request.

It uses the WebRequestInformation class to obtain request information.

Note

In most cases you will use the standard ASP.NET health-monitoring types and control their behavior by setting the healthMonitoring configuration section. You can also create custom types, as shown in the next example. If you create your custom event type and you need to add your own information, customize the FormatCustomEventDetails method. This will avoid overwriting or tampering with sensitive system information.

Constructors

WebRequestEvent(String, Object, Int32) WebRequestEvent(String, Object, Int32) WebRequestEvent(String, Object, Int32) WebRequestEvent(String, Object, Int32)

Initializes the WebRequestEvent class with specified event parameters.

WebRequestEvent(String, Object, Int32, Int32) WebRequestEvent(String, Object, Int32, Int32) WebRequestEvent(String, Object, Int32, Int32) WebRequestEvent(String, Object, Int32, Int32)

Initializes the WebRequestEvent class with specified event parameters.

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

Gets the information associated with the Web-application request.

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()

Used internally to increment the performance counters.

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)

Applies to

See also