Export (0) Print
Expand All

WebBaseErrorEvent Class

Serves as the base class for all the health-monitoring error events.

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

public class WebBaseErrorEvent : WebManagementEvent

The WebBaseErrorEvent type exposes the following members.

  NameDescription
Protected methodWebBaseErrorEvent(String, Object, Int32, Exception)Infrastructure. Initializes a new instance of the WebBaseErrorEvent class.
Protected methodWebBaseErrorEvent(String, Object, Int32, Int32, Exception)Infrastructure. Initializes a new instance of the WebBaseErrorEvent class.
Top

  NameDescription
Public propertyErrorExceptionGets the Exception associated with the error.
Public propertyEventCodeGets the code value associated with the event. (Inherited from WebBaseEvent.)
Public propertyEventDetailCodeGets the event detail code. (Inherited from WebBaseEvent.)
Public propertyEventIDGets the identifier associated with the event. (Inherited from WebBaseEvent.)
Public propertyEventOccurrenceGets a counter that represents the number of times the event has occurred. (Inherited from WebBaseEvent.)
Public propertyEventSequenceGets the number of times the event has been raised by the application. (Inherited from WebBaseEvent.)
Public propertyEventSourceGets the object that raises the event. (Inherited from WebBaseEvent.)
Public propertyEventTimeGets the time when the event was raised. (Inherited from WebBaseEvent.)
Public propertyEventTimeUtcGets the time when the event was raised. (Inherited from WebBaseEvent.)
Public propertyMessageGets the message that describes the event. (Inherited from WebBaseEvent.)
Public propertyProcessInformationGets information about the ASP.NET application-hosting process. (Inherited from WebManagementEvent.)
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodFormatCustomEventDetailsProvides standard formatting of the event information. (Inherited from WebBaseEvent.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodIncrementPerfCountersInfrastructure. Increments the event-error performance-related counters. (Overrides WebBaseEvent.IncrementPerfCounters().)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodRaise()Raises an event by notifying any configured provider that the event has occurred. (Inherited from WebBaseEvent.)
Public methodToString()Formats event information for display purposes. (Inherited from WebBaseEvent.)
Public methodToString(Boolean, Boolean)Formats event information for display purposes. (Inherited from WebBaseEvent.)
Top

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 WebBaseErrorEvent class is the base class for the health-monitoring events that represent error conditions. ASP.NET uses WebBaseErrorEvent and its derived types to indicate error conditions during the lifetime of a Web application.

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 deriving from the WebBaseErrorEvent class, see the example provided in this topic.

The following code example has two parts. The first is an excerpt of a configuration file that enables ASP.NET health monitoring to use an event derived from the WebBaseErrorEvent class. The second shows how to derive from the WebBaseErrorEvent class to create the custom event.

<healthMonitoring 
  enabled="true" heartBeatInterval="0">

  <providers>
    <!-- Define the custom provider that 
         processes custom Web request events. -->
    <add name="SampleWebEventProvider" 
      type="SamplesAspNet.SampleEventProvider,
      webeventprovider,Version=1.0.1573.18094, 
      Culture=neutral, PublicKeyToken=b5a57a9a9d487cf4, 
      processorArchitecture=MSIL"/>
  </providers>

  <eventMappings>
     
    <!--  Define the event source that issues custom events.   -->
    <add  name="SampleWebBaseErrorEvent"    
      type="SamplesAspNet.SampleWebBaseErrorEvent,
      webbaseerrorevent,Version=1.0.1573.21549, Culture=neutral,   
      PublicKeyToken=2a0b23915ac7352b, processorArchitecture=MSIL"/>
  </eventMappings>
  
  <rules>
    <!-- Associate custom event with related 
      custom provider -->
    <add 
       name="Custom Web Base Errors"
       eventName="SampleWebBaseErrorEvent" 
       provider="SampleWebEventProvider" 
       profile="Custom"/>  
  </rules>

</healthMonitoring>

The following code shows how to derive from the WebBaseErrorEvent class to create a custom event.


using System;
using System.Text;
using System.Web;
using System.Web.Management;

namespace Samples.AspNet.Management
{
  // Implements a custom WebErrorEvent class.  

    public class SampleWebErrorEvent : WebErrorEvent
    {
        private StringBuilder eventInfo;

        // Invoked in case of events identified  
        // only by their event code. 
        public SampleWebErrorEvent(string msg, 
            object eventSource, int eventCode, Exception e)
            :
        base(msg, eventSource, eventCode, e)
        {
            // Perform custom initialization.
            eventInfo = new StringBuilder();
            eventInfo.Append(string.Format(
                "Event created at: ", EventTime.ToString()));
        }


        // Invoked in case of events identified  
        // by their event code.and  
        // related event detailed code. 
        public SampleWebErrorEvent(string msg, 
            object eventSource, int eventCode, 
            int detailedCode, Exception e):
          base(msg, eventSource, 
            eventCode, detailedCode, e)
        {
            // Perform custom initialization.
            eventInfo = new StringBuilder();
            eventInfo.Append(string.Format(
                "Event created at: ", EventTime.ToString()));
        }


        // Raises the SampleWebErrorEvent. 
        public override void Raise()
        {
            // Perform custom processing. 
            eventInfo.Append(string.Format(
                "Event raised at: ", EventTime.ToString()));

            // Raise the event. 
            base.Raise();
        }

        // Obtains the current request information. 
        public string GetRequestInfo()
        {
            string reqInfo = GetRequestInfo();
            return reqInfo;
        }


        // Obtains the current thread information. 
        public string GetThreadInfo()
        {
            string threadInfo = GetThreadInfo();
            return threadInfo;
        }


        // Obtains the current process information. 
        public string GetProcessInfo()
        {
            string procInfo = GetProcessInfo();
            return procInfo;
        }


        //Formats Web request event information.. 
        public override void FormatCustomEventDetails(
            WebEventFormatter formatter)
        {

            base.FormatCustomEventDetails(formatter);


            // Add custom data.
            formatter.AppendLine("");

            formatter.IndentationLevel += 1;
            formatter.AppendLine(
                "** SampleWebErrorEvent Start **");

            formatter.AppendLine(eventInfo.ToString());

            formatter.AppendLine(
                "** SampleWebBaseErrorEvent End **");

            formatter.IndentationLevel -= 1;



        }
    }

}

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft