WebHeartbeatEvent Class

WebHeartbeatEvent Class

 

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

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

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

public class WebHeartbeatEvent : WebManagementEvent

NameDescription
System_CAPS_protmethodWebHeartbeatEvent(String, Int32)

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

NameDescription
System_CAPS_pubpropertyEventCode

Gets the code value associated with the event.(Inherited from WebBaseEvent.)

System_CAPS_pubpropertyEventDetailCode

Gets the event detail code.(Inherited from WebBaseEvent.)

System_CAPS_pubpropertyEventID

Gets the identifier associated with the event.(Inherited from WebBaseEvent.)

System_CAPS_pubpropertyEventOccurrence

Gets a counter that represents the number of times the event has occurred.(Inherited from WebBaseEvent.)

System_CAPS_pubpropertyEventSequence

Gets the number of times the event has been raised by the application.(Inherited from WebBaseEvent.)

System_CAPS_pubpropertyEventSource

Gets the object that raises the event.(Inherited from WebBaseEvent.)

System_CAPS_pubpropertyEventTime

Gets the time when the event was raised.(Inherited from WebBaseEvent.)

System_CAPS_pubpropertyEventTimeUtc

Gets the time when the event was raised.(Inherited from WebBaseEvent.)

System_CAPS_pubpropertyMessage

Gets the message that describes the event.(Inherited from WebBaseEvent.)

System_CAPS_pubpropertyProcessInformation

Gets information about the ASP.NET application-hosting process.(Inherited from WebManagementEvent.)

System_CAPS_pubpropertyProcessStatistics

Provides key information about the running process.

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.(Inherited from WebBaseEvent.)

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.(Inherited from WebBaseEvent.)

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.(Inherited from WebBaseEvent.)

System_CAPS_pubmethodToString()

Formats event information for display purposes.(Inherited from WebBaseEvent.)

System_CAPS_pubmethodToString(Boolean, Boolean)

Formats event information for display purposes.(Inherited from WebBaseEvent.)

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.

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.

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

System_CAPS_noteNote

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>

.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:
© 2016 Microsoft