Export (0) Print
Expand All

WebBaseEvent Class

Defines the base class for the ASP.NET health-monitoring events.

Namespace:  System.Web.Management
Assembly:  System.Web (in System.Web.dll)

public class WebBaseEvent

The WebBaseEvent type exposes the following members.

  NameDescription
Protected methodWebBaseEvent(String, Object, Int32)Initializes a new instance of the WebBaseEvent class using the supplied parameters.
Protected methodWebBaseEvent(String, Object, Int32, Int32)Initializes a new instance of the WebBaseEvent class using the supplied parameters.
Top

  NameDescription
Public propertyStatic memberApplicationInformationGets a WebApplicationInformation object that contains information about the current application being monitored.
Public propertyEventCodeGets the code value associated with the event.
Public propertyEventDetailCodeGets the event detail code.
Public propertyEventIDGets the identifier associated with the event.
Public propertyEventOccurrenceGets a counter that represents the number of times the event has occurred.
Public propertyEventSequenceGets the number of times the event has been raised by the application.
Public propertyEventSourceGets the object that raises the event.
Public propertyEventTimeGets the time when the event was raised.
Public propertyEventTimeUtcGets the time when the event was raised.
Public propertyMessageGets the message that describes the event.
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodFormatCustomEventDetailsProvides standard formatting of the event information.
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodIncrementPerfCountersInfrastructure. Used internally to increment performance counters.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodRaise()Raises an event by notifying any configured provider that the event has occurred.
Public methodStatic memberRaise(WebBaseEvent)Raises the specified event by notifying any configured provider that the event has occurred.
Public methodToString()Formats event information for display purposes. (Overrides Object.ToString().)
Public methodToString(Boolean, Boolean)Formats event information for display purposes.
Top

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 WebBaseEvent class is the root of the inheritance tree for all the ASP.NET health-monitoring event types. It uses the WebApplicationInformation class to obtain application information that is available to its derived class.

NoteNote

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 WebBaseEvent class, see the example provided in this topic.

Notes to Inheritors

When you format your custom event information for display, override the FormatCustomEventDetails method rather than the ToString method. This will avoid overwriting or tampering with sensitive system information.

The event code you specify for your custom event must be greater than WebExtendedBase.

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;

        }

    }

}

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>

.NET Framework

Supported in: 4.5.3, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft