WebBaseEvent 类

定义

为 ASP.NET 运行状况监视事件定义基类。Defines the base class for the ASP.NET health-monitoring events.

public ref class WebBaseEvent
public class WebBaseEvent
type WebBaseEvent = class
Public Class WebBaseEvent
继承
WebBaseEvent
派生

示例

下面的示例演示如何从 WebBaseEvent 类派生,以创建自定义运行状况监视事件。The following example shows how to derive from the WebBaseEvent class to create a custom health-monitoring event.


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

下面的示例摘自配置文件,该文件使 ASP.NET 能够使用自定义事件。The following example is an excerpt of the configuration file that enables ASP.NET to use the custom event.

<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>  

注解

ASP.NET health monitoring 允许生产和运营人员管理已部署的 Web 应用程序。ASP.NET health monitoring allows production and operations staff to manage deployed Web applications. System.Web.Management命名空间包含的运行状况事件类型负责打包应用程序运行状况数据,以及负责处理此数据的提供程序类型。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.

WebBaseEvent类是所有 ASP.NET health 监视事件类型的继承树的根。The WebBaseEvent class is the root of the inheritance tree for all the ASP.NET health-monitoring event types. 它使用 WebApplicationInformation 类来获取可用于其派生类的应用程序信息。It uses the WebApplicationInformation class to obtain application information that is available to its derived class.

备注

在大多数情况下,你将能够使用已实现的 ASP.NET health 监视类型,并且将通过在 "配置" 部分中指定值来控制运行状况监视系统 <healthMonitoring>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. 有关从类派生的示例 WebBaseEvent ,请参阅本主题中提供的示例。For an example of deriving from the WebBaseEvent class, see the example provided in this topic.

继承者说明

在设置自定义事件信息的显示格式时,请重写 FormatCustomEventDetails(WebEventFormatter) 方法而不是 ToString 方法。When you format your custom event information for display, override the FormatCustomEventDetails(WebEventFormatter) method rather than the ToString method. 这将避免覆盖或篡改敏感系统信息。This will avoid overwriting or tampering with sensitive system information.

为自定义事件指定的事件代码必须大于 WebExtendedBaseThe event code you specify for your custom event must be greater than WebExtendedBase.

构造函数

WebBaseEvent(String, Object, Int32)

使用所提供的参数初始化 WebBaseEvent 类的新实例。Initializes a new instance of the WebBaseEvent class using the supplied parameters.

WebBaseEvent(String, Object, Int32, Int32)

使用所提供的参数初始化 WebBaseEvent 类的新实例。Initializes a new instance of the WebBaseEvent class using the supplied parameters.

属性

ApplicationInformation

获取一个 WebApplicationInformation 对象,该对象包含有关当前正在监视的应用程序的信息。Gets a WebApplicationInformation object that contains information about the current application being monitored.

EventCode

获取与该事件关联的代码值。Gets the code value associated with the event.

EventDetailCode

获取事件详细信息代码。Gets the event detail code.

EventID

获取与事件关联的标识符。Gets the identifier associated with the event.

EventOccurrence

获取表示事件发生次数的计数器。Gets a counter that represents the number of times the event has occurred.

EventSequence

获取应用程序已引发事件的次数。Gets the number of times the event has been raised by the application.

EventSource

获取引发事件的对象。Gets the object that raises the event.

EventTime

获取引发事件的时间。Gets the time when the event was raised.

EventTimeUtc

获取引发事件的时间。Gets the time when the event was raised.

Message

获取描述事件的消息。Gets the message that describes the event.

方法

Equals(Object)

确定指定对象是否等于当前对象。Determines whether the specified object is equal to the current object.

(继承自 Object)
FormatCustomEventDetails(WebEventFormatter)

提供事件信息的标准格式设置。Provides standard formatting of the event information.

GetHashCode()

作为默认哈希函数。Serves as the default hash function.

(继承自 Object)
GetType()

获取当前实例的 TypeGets the Type of the current instance.

(继承自 Object)
IncrementPerfCounters()

在内部使用,用于递增性能计数器。Used internally to increment performance counters.

MemberwiseClone()

创建当前 Object 的浅表副本。Creates a shallow copy of the current Object.

(继承自 Object)
Raise()

通过将事件已发生这一情况通知任何已配置的提供程序来引发事件。Raises an event by notifying any configured provider that the event has occurred.

Raise(WebBaseEvent)

通过将事件已发生这一情况通知任何已配置的提供程序来引发指定的事件。Raises the specified event by notifying any configured provider that the event has occurred.

ToString()

为显示而对事件信息进行格式化。Formats event information for display purposes.

ToString(Boolean, Boolean)

为显示而对事件信息进行格式化。Formats event information for display purposes.

适用于