WebBaseEvent 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 base class for the ASP.NET health-monitoring events.

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

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

Public Class WebBaseEvent

NameDescription
System_CAPS_protmethodWebBaseEvent(String, Object, Int32)

Initializes a new instance of the WebBaseEvent class using the supplied parameters.

System_CAPS_protmethodWebBaseEvent(String, Object, Int32, Int32)

Initializes a new instance of the WebBaseEvent class using the supplied parameters.

NameDescription
System_CAPS_pubpropertySystem_CAPS_staticApplicationInformation

Gets a WebApplicationInformation object that contains information about the current application being monitored.

System_CAPS_pubpropertyEventCode

Gets the code value associated with the event.

System_CAPS_pubpropertyEventDetailCode

Gets the event detail code.

System_CAPS_pubpropertyEventID

Gets the identifier associated with the event.

System_CAPS_pubpropertyEventOccurrence

Gets a counter that represents the number of times the event has occurred.

System_CAPS_pubpropertyEventSequence

Gets the number of times the event has been raised by the application.

System_CAPS_pubpropertyEventSource

Gets the object that raises the event.

System_CAPS_pubpropertyEventTime

Gets the time when the event was raised.

System_CAPS_pubpropertyEventTimeUtc

Gets the time when the event was raised.

System_CAPS_pubpropertyMessage

Gets the message that describes the event.

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.

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 performance counters.

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.

System_CAPS_pubmethodSystem_CAPS_staticRaise(WebBaseEvent)

Raises the specified event by notifying any configured provider that the event has occurred.

System_CAPS_pubmethodToString()

Formats event information for display purposes.(Overrides Object.ToString().)

System_CAPS_pubmethodToString(Boolean, Boolean)

Formats event information for display purposes.

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 WebBaseEvent class is the root of the inheritance tree for all the ASP.NET health-monitoring event types. It uses the WebApplicationInformation class to obtain application information that is available to its derived class.

System_CAPS_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 WebBaseEvent class, see the example provided in this topic.

Notes to Inheritors:

When you format your custom event information for display, override the FormatCustomEventDetails method rather than the ToString method. This will avoid overwriting or tampering with sensitive system information.

The event code you specify for your custom event must be greater than WebExtendedBase.

The following example shows how to derive from the WebBaseEvent class to create a custom health-monitoring event.

Imports System
Imports System.Text
Imports System.Web
Imports System.Web.Management


Public Class SampleWebBaseEvent
    Inherits System.Web.Management.WebBaseEvent
    Implements System.Web.Management.IWebEventCustomEvaluator


    Private customCreatedMsg, customRaisedMsg As String

    ' Store firing record info.
    Private Shared firingRecordInfo As String

    ' Implements the IWebEventCustomEvaluator.CanFire 
    ' method. It is called by the ASP.NET if this custom
    ' type is configured in the profile
    ' element of the healthMonitoring section.
    Public Function CanFire( _
    ByVal e As System.Web.Management.WebBaseEvent, _
    ByVal rule As RuleFiringRecord) As Boolean _
    Implements System.Web.Management.IWebEventCustomEvaluator.CanFire

        Dim fireEvent As Boolean
        Dim lastFired As String = _
            rule.LastFired.ToString()
        Dim timesRaised As String = _
            rule.TimesRaised.ToString()

        ' Fire every other event raised.
        fireEvent = _
        IIf(rule.TimesRaised Mod 2 = 0, True, False)

        If fireEvent Then
            firingRecordInfo = String.Format( _
            "Event last fired: {0}", lastFired) + _
            String.Format( _
            ". Times raised: {0}",  timesRaised) 

        Else
            firingRecordInfo = String.Format( _
            "Event not fired. Times raised: {0}", _
            timesRaised)
        End If

        Return fireEvent

    End Function 'CanFire


    ' 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)
        MyBase.New(msg, eventSource, eventCode)
        ' Perform custom initialization.
        customCreatedMsg = String.Format( _
        "Event created at: {0}", DateTime.Now.TimeOfDay.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 eventDetailCode As Integer)
        MyBase.New(msg, eventSource, _
        eventCode, eventDetailCode)
        ' Perform custom initialization.
        customCreatedMsg = String.Format( _
        "Event created at: {0}", DateTime.Now.TimeOfDay.ToString())

    End Sub 'NewNew


    ' Raises the SampleWebBaseEvent.
    Public Overrides Sub Raise()
        ' Perform custom processing. 
        customRaisedMsg = String.Format( _
        "Event raised at: {0}", DateTime.Now.TimeOfDay.ToString())

        ' Raise the event.
        MyBase.Raise()

    End Sub 'Raise

    ' Raises the SampleWebBaseEvent.
    Public Sub CustomRaise(ByVal evnt _
    As System.Web.Management.WebBaseEvent)

        ' Raise the event.
        Raise(evnt)

    End Sub 'CustomRaise


    ' Gets the event code.
    Public Function GetEventCode(ByVal detail _
    As Boolean) As Integer
        Dim eCode As Integer

        If Not detail Then
            ' Get the event code.
            eCode = EventCode
            ' Get the detail event code.
        Else
            eCode = EventDetailCode
        End If
        Return eCode

    End Function 'GetEventCode


    ' Gets the event sequence.
    Public Function GetEventSequence() As Long
        ' Get the event sequence.
        Dim eventSequence As Long = eventSequence
        Return eventSequence

    End Function 'GetEventSequence



    ' Gets the event source.
    Public Function GetEventSource() As [Object]
        ' Get the event source.
        Dim [source] As [Object] = Me.EventSource
        Return [source]

    End Function 'GetEventSource

    ' Gets the event time.
    Public Function GetEventTime() As DateTime
        ' Get the event source.
        Dim eTime As DateTime = EventTime
        Return eTime

    End Function 'GetEventTime

    ' Gets the event time.
    Public Function GetEventTimeUtc() As DateTime
        ' Get the event source.
        Dim eTime As DateTime = EventTimeUtc
        Return eTime

    End Function 'GetEventTimeUtc

    ' Gets the event sequence.
    Public Function GetEventMessage() As String
        ' Get the event message.
        Dim eventMsg As String = Message
        Return eventMsg

    End Function 'GetEventMessage

    ' Gets the current application information.
    Public Function GetEventAppInfo() As WebApplicationInformation
        ' Get the event message.
        Dim appImfo As WebApplicationInformation = _
        ApplicationInformation
        Return appImfo

    End Function 'GetEventAppInfo

    ' Implements the ToString() method.
    Public Overrides Function ToString() As String
        Return MyBase.ToString()

    End Function 'ToString

    ' Implements the ToString(bool, bool) method.
    Public Function customToString(ByVal includeAppInfo As Boolean, _
    ByVal includeCustomInfo As Boolean) As String
        Return MyBase.ToString(includeAppInfo, includeCustomInfo)

    End Function 'customToString

    ' Gets the event identifier.
    Public Function GetEventId() As Guid
        Dim evId As Guid = EventID
        Return evId

    End Function 'GetEventId


    '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.TabSize = 4

        formatter.AppendLine("*SampleWebBaseEvent Start *")
        formatter.AppendLine("Custom information goes here")
        formatter.AppendLine("* SampleWebBaseEvent End *")
        ' Display custom event timing.
        formatter.AppendLine(customCreatedMsg)
        formatter.AppendLine(customRaisedMsg)
        formatter.IndentationLevel -= 1

    End Sub 'FormatCustomEventDetails

End Class 'SampleWebBaseEvent

The following example is an excerpt of the configuration file that enables ASP.NET to use the custom event.

<healthMonitoring enabled="true" heartBeatInterval="0">
  <eventMappings>
    <add  name="SampleWebBaseEvent" 
      type="SamplesAspNet.SampleWebBaseEvent, 
      webbaseevent, Version=1.0.1573.24438, Culture=neutral, 
      PublicKeyToken=2f5f337ae5c9bdaa, 
      processorArchitecture=MSIL" />
  </eventMappings>

  <rules>
    <add 
      name="CustomWebBaseEvent"
      eventName="SampleWebBaseEvent" 
      provider="EventLogProvider" 
      profile="Critical"/>    
  </rules>
</healthMonitoring>

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