WmiWebEventProvider Class

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Implements an event provider that maps ASP.NET health-monitoring events to Windows Management Instrumentation (WMI) events.

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

System.Object
  System.Configuration.Provider.ProviderBase
    System.Web.Management.WebEventProvider
      System.Web.Management.WmiWebEventProvider

type WmiWebEventProvider = 
    class
        inherit WebEventProvider
    end

NameDescription
System_CAPS_pubmethodWmiWebEventProvider()

Initializes a new instance of the WmiWebEventProvider class.

NameDescription
System_CAPS_pubpropertyDescription

Gets a brief, friendly description suitable for display in administrative tools or other user interfaces (UIs).(Inherited from ProviderBase.)

System_CAPS_pubpropertyName

Gets the friendly name used to refer to the provider during configuration.(Inherited from ProviderBase.)

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_pubmethodFlush()

Removes all events from the provider's buffer.(Overrides WebEventProvider.Flush().)

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_pubmethodInitialize(String, NameValueCollection)

Sets the initial values for this object.(Overrides ProviderBase.Initialize(String, NameValueCollection).)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodProcessEvent(WebBaseEvent)

Processes the event passed to the provider.(Overrides WebEventProvider.ProcessEvent(WebBaseEvent).)

System_CAPS_pubmethodShutdown()

Performs tasks associated with shutting down the provider.(Overrides WebEventProvider.Shutdown().)

System_CAPS_pubmethodToString()

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

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.

ASP.NET uses this class to map health-monitoring events to WMI events. To enable the delivery of ASP.NET health-monitoring events to the WMI subsystem, you must configure the WmiWebEventProvider class by adding the appropriate settings in the <healthMonitoring> section of the configuration file.

The information contained in the Aspnet.mof file describes the parameters of the WMI events raised when ASP.NET health-monitoring events are routed to the WmiWebEventProvider class and mapped into WMI events. The Aspnet.mof file is stored in the .NET Framework build directory, for example %windir%\Microsoft.NET\Framework\BuildNumber. For more information about reporting health-monitoring events as WMI events, see NIB: Using WMI to Deliver ASP.NET Health Monitoring Events.

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. For an example of creating a custom provider, see How to: Implement the Health Monitoring Custom Provider Example.

The following example shows how to create a consumer of WMI events issued by ASP.NET health monitoring as a result of Web-application health events.

System_CAPS_noteNote

The WmiWebEventProvider class and the health event types to monitor are already configured by default. The only thing you need to do is to define the rule for all the health events. Remember that the health events are not dispatched to the WmiWebEventProvider provider by default.

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

The following example is a configuration file excerpt that shows a <healthMonitoring> configuration section that enables ASP.NET to use the WmiWebEventProvider provider to process all health-monitoring events.

<healthMonitoring>
  <rules>
    <add 
      name="Using Wmi"
      eventName="All Events" 
      provider="WmiWebEventProvider" 
      profile="Critical"/>
  </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: