Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
WebBaseEvent Class

WebBaseEvent Class

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

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

type WebBaseEvent =  class end

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 a hash function for a particular type. (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 methodRaise()Raises 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 methodToString()Formats 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.

No code example is currently available or this language may not be supported.

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, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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.

Community Additions

ADD
Show:
© 2015 Microsoft