WebBaseErrorEvent Class

.NET Framework 2.0
Serves as the base class for all the health-monitoring error events.

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

C#
C++
VB
Copy 
'Declaration
Public Class WebBaseErrorEvent
	Inherits WebManagementEvent
'Usage
Dim instance As WebBaseErrorEvent
J#
Copy 
public class WebBaseErrorEvent extends WebManagementEvent
JScript
Copy 
public class WebBaseErrorEvent extends WebManagementEvent
XAML
Copy 
Not applicable.

ASP.NET health monitoring allows production and operations staff to manage deployed Web applications. The System.Web.Management namespace contains the health-event types responsible for packaging application health-status data and the provider types responsible for processing this data. It also contains supporting types that help during the management of health events.

The WebBaseErrorEvent class is the base class for the health-monitoring events that represent error conditions. ASP.NET uses WebBaseErrorEvent and its derived types to indicate error conditions during the lifetime of a Web application.

NoteNote:

In most cases you will be able to use the ASP.NET health-monitoring types as implemented and you will control the health-monitoring system by specifying values in the healthMonitoring configuration section. You can also derive from the health-monitoring types to create your own custom events and providers. For an example of deriving from the WebBaseErrorEvent class, see the example provided in this topic.

The following code example has two parts. The first is an excerpt of a configuration file that enables ASP.NET health monitoring to use an event derived from the WebBaseErrorEvent class. The second shows how to derive from the WebBaseErrorEvent class to create the custom event.

Copy 
<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="SampleWebBaseErrorEvent"    
      type="SamplesAspNet.SampleWebBaseErrorEvent,
      webbaseerrorevent,Version=1.0.1573.21549, Culture=neutral,   
      PublicKeyToken=2a0b23915ac7352b, processorArchitecture=MSIL"/>
  </eventMappings>
  
  <rules>
    <!-- Associate custom event with related 
      custom provider -->
    <add 
       name="Custom Web Base Errors"
       eventName="SampleWebBaseErrorEvent" 
       provider="SampleWebEventProvider" 
       profile="Custom"/>  
  </rules>

</healthMonitoring>

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

C#
VB
Copy 
Imports System
Imports System.Text
Imports System.Web
Imports System.Web.Management


' Implements a custom WebErrorEvent class. 

Public Class SampleWebErrorEvent
   Inherits WebErrorEvent
   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 SampleWebErrorEvent.
   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( _
        "** SampleWebErrorEvent Start **")

        formatter.AppendLine(eventInfo.ToString())

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

        formatter.IndentationLevel -= 1
    End Sub 'FormatCustomEventDetails 

End Class 'SampleWebErrorEvent

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 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0
Show: