Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

WebBaseEvent Class

Defines the base class for the ASP.NET health-monitoring events.

Namespace:  System.Web.Management
Assembly:  System.Web (in System.Web.dll)
'Declaration
Public Class WebBaseEvent

The WebBaseEvent type exposes the following members.

  NameDescription
Protected methodWebBaseEvent(String, Object, Int32)Initializes a new instance of the WebBaseEvent class using the supplied parameters.
Protected methodWebBaseEvent(String, Object, Int32, Int32)Initializes a new instance of the WebBaseEvent class using the supplied parameters.
Top
  NameDescription
Public propertyStatic memberApplicationInformationGets a WebApplicationInformation object that contains information about the current application being monitored.
Public propertyEventCodeGets the code value associated with the event.
Public propertyEventDetailCodeGets the event detail code.
Public propertyEventIDGets the identifier associated with the event.
Public propertyEventOccurrenceGets a counter that represents the number of times the event has occurred.
Public propertyEventSequenceGets the number of times the event has been raised by the application.
Public propertyEventSourceGets the object that raises the event.
Public propertyEventTimeGets the time when the event was raised.
Public propertyEventTimeUtcGets the time when the event was raised.
Public propertyMessageGets the message that describes the event.
Top
  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodFormatCustomEventDetailsProvides standard formatting of the event information.
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodIncrementPerfCountersInfrastructure. Used internally to increment performance counters.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodRaiseRaises an event by notifying any configured provider that the event has occurred.
Public methodStatic memberRaise(WebBaseEvent)Raises the specified event by notifying any configured provider that the event has occurred.
Public methodToStringFormats event information for display purposes. (Overrides Object.ToString.)
Public methodToString(Boolean, Boolean)Formats event information for display purposes.
Top

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.

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


    ' 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

Supported in: 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.