This documentation is archived and is not being maintained.

WebRequestErrorEvent Class

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

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

'Declaration
<AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level := AspNetHostingPermissionLevel.Minimal)> _
<AspNetHostingPermissionAttribute(SecurityAction.InheritanceDemand, Level := AspNetHostingPermissionLevel.Minimal)> _
Public Class WebRequestErrorEvent _
	Inherits WebBaseErrorEvent
'Usage
Dim instance As WebRequestErrorEvent

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.

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 '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 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 'New 


   ' 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 

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

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0
Show: