WebBaseErrorEvent Class

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

NameDescription
System_CAPS_protmethodWebBaseErrorEvent(String, Object, Int32, Exception)

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

System_CAPS_protmethodWebBaseErrorEvent(String, Object, Int32, Int32, Exception)

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

NameDescription
System_CAPS_pubpropertyErrorException

Gets the Exception associated with the error.

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

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. Increments the event-error performance-related counters.(Overrides WebBaseEvent.IncrementPerfCounters().)

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

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