TraceWebEventProvider Class

TraceWebEventProvider Class

 

Implements an event provider that sends ASP.NET health-monitoring events as trace messages.

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

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

public sealed class TraceWebEventProvider : WebEventProvider

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

This API supports the product infrastructure and is not intended to be used directly from your code. 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)

This API supports the product infrastructure and is not intended to be used directly from your code. Sets the initial values for this object.(Overrides ProviderBase.Initialize(String, NameValueCollection).)

System_CAPS_pubmethodProcessEvent(WebBaseEvent)

This API supports the product infrastructure and is not intended to be used directly from your code. Processes the event passed to the provider.(Overrides WebEventProvider.ProcessEvent(WebBaseEvent).)

System_CAPS_pubmethodShutdown()

This API supports the product infrastructure and is not intended to be used directly from your code. 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.

This provider passes events to the Trace object. It passes events that derive from the WebBaseErrorEvent class as trace errors and passes all other events as trace information.

System_CAPS_noteNote

The TraceWebEventProvider object does not provide event buffering.

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 configuration file excerpt shows how to specify a provider of type TraceWebEventProvider in the healthMonitoring section. The add element in the rules section specifies that the provider will handle request-processing events.

<healthMonitoring
    enabled="true"
    heartBeatInterval="0">
    <providers>
        <add name="TraceEventProvider"
            type="System.Web.Management.TraceWebEventProvider, 
              System.Web"
            buffer="false"
            bufferMode=""
            maxEventLength="4096"
            maxSize="4096"
            maxMessagesPerNotification="1"
        />
    </providers>
    <eventMappings>
        <add name="Request Processing Events"
            type="System.Web.Management.WebRequestEvent, System.Web" 
        />
    </eventMappings>
    <profiles>
        <add name="Trace"
            minInstances="1"
            maxLimit="Infinite"
            minInterval="00:00:00"
        />
    </profiles>
    <rules>
        <add name="Trace Request Processing"
            eventName="Request Processing Events"
            provider="TraceEventProvider"
            profile="Trace"
        />
   </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