HealthMonitoringSection Class

.NET Framework (current version)
 

Configures ASP.NET profiles that determine how health-monitoring events are sent to event providers. This class cannot be inherited.

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

System::Object
  System.Configuration::ConfigurationElement
    System.Configuration::ConfigurationSection
      System.Web.Configuration::HealthMonitoringSection

C#
C++
F#
VB
Copy 
public ref class HealthMonitoringSection sealed : ConfigurationSection

NameDescription
System_CAPS_pubmethodHealthMonitoringSection()

This API supports the product infrastructure and is not intended to be used directly from your code. Initializes a new instance of the HealthMonitoringSection class using default settings.

NameDescription
System_CAPS_pubpropertyBufferModes

Gets a collection of objects that specify the settings for the buffer modes.

System_CAPS_pubpropertyCurrentConfiguration

Gets a reference to the top-level Configuration instance that represents the configuration hierarchy that the current ConfigurationElement instance belongs to.(Inherited from ConfigurationElement.)

System_CAPS_pubpropertyElementInformation

Gets an ElementInformation object that contains the non-customizable information and functionality of the ConfigurationElement object. (Inherited from ConfigurationElement.)

System_CAPS_protpropertyElementProperty

Gets the ConfigurationElementProperty object that represents the ConfigurationElement object itself.(Inherited from ConfigurationElement.)

System_CAPS_pubpropertyEnabled

Gets or sets a value indicating whether health monitoring is enabled.

System_CAPS_pubpropertyEventMappings

Gets a EventMappingSettingsCollection collection of EventMappingSettings objects.

System_CAPS_pubpropertyHeartbeatInterval

Gets or sets the interval used by the application domain when it raises the WebHeartbeatEvent event.

System_CAPS_protpropertyItem[ConfigurationProperty^]

Gets or sets a property or attribute of this configuration element.(Inherited from ConfigurationElement.)

System_CAPS_protpropertyItem[String^]

Gets or sets a property, attribute, or child element of this configuration element.(Inherited from ConfigurationElement.)

System_CAPS_pubpropertyLockAllAttributesExcept

Gets the collection of locked attributes.(Inherited from ConfigurationElement.)

System_CAPS_pubpropertyLockAllElementsExcept

Gets the collection of locked elements.(Inherited from ConfigurationElement.)

System_CAPS_pubpropertyLockAttributes

Gets the collection of locked attributes (Inherited from ConfigurationElement.)

System_CAPS_pubpropertyLockElements

Gets the collection of locked elements.(Inherited from ConfigurationElement.)

System_CAPS_pubpropertyLockItem

Gets or sets a value indicating whether the element is locked.(Inherited from ConfigurationElement.)

System_CAPS_pubpropertyProfiles

Gets a ProfileSettingsCollection collection of ProfileSettings objects.

System_CAPS_protpropertyProperties

Gets the collection of properties.(Inherited from ConfigurationElement.)

System_CAPS_pubpropertyProviders

Gets a ProviderSettingsCollection collection of ProviderSettings objects.

System_CAPS_pubpropertyRules

Gets a RuleSettingsCollection collection of RuleSettings objects.

System_CAPS_pubpropertySectionInformation

Gets a SectionInformation object that contains the non-customizable information and functionality of the ConfigurationSection object. (Inherited from ConfigurationSection.)

NameDescription
System_CAPS_protmethodDeserializeElement(XmlReader^, Boolean)

Reads XML from the configuration file.(Inherited from ConfigurationElement.)

System_CAPS_protmethodDeserializeSection(XmlReader^)

This API supports the product infrastructure and is not intended to be used directly from your code. Reads XML from the configuration file.(Inherited from ConfigurationSection.)

System_CAPS_pubmethodEquals(Object^)

Compares the current ConfigurationElement instance to the specified object.(Inherited from ConfigurationElement.)

System_CAPS_pubmethodGetHashCode()

Gets a unique value representing the current ConfigurationElement instance.(Inherited from ConfigurationElement.)

System_CAPS_protmethodGetRuntimeObject()

Returns a custom object when overridden in a derived class.(Inherited from ConfigurationSection.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodInit()

Sets the ConfigurationElement object to its initial state.(Inherited from ConfigurationElement.)

System_CAPS_protmethodInitializeDefault()

Used to initialize a default set of values for the ConfigurationElement object.(Inherited from ConfigurationElement.)

System_CAPS_protmethodIsModified()

Indicates whether this configuration element has been modified since it was last saved or loaded when implemented in a derived class.(Inherited from ConfigurationSection.)

System_CAPS_pubmethodIsReadOnly()

Gets a value indicating whether the ConfigurationElement object is read-only.(Inherited from ConfigurationElement.)

System_CAPS_protmethodReset(ConfigurationElement^)

Resets the internal state of the ConfigurationElement object, including the locks and the properties collections.(Inherited from ConfigurationElement.)

System_CAPS_protmethodResetModified()

Resets the value of the IsModified method to false when implemented in a derived class.(Inherited from ConfigurationSection.)

System_CAPS_protmethodSerializeElement(XmlWriter^, Boolean)

Writes the contents of this configuration element to the configuration file when implemented in a derived class.(Inherited from ConfigurationElement.)

System_CAPS_protmethodSerializeSection(ConfigurationElement^, String^, ConfigurationSaveMode)

This API supports the product infrastructure and is not intended to be used directly from your code. Creates an XML string containing an unmerged view of the ConfigurationSection object as a single section to write to a file.(Inherited from ConfigurationSection.)

System_CAPS_protmethodSerializeToXmlElement(XmlWriter^, String^)

Writes the outer tags of this configuration element to the configuration file when implemented in a derived class.(Inherited from ConfigurationElement.)

System_CAPS_protmethodSetReadOnly()

Sets the IsReadOnly property for the ConfigurationElement object and all subelements.(Inherited from ConfigurationElement.)

System_CAPS_protmethodShouldSerializeElementInTargetVersion(ConfigurationElement^, String^, FrameworkName^)

Indicates whether the specified element should be serialized when the configuration object hierarchy is serialized for the specified target version of the .NET Framework.(Inherited from ConfigurationSection.)

System_CAPS_protmethodShouldSerializePropertyInTargetVersion(ConfigurationProperty^, String^, FrameworkName^, ConfigurationElement^)

Indicates whether the specified property should be serialized when the configuration object hierarchy is serialized for the specified target version of the .NET Framework.(Inherited from ConfigurationSection.)

System_CAPS_protmethodShouldSerializeSectionInTargetVersion(FrameworkName^)

Indicates whether the current ConfigurationSection instance should be serialized when the configuration object hierarchy is serialized for the specified target version of the .NET Framework.(Inherited from ConfigurationSection.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_protmethodUnmerge(ConfigurationElement^, ConfigurationElement^, ConfigurationSaveMode)

Modifies the ConfigurationElement object to remove all values that should not be saved. (Inherited from ConfigurationElement.)

This class corresponds to the <healthMonitoring> configuration file element.

System_CAPS_noteNote

Medium trust or higher is required to raise an event.

The following configuration file excerpt shows how to specify the HealthMonitoringSection class.

Copy 
<healthMonitoring
  enabled="true"
  heartBeatInterval="0">
  <bufferModes>
    <add name="Critical Notification"
      maxBufferSize="100"
      maxFlushSize="20"
      urgentFlushThreshold="1"
      regularFlushInterval="Infinite"
      urgentFlushInterval="00:01:00"
      maxBufferThreads="1"
    />
    <add name="Notification"
      maxBufferSize="300"
      maxFlushSize="20"
      urgentFlushThreshold="1"
      regularFlushInterval="Infinite"
      urgentFlushInterval="00:01:00"
      maxBufferThreads="1"
    />
    <add name="Analysis"
      maxBufferSize="1000"
      maxFlushSize="100"
      urgentFlushThreshold="100"
      regularFlushInterval="00:05:00"
      urgentFlushInterval="00:01:00"
      maxBufferThreads="1"
    />
    <add name="Logging"
      maxBufferSize="1000"
      maxFlushSize="200"
      urgentFlushThreshold="800"
      regularFlushInterval="00:30:00"
      urgentFlushInterval="00:05:00"
      maxBufferThreads="1"
    />
  </bufferModes>
  <providers>
    <add name="CriticalMailEventProvider"
      type="System.Web.Management.SimpleMailWebEventProvider, System.Web, Version=%ASSEMBLY_VERSION%, Culture=neutral, PublicKeyToken=%MICROSOFT_PUBLICKEY%"
      from="sender address"
      to="bob@contoso.com"
      cc="stella@contoso.com"
      bcc="joe@contoso.com"
      priority="High"
      bodyHeader="Warning!"
      bodyFooter="Please investigate ASAP."
      subjectPrefix="Action required."
      buffer="true"
      bufferMode="Critical Notification"
      maxEventLength="4096"
      maxSize="4096"
      maxMessagesPerNotification="1"
    />
    <add name="EventLogProvider"
      type="System.Web.Management.EventLogWebEventProvider, System.Web, Version=%ASSEMBLY_VERSION%, Culture=neutral, PublicKeyToken=%MICROSOFT_PUBLICKEY%"
      buffer="true"
      bufferMode="Logging"
    />
    <add name="SqlWebEventProvider"
      type="System.Web.Management.SqlWebEventProvider, System.Web, Version=%ASSEMBLY_VERSION%, Culture=neutral, PublicKeyToken=%MICROSOFT_PUBLICKEY%"
      connectionStringName="LocalSqlServer"
      maxEventDetailsLength="1073741823"
      buffer="true"
      bufferMode="Analysis"
    />
    <add name="WmiWebEventProvider"
      type="System.Web.Management.WmiWebEventProvider, System.Web, Version=%ASSEMBLY_VERSION%, Culture=neutral, PublicKeyToken=%MICROSOFT_PUBLICKEY%"
      buffer="true"
      bufferMode="Notification"
    />
  </providers>
  <eventMappings>
    <add name="All Events"
      type="System.Web.Management.WebBaseEvent, System.Web, Version=%ASSEMBLY_VERSION%, Culture=neutral, PublicKeyToken=%MICROSOFT_PUBLICKEY%" 
    />
    <add name="HeartBeats"
      type="System.Web.Management.WebHeartbeatEvent, System.Web, Version=%ASSEMBLY_VERSION%, Culture=neutral, PublicKeyToken=%MICROSOFT_PUBLICKEY%" 
    />
    <add name="Application Lifetime Events"
      type="System.Web.Management.WebApplicationLifetimeEvent, System.Web, Version=%ASSEMBLY_VERSION%, Culture=neutral, PublicKeyToken=%MICROSOFT_PUBLICKEY%" 
    />
    <add name="Request Processing Events"
      type="System.Web.Management.WebRequestEvent, System.Web, Version=%ASSEMBLY_VERSION%, Culture=neutral, PublicKeyToken=%MICROSOFT_PUBLICKEY%" 
    />
    <add name="All Errors"
      type="System.Web.Management.WebBaseErrorEvent, System.Web, Version=%ASSEMBLY_VERSION%, Culture=neutral, PublicKeyToken=%MICROSOFT_PUBLICKEY%" 
    />
    <add name="Infrastructure Errors"
      type="System.Web.Management.WebErrorEvent, System.Web, Version=%ASSEMBLY_VERSION%, Culture=neutral, PublicKeyToken=%MICROSOFT_PUBLICKEY%" 
    />
    <add name="Request Processing Errors"
      type="System.Web.Management.WebRequestErrorEvent, System.Web, Version=%ASSEMBLY_VERSION%, Culture=neutral, PublicKeyToken=%MICROSOFT_PUBLICKEY%" 
    />
    <add name="All Audits"
      type="System.Web.Management.WebAuditEvent, System.Web, Version=%ASSEMBLY_VERSION%, Culture=neutral, PublicKeyToken=%MICROSOFT_PUBLICKEY%" 
    />
    <add name="Failure Audits"
      type="System.Web.Management.WebFailureAuditEvent, System.Web, Version=%ASSEMBLY_VERSION%, Culture=neutral, PublicKeyToken=%MICROSOFT_PUBLICKEY%" 
    />
    <add name="Success Audits"
      type="System.Web.Management.WebSuccessAuditEvent, System.Web, Version=%ASSEMBLY_VERSION%, Culture=neutral, PublicKeyToken=%MICROSOFT_PUBLICKEY%" 
    />
  </eventMappings>
  <profiles>
    <add name="Default"
      minInstances="1"
      maxLimit="Infinite"
      minInterval="00:10:00"
    />
    <add name="Critical"
      minInstances="1"
      maxLimit="1024"
      minInterval="00:00:00"
    />
  </profiles>
  <rules>
    <add name="All Errors Default"
      eventName="All Errors"
      provider="EventLogProvider"
      profile="Default"
      minInterval="00:01:00" 
    />
    <add name="All Audits Default"
      eventName="All Audits"
      provider="SqlWebEventProvider"
      profile="Default"
      minInterval="00:00:30" 
    />
    <add name="Failure Audits Default"
      eventName="Failure Audits"
      provider="WmiWebEventProvider"
      profile="Critical"
      minInterval="00:00:30" 
     />
     <add name="Request Processing Errors"
       eventName="Request Processing Errors"
       provider="CriticalMailEventProvider"
       profile="Default"
     />
     <add name="Infrastructure Notifications"
      eventName="Infrastructure Errors"
      provider="CriticalMailEventProvider"
      profile="Critical"
    />
  </rules>
</healthMonitoring>

The following code example shows how to use the HealthMonitoringSection class.

C#
VB
C++
Copy
No code example is currently available or this language may not be supported.

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