WebRequestErrorEvent Class

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Defines the event that carries information about Web-request errors.

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

System.Object
  System.Web.Management.WebBaseEvent
    System.Web.Management.WebManagementEvent
      System.Web.Management.WebBaseErrorEvent
        System.Web.Management.WebRequestErrorEvent
          System.Web.Management.WebServiceErrorEvent

Public Class WebRequestErrorEvent
	Inherits WebBaseErrorEvent

NameDescription
System_CAPS_protmethodWebRequestErrorEvent(String, Object, Int32, Exception)

This API supports the product infrastructure and is not intended to be used directly from your code. Initializes the WebRequestErrorEvent class with specified event parameters.

System_CAPS_protmethodWebRequestErrorEvent(String, Object, Int32, Int32, Exception)

This API supports the product infrastructure and is not intended to be used directly from your code. Initializes the WebRequestErrorEvent class with specified event parameters.

NameDescription
System_CAPS_pubpropertyErrorException

Gets the Exception associated with the error. (Inherited from WebBaseErrorEvent.)

System_CAPS_pubpropertyEventCode

Gets the code value associated with the event.(Inherited from WebBaseEvent.)

System_CAPS_pubpropertyEventDetailCode

Gets the event detail code.(Inherited from WebBaseEvent.)

System_CAPS_pubpropertyEventID

Gets the identifier associated with the event.(Inherited from WebBaseEvent.)

System_CAPS_pubpropertyEventOccurrence

Gets a counter that represents the number of times the event has occurred.(Inherited from WebBaseEvent.)

System_CAPS_pubpropertyEventSequence

Gets the number of times the event has been raised by the application.(Inherited from WebBaseEvent.)

System_CAPS_pubpropertyEventSource

Gets the object that raises the event.(Inherited from WebBaseEvent.)

System_CAPS_pubpropertyEventTime

Gets the time when the event was raised.(Inherited from WebBaseEvent.)

System_CAPS_pubpropertyEventTimeUtc

Gets the time when the event was raised.(Inherited from WebBaseEvent.)

System_CAPS_pubpropertyMessage

Gets the message that describes the event.(Inherited from WebBaseEvent.)

System_CAPS_pubpropertyProcessInformation

Gets information about the ASP.NET application-hosting process.(Inherited from WebManagementEvent.)

System_CAPS_pubpropertyRequestInformation

Gets the application request information.

System_CAPS_pubpropertyThreadInformation

Gets the application thread information.

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodFormatCustomEventDetails(WebEventFormatter)

Provides standard formatting of the event information.(Inherited from WebBaseEvent.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodIncrementPerfCounters()

This API supports the product infrastructure and is not intended to be used directly from your code. Used internally to increment the relevant performance counters.(Overrides WebBaseErrorEvent.IncrementPerfCounters().)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodRaise()

Raises an event by notifying any configured provider that the event has occurred.(Inherited from WebBaseEvent.)

System_CAPS_pubmethodToString()

Formats event information for display purposes.(Inherited from WebBaseEvent.)

System_CAPS_pubmethodToString(Boolean, Boolean)

Formats event information for display purposes.(Inherited from WebBaseEvent.)

The WebRequestErrorEvent is raised if an error occurs during a Web request. Your application should use this event to obtain request-related information as defined by the WebRequestInformation and the WebThreadInformation classes.

System_CAPS_noteNote

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 has two parts. The first part is an excerpt of a configuration file that enables ASP.NET to use a custom event. The second part shows how to derive from the WebRequestErrorEvent class to create the custom event.

<healthMonitoring enabled="true" heartBeatInterval="0">
  <eventMappings>
    <add  name="SampleWebRequestErrorEvent" type="SamplesAspNet.SampleWebRequestErrorEvent,webrequesterrorevent,Version=1.0.1573.21654, Culture=neutral, PublicKeyToken=63ada862a6c5af13, processorArchitecture=MSIL"/>
  </eventMappings>

  <rules>
    <add 
      name="Custom Web Request Error Events"
      eventName="SampleWebRequestErrorEvent" 
      provider="EventLogProvider"  
      profile="Critical"/>
  </rules>
</healthMonitoring>
Imports System
Imports System.Text
Imports System.Web
Imports System.Web.Management


' Implements a custom WebRequestErrorEvent class. 
Public Class SampleWebRequestErrorEvent
   Inherits WebRequestErrorEvent
   Private eventInfo As StringBuilder


   ' 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, _
    ByVal e As Exception)
        MyBase.New(msg, eventSource, _
        eventCode, e)
        ' Perform custom initialization.
        eventInfo = New StringBuilder()
        eventInfo.Append(String.Format( _
        "Event created at: ", _
        EventTime.ToString()))
    End Sub 'NewNew


   ' 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 detailedCode As Integer, _
    ByVal e As Exception)
        MyBase.New(msg, eventSource, _
        eventCode, detailedCode, e)
        ' Perform custom initialization.
        eventInfo = New StringBuilder()
        eventInfo.Append(String.Format( _
        "Event created at: ", _
        EventTime.ToString()))
    End Sub 'NewNew


   ' Raises the SampleWebRequestErrorEvent.
   Public Overrides Sub Raise()
      ' Perform custom processing. 
        eventInfo.Append(String.Format( _
        "Event raised at: ", _
        EventTime.ToString()))
      ' Raise the event.
      MyBase.Raise()
   End Sub 'Raise

   ' Obtains the current request information.
   Public Function GetRequestInfo() As String
      Dim reqInfo As String = GetRequestInfo()
      Return reqInfo
   End Function 'GetRequestInfo


   ' Obtains the current thread information.
   Public Function GetThreadInfo() As String
      Dim threadInfo As String = GetThreadInfo()
      Return threadInfo
   End Function 'GetThreadInfo


   ' Obtains the current process information.
   Public Function GetProcessInfo() As String
      Dim procInfo As String = GetProcessInfo()
      Return procInfo
   End Function 'GetProcessInfo


   'Formats Web request event information.
    Public Overrides Sub FormatCustomEventDetails( _
    ByVal formatter As WebEventFormatter)
        MyBase.FormatCustomEventDetails(formatter)

        ' Add custom data.
        formatter.AppendLine("")

        formatter.IndentationLevel += 1
        formatter.AppendLine( _
        "** SampleWebRequestEvent Start **")

        ' Add custom data.
        formatter.AppendLine(eventInfo.ToString())

        formatter.AppendLine( _
        "** SampleWebRequestEvent End **")

    End Sub 'FormatCustomEventDetails

End Class 'SampleWebRequestErrorEvent 


.NET Framework
Available since 2.0

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

Return to top
Show: