WebBaseEvent Class

.NET Framework (current version)

Other Versions

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

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

Inheritance Hierarchy

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

Syntax

C++

type WebBaseEvent = class end

Constructors

	Name	Description
	WebBaseEvent(String, Object, Int32)	Initializes a new instance of the WebBaseEvent class using the supplied parameters.
	WebBaseEvent(String, Object, Int32, Int32)	Initializes a new instance of the WebBaseEvent class using the supplied parameters.

Properties

	Name	Description
	ApplicationInformation	Gets a WebApplicationInformation object that contains information about the current application being monitored.
	EventCode	Gets the code value associated with the event.
	EventDetailCode	Gets the event detail code.
	EventID	Gets the identifier associated with the event.
	EventOccurrence	Gets a counter that represents the number of times the event has occurred.
	EventSequence	Gets the number of times the event has been raised by the application.
	EventSource	Gets the object that raises the event.
	EventTime	Gets the time when the event was raised.
	EventTimeUtc	Gets the time when the event was raised.
	Message	Gets the message that describes the event.

Methods

	Name	Description
	Equals(Object)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	Finalize()	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)
	FormatCustomEventDetails(WebEventFormatter)	Provides standard formatting of the event information.
	GetHashCode()	Serves as the default hash function. (Inherited from Object.)
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	IncrementPerfCounters()	This API supports the product infrastructure and is not intended to be used directly from your code. Used internally to increment performance counters.
	MemberwiseClone()	Creates a shallow copy of the current Object.(Inherited from Object.)
	Raise()	Raises an event by notifying any configured provider that the event has occurred.
	Raise(WebBaseEvent)	Raises the specified event by notifying any configured provider that the event has occurred.
	ToString()	Formats event information for display purposes.(Overrides Object.ToString().)
	ToString(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.

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

Note

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.

Examples

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>

Version Information

.NET Framework
Available since 2.0

Thread Safety

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