WebBaseEvent Classe
Definizione
Importante
Alcune informazioni sono relative alla release non definitiva del prodotto, che potrebbe subire modifiche significative prima della release definitiva. Microsoft non riconosce alcuna garanzia, espressa o implicita, in merito alle informazioni qui fornite.
Definisce la classe base per gli eventi di monitoraggio dello stato di ASP.NET.
public ref class WebBaseEvent
public class WebBaseEvent
type WebBaseEvent = class
Public Class WebBaseEvent
- Ereditarietà
-
WebBaseEvent
- Derivato
Esempio
Nell'esempio seguente viene illustrato come derivare dalla classe per creare un evento di monitoraggio dell'integrità WebBaseEvent personalizzato.
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
L'esempio seguente è un estratto del file di configurazione che consente ASP.NET di usare l'evento personalizzato.
<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>
Commenti
ASP.NET monitoraggio dell'integrità consente al personale di produzione e operazioni di gestire le applicazioni Web distribuite. Lo System.Web.Management spazio dei nomi contiene i tipi di evento di integrità responsabili della creazione di pacchetti di dati relativi allo stato dell'integrità dell'applicazione e i tipi di provider responsabili dell'elaborazione di questi dati. Contiene anche tipi di supporto che consentono durante la gestione degli eventi di integrità.
La WebBaseEvent classe è la radice dell'albero di ereditarietà per tutti i tipi di eventi di monitoraggio dell'integrità ASP.NET. Usa la WebApplicationInformation classe per ottenere informazioni sull'applicazione disponibili per la classe derivata.
Nota
Nella maggior parte dei casi sarà possibile usare i tipi di monitoraggio dell'integrità ASP.NET come implementato e si controlla il sistema di monitoraggio dell'integrità specificando i valori nella <healthMonitoring>
sezione di configurazione. È anche possibile derivare dai tipi di monitoraggio dell'integrità per creare eventi e provider personalizzati. Per un esempio di derivazione dalla classe, vedere l'esempio WebBaseEvent fornito in questo argomento.
Note per gli eredi
Quando si formattano le informazioni sull'evento personalizzato per la visualizzazione, eseguire l'override del FormatCustomEventDetails(WebEventFormatter) metodo anziché del ToString metodo. In questo modo si evita di sovrascrivere o manomettere le informazioni di sistema sensibili.
Il codice evento specificato per l'evento personalizzato deve essere maggiore di WebExtendedBase.
Costruttori
WebBaseEvent(String, Object, Int32, Int32) |
Inizializza una nuova istanza della classe WebBaseEvent utilizzando i parametri forniti. |
WebBaseEvent(String, Object, Int32) |
Inizializza una nuova istanza della classe WebBaseEvent utilizzando i parametri forniti. |
Proprietà
ApplicationInformation |
Ottiene un oggetto WebApplicationInformation contenente informazioni sull'applicazione corrente monitorata. |
EventCode |
Ottiene il valore di codice associato all'evento. |
EventDetailCode |
Ottiene il codice dettagliato dell'evento. |
EventID |
Ottiene l'identificatore associato all'evento. |
EventOccurrence |
Ottiene un contatore che rappresenta il numero di occorrenze dell'evento. |
EventSequence |
Ottiene il numero di volte in cui l'evento è stato generato dall'applicazione. |
EventSource |
Ottiene l'oggetto che genera l'evento. |
EventTime |
Ottiene la data e l'ora in cui è stato generato l'evento. |
EventTimeUtc |
Ottiene la data e l'ora in cui è stato generato l'evento. |
Message |
Ottiene il messaggio nel quale è descritto l'evento. |
Metodi
Equals(Object) |
Determina se l'oggetto specificato è uguale all'oggetto corrente. (Ereditato da Object) |
FormatCustomEventDetails(WebEventFormatter) |
Fornisce una formattazione standard delle informazioni relative all'evento. |
GetHashCode() |
Funge da funzione hash predefinita. (Ereditato da Object) |
GetType() |
Ottiene l'oggetto Type dell'istanza corrente. (Ereditato da Object) |
IncrementPerfCounters() |
Utilizzato internamente per incrementare i contatori delle prestazioni. |
MemberwiseClone() |
Crea una copia superficiale dell'oggetto Object corrente. (Ereditato da Object) |
Raise() |
Genera un evento notificando a qualsiasi provider configurato che l'evento si è verificato. |
Raise(WebBaseEvent) |
Genera l'evento specificato notificando a qualsiasi provider configurato che l'evento si è verificato. |
ToString() |
Formatta le informazioni relative all'evento ai fini della visualizzazione. |
ToString(Boolean, Boolean) |
Formatta le informazioni relative all'evento ai fini della visualizzazione. |