WebBaseEvent Clase
Definición
Importante
Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.
Define la clase base para los eventos de supervisión de estado de ASP.NET.
public ref class WebBaseEvent
public class WebBaseEvent
type WebBaseEvent = class
Public Class WebBaseEvent
- Herencia
-
WebBaseEvent
- Derivado
Ejemplos
En el ejemplo siguiente se muestra cómo derivar de la WebBaseEvent clase para crear un evento de supervisión de estado personalizado.
using System;
using System.Text;
using System.Web;
using System.Web.Management;
namespace SamplesAspNet
{
// Implements a custom WebBaseEvent class.
public class SampleWebBaseEvent :
System.Web.Management.WebBaseEvent, IWebEventCustomEvaluator
{
private string customCreatedMsg, customRaisedMsg;
// Store firing record info.
private static string firingRecordInfo;
// Implements the IWebEventCustomEvaluator.CanFire
// method. It is called by the ASP.NET if this custom
// type is configured in the profile
// element of the healthMonitoring section.
public bool CanFire(
System.Web.Management.WebBaseEvent e,
RuleFiringRecord rule)
{
bool fireEvent;
string lastFired = rule.LastFired.ToString();
string timesRaised = rule.TimesRaised.ToString();
// Fire every other event raised.
fireEvent =
(rule.TimesRaised % 2 == 0) ? true : false;
if (fireEvent)
{
firingRecordInfo =
string.Format("Event last fired: {0}",
lastFired) +
string.Format(". Times raised: {0}",
timesRaised);
}
else
firingRecordInfo =
string.Format(
"Event not fired. Times raised: {0}",
timesRaised);
return fireEvent;
}
// Invoked in case of events identified only by
// their event code.
public SampleWebBaseEvent(string msg,
object eventSource, int eventCode):
base(msg, eventSource, eventCode)
{
// Perform custom initialization.
customCreatedMsg =
string.Format("Event created at: {0}",
EventTime.ToString());
}
// Invoked in case of events identified by their
// event code.and related event detailed code.
public SampleWebBaseEvent(string msg, object eventSource,
int eventCode, int eventDetailCode):
base(msg, eventSource, eventCode, eventDetailCode)
{
// Perform custom initialization.
customCreatedMsg =
string.Format("Event created at: {0}",
EventTime.ToString());
}
// Raises the SampleWebBaseEvent.
public override void Raise()
{
// Perform custom processing.
customRaisedMsg =
string.Format("Event raised at: {0}",
EventTime.ToString());
// Raise the event.
base.Raise();
}
// Raises the SampleWebBaseEvent.
public void CustomRaise(
System.Web.Management.WebBaseEvent evnt)
{
// Raise the event.
Raise(evnt);
}
// Gets the event code.
public int GetEventCode(bool detail)
{
int eCode;
if (!detail)
// Get the event code.
eCode = EventCode;
else
// Get the detail event code.
eCode = EventDetailCode;
return eCode;
}
// Gets the event sequence.
public long GetEventSequence()
{
// Get the event sequence.
long eventSequence = EventSequence;
return eventSequence;
}
// Gets the event source.
public Object GetEventSource()
{
// Get the event source.
Object source = this.EventSource;
return source;
}
// Gets the event time.
public DateTime GetEventTime()
{
// Get the event source.
DateTime eTime = EventTime;
return eTime;
}
// Gets the event time.
public DateTime GetEventTimeUtc()
{
// Get the event source.
DateTime eTime = EventTimeUtc;
return eTime;
}
// Gets the event sequence.
public string GetEventMessage()
{
// Get the event message.
string eventMsg = Message;
return eventMsg;
}
// Gets the current application information.
public WebApplicationInformation GetEventAppInfo()
{
// Get the event message.
WebApplicationInformation appImfo =
ApplicationInformation;
return appImfo;
}
// Implements the ToString() method.
public override string ToString()
{
return base.ToString();
}
// Implements the ToString(bool, bool) method.
public string customToString(bool includeAppInfo,
bool includeCustomInfo)
{
return (
base.ToString(includeAppInfo,
includeCustomInfo));
}
// Gets the event identifier.
public Guid GetEventId()
{
Guid evId = EventID;
return evId;
}
//Formats Web request event information.
public override void FormatCustomEventDetails(
WebEventFormatter formatter)
{
base.FormatCustomEventDetails(formatter);
// Add custom data.
formatter.AppendLine("");
formatter.IndentationLevel += 1;
formatter.TabSize = 4;
formatter.AppendLine(
"*SampleWebBaseEvent Start *");
// Display custom event information.
formatter.AppendLine(customCreatedMsg);
formatter.AppendLine(customRaisedMsg);
formatter.AppendLine(firingRecordInfo);
formatter.AppendLine(
"* SampleWebBaseEvent End *");
formatter.IndentationLevel -= 1;
}
}
}
Imports System.Text
Imports System.Web
Imports System.Web.Management
Public Class SampleWebBaseEvent
Inherits System.Web.Management.WebBaseEvent
Implements System.Web.Management.IWebEventCustomEvaluator
Private customCreatedMsg, customRaisedMsg As String
' Store firing record info.
Private Shared firingRecordInfo As String
' Implements the IWebEventCustomEvaluator.CanFire
' method. It is called by the ASP.NET if this custom
' type is configured in the profile
' element of the healthMonitoring section.
Public Function CanFire( _
ByVal e As System.Web.Management.WebBaseEvent, _
ByVal rule As RuleFiringRecord) As Boolean _
Implements System.Web.Management.IWebEventCustomEvaluator.CanFire
Dim fireEvent As Boolean
Dim lastFired As String = _
rule.LastFired.ToString()
Dim timesRaised As String = _
rule.TimesRaised.ToString()
' Fire every other event raised.
fireEvent = _
IIf(rule.TimesRaised Mod 2 = 0, True, False)
If fireEvent Then
firingRecordInfo = String.Format( _
"Event last fired: {0}", lastFired) + _
String.Format( _
". Times raised: {0}", timesRaised)
Else
firingRecordInfo = String.Format( _
"Event not fired. Times raised: {0}", _
timesRaised)
End If
Return fireEvent
End Function 'CanFire
' 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)
MyBase.New(msg, eventSource, eventCode)
' Perform custom initialization.
customCreatedMsg = String.Format( _
"Event created at: {0}", DateTime.Now.TimeOfDay.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 eventDetailCode As Integer)
MyBase.New(msg, eventSource, _
eventCode, eventDetailCode)
' Perform custom initialization.
customCreatedMsg = String.Format( _
"Event created at: {0}", DateTime.Now.TimeOfDay.ToString())
End Sub
' Raises the SampleWebBaseEvent.
Public Overrides Sub Raise()
' Perform custom processing.
customRaisedMsg = String.Format( _
"Event raised at: {0}", DateTime.Now.TimeOfDay.ToString())
' Raise the event.
MyBase.Raise()
End Sub
' Raises the SampleWebBaseEvent.
Public Sub CustomRaise(ByVal evnt _
As System.Web.Management.WebBaseEvent)
' Raise the event.
Raise(evnt)
End Sub
' Gets the event code.
Public Function GetEventCode(ByVal detail _
As Boolean) As Integer
Dim eCode As Integer
If Not detail Then
' Get the event code.
eCode = EventCode
' Get the detail event code.
Else
eCode = EventDetailCode
End If
Return eCode
End Function 'GetEventCode
' Gets the event sequence.
Public Function GetEventSequence() As Long
' Get the event sequence.
Dim eventSequence As Long = eventSequence
Return eventSequence
End Function 'GetEventSequence
' Gets the event source.
Public Function GetEventSource() As [Object]
' Get the event source.
Dim [source] As [Object] = Me.EventSource
Return [source]
End Function 'GetEventSource
' Gets the event time.
Public Function GetEventTime() As DateTime
' Get the event source.
Dim eTime As DateTime = EventTime
Return eTime
End Function 'GetEventTime
' Gets the event time.
Public Function GetEventTimeUtc() As DateTime
' Get the event source.
Dim eTime As DateTime = EventTimeUtc
Return eTime
End Function 'GetEventTimeUtc
' Gets the event sequence.
Public Function GetEventMessage() As String
' Get the event message.
Dim eventMsg As String = Message
Return eventMsg
End Function 'GetEventMessage
' Gets the current application information.
Public Function GetEventAppInfo() As WebApplicationInformation
' Get the event message.
Dim appImfo As WebApplicationInformation = _
ApplicationInformation
Return appImfo
End Function 'GetEventAppInfo
' Implements the ToString() method.
Public Overrides Function ToString() As String
Return MyBase.ToString()
End Function 'ToString
' Implements the ToString(bool, bool) method.
Public Function customToString(ByVal includeAppInfo As Boolean, _
ByVal includeCustomInfo As Boolean) As String
Return MyBase.ToString(includeAppInfo, includeCustomInfo)
End Function 'customToString
' Gets the event identifier.
Public Function GetEventId() As Guid
Dim evId As Guid = EventID
Return evId
End Function 'GetEventId
'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.TabSize = 4
formatter.AppendLine("*SampleWebBaseEvent Start *")
formatter.AppendLine("Custom information goes here")
formatter.AppendLine("* SampleWebBaseEvent End *")
' Display custom event timing.
formatter.AppendLine(customCreatedMsg)
formatter.AppendLine(customRaisedMsg)
formatter.IndentationLevel -= 1
End Sub
End Class
El ejemplo siguiente es un extracto del archivo de configuración que permite ASP.NET usar el evento personalizado.
<healthMonitoring enabled="true" heartBeatInterval="0">
<eventMappings>
<add name="SampleWebBaseEvent"
type="SamplesAspNet.SampleWebBaseEvent,
webbaseevent, Version=1.0.1573.24438, Culture=neutral,
PublicKeyToken=2f5f337ae5c9bdaa,
processorArchitecture=MSIL" />
</eventMappings>
<rules>
<add
name="CustomWebBaseEvent"
eventName="SampleWebBaseEvent"
provider="EventLogProvider"
profile="Critical"/>
</rules>
</healthMonitoring>
Comentarios
ASP.NET supervisión de estado permite al personal de producción y operaciones administrar las aplicaciones web implementadas. El System.Web.Management espacio de nombres contiene los tipos de eventos de mantenimiento responsables de empaquetar los datos de estado de mantenimiento de la aplicación y los tipos de proveedor responsables de procesar estos datos. También contiene tipos auxiliares que ayudan durante la administración de eventos de mantenimiento.
La WebBaseEvent clase es la raíz del árbol de herencia para todos los tipos de eventos de supervisión de estado ASP.NET. Usa la WebApplicationInformation clase para obtener información de la aplicación que está disponible para su clase derivada.
Nota
En la mayoría de los casos, podrá usar los tipos de supervisión de estado ASP.NET tal como se implementa, y controlará el sistema de supervisión de estado especificando valores en la <healthMonitoring>
sección de configuración. También puede derivar de los tipos de supervisión de estado para crear sus propios eventos y proveedores personalizados. Para obtener un ejemplo de derivación de la WebBaseEvent clase , vea el ejemplo proporcionado en este tema.
Notas a los desarrolladores de herederos
Al dar formato a la información de eventos personalizada para mostrar, invalide el FormatCustomEventDetails(WebEventFormatter) método en lugar del ToString método . Esto evitará sobrescribir o alterar la información confidencial del sistema.
El código de evento que especifique para el evento personalizado debe ser mayor que WebExtendedBase.
Constructores
WebBaseEvent(String, Object, Int32) |
Inicializa una nueva instancia de la clase WebBaseEvent mediante los parámetros proporcionados. |
WebBaseEvent(String, Object, Int32, Int32) |
Inicializa una nueva instancia de la clase WebBaseEvent mediante los parámetros proporcionados. |
Propiedades
ApplicationInformation |
Obtiene un objeto WebApplicationInformation que contiene información sobre la aplicación que se está controlando. |
EventCode |
Obtiene el valor de código asociado al evento. |
EventDetailCode |
Obtiene el código de detalle de evento. |
EventID |
Obtiene el identificador asociado al evento. |
EventOccurrence |
Obtiene un contador que representa el número de veces que se ha producido el evento. |
EventSequence |
Obtiene el número de veces que la aplicación ha provocado el evento. |
EventSource |
Obtiene el objeto que provoca el evento. |
EventTime |
Obtiene la hora a la que se produjo el evento. |
EventTimeUtc |
Obtiene la hora a la que se produjo el evento. |
Message |
Obtiene el mensaje que describe el evento. |
Métodos
Equals(Object) |
Determina si el objeto especificado es igual que el objeto actual. (Heredado de Object) |
FormatCustomEventDetails(WebEventFormatter) |
Da un formato estándar a la información de eventos. |
GetHashCode() |
Sirve como la función hash predeterminada. (Heredado de Object) |
GetType() |
Obtiene el Type de la instancia actual. (Heredado de Object) |
IncrementPerfCounters() |
Se utiliza internamente para incrementar los contadores de rendimiento. |
MemberwiseClone() |
Crea una copia superficial del Object actual. (Heredado de Object) |
Raise() |
Provoca un evento mediante la notificación a cualquier proveedor configurado de que el evento se ha producido. |
Raise(WebBaseEvent) |
Provoca el evento especificado mediante la notificación a cualquier proveedor configurado de que el evento se ha producido. |
ToString() |
Aplica formato a información de evento para su presentación. |
ToString(Boolean, Boolean) |
Aplica formato a información de evento para su presentación. |