WebErrorEvent Class
Definition
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.
Provides information about systemic errors.
public ref class WebErrorEvent : System::Web::Management::WebBaseErrorEvent
public class WebErrorEvent : System.Web.Management.WebBaseErrorEvent
type WebErrorEvent = class
inherit WebBaseErrorEvent
Public Class WebErrorEvent
Inherits WebBaseErrorEvent
- Inheritance
Examples
The following code example shows how to derive from the WebErrorEvent class to create a custom event.
Also shown is an excerpt of the configuration file that enables ASP.NET to use this custom event.
<healthMonitoring
enabled="true" heartBeatInterval="0">
<eventMappings>
<add name="SampleWebErrorEvent" type="SamplesAspNet.SampleWebErrorEvent,weberrorevent,Version=1.0.1573.21549, Culture=neutral, PublicKeyToken=2a0b23915ac7352b, processorArchitecture=MSIL"/>
</eventMappings>
<profiles>
<add name="Custom"
minInstances="1"
maxLimit="Infinite"
minInterval="00:00:00" />
</profiles>
<rules>
<clear />
<add name="Custom Web Error Event"
eventName="SampleWebErrorEvent"
provider="EventLogProvider"
profile="Custom" />
</rules>
</healthMonitoring>
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;
}
}
}
Imports System.Text
Imports System.Web
Imports System.Web.Management
' Implements a custom WebErrorEvent class.
Public Class SampleWebErrorEvent
Inherits WebErrorEvent
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 SampleWebErrorEvent.
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( _
"** SampleWebErrorEvent Start **")
formatter.AppendLine(eventInfo.ToString())
formatter.AppendLine( _
"** SampleWebBaseErrorEvent End **")
formatter.IndentationLevel -= 1
End Sub
End Class
Remarks
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 WebErrorEvent provides information about errors caused by problems with configuration or application code. An example is the error issued by ASP.NET when an error is found in a page.
Note
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 WebErrorEvent class, see the example provided in this topic.
Constructors
WebErrorEvent(String, Object, Int32, Exception) |
Initializes the WebErrorEvent class using the supplied parameters. |
WebErrorEvent(String, Object, Int32, Int32, Exception) |
Initializes a new instance of the WebErrorEvent class using the supplied 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 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
See also
.NET