WebHeartbeatEvent Class

Reference

Definition

Namespace:: System.Web.Management

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Defines those health-monitoring events raised at a periodic interval.

public ref class WebHeartbeatEvent : System::Web::Management::WebManagementEvent

public class WebHeartbeatEvent : System.Web.Management.WebManagementEvent

type WebHeartbeatEvent = class
    inherit WebManagementEvent

Public Class WebHeartbeatEvent
Inherits WebManagementEvent

Inheritance: Object

WebBaseEvent

WebManagementEvent
WebHeartbeatEvent

Examples

The following configuration file excerpt shows the configuration for the EventLogWebEventProvider so it can handle heartbeat health events.

Note

The EventLogWebEventProvider and the heartbeat health event types to monitor are configured by default. The only thing you need to do is to define the rule to monitor the heartbeat health events. Remember that by default only the failure audits are logged.

<healthMonitoring   
  enabled="true" heartbeatInterval="100">  
  <rules>  
    <add name="Heart Beat Events"  
      eventName="Heartbeats"  
      provider="EventLogProvider"  
      profile="Default"  
      minInterval="00:01:00" />  
  </rules>  
</healthMonitoring>

Remarks

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 heartbeat health-monitoring events serve as a timer for the ASP.NET health-monitoring system. They are raised at an interval defined by the heartBeatInterval attribute of the healthMonitoring configuration section. The WebHeartbeatEvent uses the WebProcessStatistics class to obtain process information.

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.

Constructors

WebHeartbeatEvent(String, Int32)

Initializes a new instance of the WebHeartbeatEvent class with the given message and event code.

Properties

EventCode	Gets the code value associated with the event. (Inherited from WebBaseEvent)
EventDetailCode	Gets the event detail code. (Inherited from WebBaseEvent)
EventID	Gets the identifier associated with the event. (Inherited from WebBaseEvent)
EventOccurrence	Gets a counter that represents the number of times the event has occurred. (Inherited from WebBaseEvent)
EventSequence	Gets the number of times the event has been raised by the application. (Inherited from WebBaseEvent)
EventSource	Gets the object that raises the event. (Inherited from WebBaseEvent)
EventTime	Gets the time when the event was raised. (Inherited from WebBaseEvent)
EventTimeUtc	Gets the time when the event was raised. (Inherited from WebBaseEvent)
Message	Gets the message that describes the event. (Inherited from WebBaseEvent)
ProcessInformation	Gets information about the ASP.NET application-hosting process. (Inherited from WebManagementEvent)
ProcessStatistics	Provides key information about the running process.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
FormatCustomEventDetails(WebEventFormatter)	Provides standard formatting of the event information. (Inherited from WebBaseEvent)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
IncrementPerfCounters()	Used internally to increment performance counters. (Inherited from WebBaseEvent)
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. (Inherited from WebBaseEvent)
ToString()	Formats event information for display purposes. (Inherited from WebBaseEvent)
ToString(Boolean, Boolean)	Formats event information for display purposes. (Inherited from WebBaseEvent)

Applies to

Jaa