WebRequestEvent Class

.NET Framework (current version)

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

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

Inheritance Hierarchy

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

Syntax

C++

type WebRequestEvent = 
    class
        inherit WebManagementEvent
    end

Constructors

	Name	Description
	WebRequestEvent(String, Object, Int32)	This API supports the product infrastructure and is not intended to be used directly from your code. Initializes the WebRequestEvent class with specified event parameters.
	WebRequestEvent(String, Object, Int32, Int32)	This API supports the product infrastructure and is not intended to be used directly from your code. Initializes the WebRequestEvent class with specified event parameters.

Properties

	Name	Description
	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	Gets the information associated with the Web-application request.

Methods

	Name	Description
	Equals(Object)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	Finalize()	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(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()	This API supports the product infrastructure and is not intended to be used directly from your code. Used internally to increment the performance counters.(Overrides WebBaseEvent.IncrementPerfCounters().)
	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.)

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.

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.

Examples

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

No code example is currently available or this language may not be supported.

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>

Version Information

.NET Framework
Available since 2.0

Thread Safety

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