WebBaseEvent Klasse
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Definiert die Basisklasse für die ASP.NET-Systemüberwachungsereignisse.
public ref class WebBaseEvent
public class WebBaseEvent
type WebBaseEvent = class
Public Class WebBaseEvent
- Vererbung
-
WebBaseEvent
- Abgeleitet
Beispiele
Das folgende Beispiel zeigt, wie Sie von der WebBaseEvent -Klasse ableiten, um ein benutzerdefiniertes Integritätsüberwachungsereignis zu erstellen.
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
Das folgende Beispiel ist ein Auszug aus der Konfigurationsdatei, mit dem ASP.NET das benutzerdefinierte Ereignis verwenden können.
<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>
Hinweise
ASP.NET Integritätsüberwachung ermöglicht es Produktions- und Betriebsmitarbeitern, bereitgestellte Webanwendungen zu verwalten. Der System.Web.Management Namespace enthält die Integritätsereignistypen, die für das Verpacken von Anwendungsintegritätsdaten status und die Anbietertypen, die für die Verarbeitung dieser Daten verantwortlich sind. Es enthält auch unterstützende Typen, die bei der Verwaltung von Integritätsereignissen helfen.
Die WebBaseEvent -Klasse ist der Stamm der Vererbungsstruktur für alle ASP.NET-Integritätsüberwachungsereignistypen. Sie verwendet die WebApplicationInformation -Klasse, um Anwendungsinformationen abzurufen, die für die abgeleitete Klasse verfügbar sind.
Hinweis
In den meisten Fällen können Sie die ASP.NET Integritätsüberwachungstypen wie implementiert verwenden, und Sie steuern das System zur Integritätsüberwachung, indem Sie Werte im <healthMonitoring>
Konfigurationsabschnitt angeben. Sie können auch von den Integritätsüberwachungstypen ableiten, um Ihre eigenen benutzerdefinierten Ereignisse und Anbieter zu erstellen. Ein Beispiel für die Ableitung von der WebBaseEvent -Klasse finden Sie im in diesem Thema bereitgestellten Beispiel.
Hinweise für Vererber
Wenn Sie Ihre benutzerdefinierten Ereignisinformationen für die Anzeige formatieren, überschreiben Sie die FormatCustomEventDetails(WebEventFormatter) -Methode und nicht die ToString -Methode. Dadurch wird vermieden, dass vertrauliche Systeminformationen überschrieben oder manipuliert werden.
Der Ereigniscode, den Sie für Ihr benutzerdefiniertes Ereignis angeben, muss größer als WebExtendedBasesein.
Konstruktoren
WebBaseEvent(String, Object, Int32) |
Initialisiert eine neue Instanz der WebBaseEvent-Klasse mit den bereitgestellten Parametern. |
WebBaseEvent(String, Object, Int32, Int32) |
Initialisiert eine neue Instanz der WebBaseEvent-Klasse mit den bereitgestellten Parametern. |
Eigenschaften
ApplicationInformation |
Ruft ein WebApplicationInformation-Objekt ab, das Informationen über die aktuelle Anwendung enthält, die überwacht wird. |
EventCode |
Ruft den Codewert ab, der dem Ereignis zugeordnet ist. |
EventDetailCode |
Ruft den Ereignisdetailcode ab. |
EventID |
Ruft den dem Ereignis zugeordneten Bezeichner ab. |
EventOccurrence |
Ruft einen Zähler ab, der die Häufigkeit darstellt, mit der das Ereignis eingetreten ist. |
EventSequence |
Ruft die Häufigkeit ab, mit der das Ereignis von der Anwendung ausgelöst wurde. |
EventSource |
Ruft das Objekt ab, das das Ereignis auslöst. |
EventTime |
Ruft die Uhrzeit ab, zu der das Ereignis ausgelöst wurde. |
EventTimeUtc |
Ruft die Uhrzeit ab, zu der das Ereignis ausgelöst wurde. |
Message |
Ruft die Meldung ab, in der das Ereignis beschrieben wird. |
Methoden
Equals(Object) |
Bestimmt, ob das angegebene Objekt gleich dem aktuellen Objekt ist. (Geerbt von Object) |
FormatCustomEventDetails(WebEventFormatter) |
Stellt Standardformatierung der Ereignisinformationen bereit. |
GetHashCode() |
Fungiert als Standardhashfunktion. (Geerbt von Object) |
GetType() |
Ruft den Type der aktuellen Instanz ab. (Geerbt von Object) |
IncrementPerfCounters() |
Wird intern zum Inkrementieren der Leistungsindikatoren verwendet. |
MemberwiseClone() |
Erstellt eine flache Kopie des aktuellen Object. (Geerbt von Object) |
Raise() |
Löst ein Ereignis aus, indem ein konfigurierter Anbieter benachrichtigt wird, dass das Ereignis eingetreten ist. |
Raise(WebBaseEvent) |
Löst das angegebene Ereignis aus, indem ein konfigurierter Anbieter benachrichtigt wird, dass das Ereignis eingetreten ist. |
ToString() |
Formatiert Ereignisinformationen für die Anzeige. |
ToString(Boolean, Boolean) |
Formatiert Ereignisinformationen für die Anzeige. |