This topic has not yet been rated - Rate this topic

WebRequestEvent Class

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

System.Object
  System.Web.Management.WebBaseEvent
    System.Web.Management.WebManagementEvent
      System.Web.Management.WebRequestEvent

Namespace:  System.Web.Management
Assembly:  System.Web (in System.Web.dll)
public class WebRequestEvent : WebManagementEvent

The WebRequestEvent type exposes the following members.

  Name Description
Protected method WebRequestEvent(String, Object, Int32) Infrastructure. Initializes the WebRequestEvent class with specified event parameters.
Protected method WebRequestEvent(String, Object, Int32, Int32) Infrastructure. Initializes the WebRequestEvent class with specified event parameters.
Top
  Name Description
Public property EventCode Gets the code value associated with the event. (Inherited from WebBaseEvent.)
Public property EventDetailCode Gets the event detail code. (Inherited from WebBaseEvent.)
Public property EventID Gets the identifier associated with the event. (Inherited from WebBaseEvent.)
Public property EventOccurrence Gets a counter that represents the number of times the event has occurred. (Inherited from WebBaseEvent.)
Public property EventSequence Gets the number of times the event has been raised by the application. (Inherited from WebBaseEvent.)
Public property EventSource Gets the object that raises the event. (Inherited from WebBaseEvent.)
Public property EventTime Gets the time when the event was raised. (Inherited from WebBaseEvent.)
Public property EventTimeUtc Gets the time when the event was raised. (Inherited from WebBaseEvent.)
Public property Message Gets the message that describes the event. (Inherited from WebBaseEvent.)
Public property ProcessInformation Gets information about the ASP.NET application-hosting process. (Inherited from WebManagementEvent.)
Public property RequestInformation Gets the information associated with the Web-application request.
Top
  Name Description
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method FormatCustomEventDetails Provides standard formatting of the event information. (Inherited from WebBaseEvent.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method IncrementPerfCounters Infrastructure. Used internally to increment the performance counters. (Overrides WebBaseEvent.IncrementPerfCounters().)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method Raise() Raises an event by notifying any configured provider that the event has occurred. (Inherited from WebBaseEvent.)
Public method ToString() Formats event information for display purposes. (Inherited from WebBaseEvent.)
Public method ToString(Boolean, Boolean) Formats event information for display purposes. (Inherited from WebBaseEvent.)
Top

The WebRequestEvent is raised at every Web request.

It uses the WebRequestInformation class to obtain request information.

Note 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.

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;

        }

    }
}


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>

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ