WebRequestErrorEvent Class

Reference

Definition

Namespace:: System.Web.Management

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Defines the event that carries information about Web-request errors.

public ref class WebRequestErrorEvent : System::Web::Management::WebBaseErrorEvent

public class WebRequestErrorEvent : System.Web.Management.WebBaseErrorEvent

type WebRequestErrorEvent = class
    inherit WebBaseErrorEvent

Public Class WebRequestErrorEvent
Inherits WebBaseErrorEvent

Inheritance: Object

WebBaseEvent

WebManagementEvent

WebBaseErrorEvent
WebRequestErrorEvent

Derived: System.Web.Management.WebServiceErrorEvent

Examples

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

<healthMonitoring enabled="true" heartBeatInterval="0">  
  <eventMappings>  
    <add  name="SampleWebRequestErrorEvent" type="SamplesAspNet.SampleWebRequestErrorEvent,webrequesterrorevent,Version=1.0.1573.21654, Culture=neutral, PublicKeyToken=63ada862a6c5af13, processorArchitecture=MSIL"/>  
  </eventMappings>  

  <rules>  
    <add   
      name="Custom Web Request Error Events"  
      eventName="SampleWebRequestErrorEvent"   
      provider="EventLogProvider"    
      profile="Critical"/>  
  </rules>  
</healthMonitoring>


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

namespace Samples.AspNet.Management
{
  // Implements a custom WebRequestErrorEvent class. 
    public class SampleWebRequestErrorEvent : 
        WebRequestErrorEvent
    {
        private StringBuilder eventInfo;

        // Invoked in case of events 
        // identified only by their event code.
        public SampleWebRequestErrorEvent(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 SampleWebRequestErrorEvent(
            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 SampleWebRequestErrorEvent.
        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(
                "** SampleWebRequestEvent Start **");

            // Add custom data.
            formatter.AppendLine(eventInfo.ToString());

            formatter.AppendLine(
                      "** SampleWebRequestEvent End **");
        }
    }
}

Imports System.Text
Imports System.Web
Imports System.Web.Management


' Implements a custom WebRequestErrorEvent class. 
Public Class SampleWebRequestErrorEvent
   Inherits WebRequestErrorEvent
   Private eventInfo As StringBuilder
   
   
   ' Invoked in case of events 
   ' identified only by their event code.
    Public Sub New(ByVal msg As String, _
    ByVal eventSource As Object, _
    ByVal eventCode As Integer, _
    ByVal e As Exception)
        MyBase.New(msg, eventSource, _
        eventCode, e)
        ' Perform custom initialization.
        eventInfo = New StringBuilder()
        eventInfo.Append(String.Format( _
        "Event created at: ", _
        EventTime.ToString()))
    End Sub
   
   
   ' Invoked in case of events identified 
   ' by their event code.and related event 
   ' detailed code.
    Public Sub New(ByVal msg As String, _
    ByVal eventSource As Object, _
    ByVal eventCode As Integer, _
    ByVal detailedCode As Integer, _
    ByVal e As Exception)
        MyBase.New(msg, eventSource, _
        eventCode, detailedCode, e)
        ' Perform custom initialization.
        eventInfo = New StringBuilder()
        eventInfo.Append(String.Format( _
        "Event created at: ", _
        EventTime.ToString()))
    End Sub
   
   
   ' Raises the SampleWebRequestErrorEvent.
   Public Overrides Sub Raise()
      ' Perform custom processing. 
        eventInfo.Append(String.Format( _
        "Event raised at: ", _
        EventTime.ToString()))
      ' Raise the event.
      MyBase.Raise()
   End Sub
   
   ' Obtains the current request information.
   Public Function GetRequestInfo() As String
      Dim reqInfo As String = GetRequestInfo()
      Return reqInfo
   End Function 'GetRequestInfo
   
   
   ' Obtains the current thread information.
   Public Function GetThreadInfo() As String
      Dim threadInfo As String = GetThreadInfo()
      Return threadInfo
   End Function 'GetThreadInfo
   
   
   ' Obtains the current process information.
   Public Function GetProcessInfo() As String
      Dim procInfo As String = GetProcessInfo()
      Return procInfo
   End Function 'GetProcessInfo
   
   
   'Formats Web request event information.
    Public Overrides Sub FormatCustomEventDetails( _
    ByVal formatter As WebEventFormatter)
        MyBase.FormatCustomEventDetails(formatter)

        ' Add custom data.
        formatter.AppendLine("")

        formatter.IndentationLevel += 1
        formatter.AppendLine( _
        "** SampleWebRequestEvent Start **")

        ' Add custom data.
        formatter.AppendLine(eventInfo.ToString())

        formatter.AppendLine( _
        "** SampleWebRequestEvent End **")

    End Sub

End Class

Remarks

The WebRequestErrorEvent is raised if an error occurs during a Web request. Your application should use this event to obtain request-related information as defined by the WebRequestInformation and the WebThreadInformation classes.

Note

In most cases you will use the standard ASP.NET health monitoring types and control their behavior by setting the healthMonitoring configuration section. You can also create custom types, as shown in the next example. If you create your custom event type and you need to add your own information, customize the FormatCustomEventDetails method, this will avoid overwriting or tampering with sensitive system information.

Constructors

WebRequestErrorEvent(String, Object, Int32, Exception)	Initializes the WebRequestErrorEvent class with specified event parameters.
WebRequestErrorEvent(String, Object, Int32, Int32, Exception)	Initializes the WebRequestErrorEvent class with specified event parameters.

Properties

ErrorException	Gets the Exception associated with the error. (Inherited from WebBaseErrorEvent)
EventCode	Gets the code value associated with the event. (Inherited from WebBaseEvent)
EventDetailCode	Gets the event detail code. (Inherited from WebBaseEvent)
EventID	Gets the identifier associated with the event. (Inherited from WebBaseEvent)
EventOccurrence	Gets a counter that represents the number of times the event has occurred. (Inherited from WebBaseEvent)
EventSequence	Gets the number of times the event has been raised by the application. (Inherited from WebBaseEvent)
EventSource	Gets the object that raises the event. (Inherited from WebBaseEvent)
EventTime	Gets the time when the event was raised. (Inherited from WebBaseEvent)
EventTimeUtc	Gets the time when the event was raised. (Inherited from WebBaseEvent)
Message	Gets the message that describes the event. (Inherited from WebBaseEvent)
ProcessInformation	Gets information about the ASP.NET application-hosting process. (Inherited from WebManagementEvent)
RequestInformation	Gets the application request information.
ThreadInformation	Gets the application thread information.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
FormatCustomEventDetails(WebEventFormatter)	Provides standard formatting of the event information. (Inherited from WebBaseEvent)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
IncrementPerfCounters()	Used internally to increment the relevant performance counters.
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
Raise()	Raises an event by notifying any configured provider that the event has occurred. (Inherited from WebBaseEvent)
ToString()	Formats event information for display purposes. (Inherited from WebBaseEvent)
ToString(Boolean, Boolean)	Formats event information for display purposes. (Inherited from WebBaseEvent)

Applies to

Partilhar via