WebApplicationLifetimeEvent Class

Reference

Definition

Namespace:: System.Web.Management

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents a significant event in the lifetime of an application.

public ref class WebApplicationLifetimeEvent : System::Web::Management::WebManagementEvent

public class WebApplicationLifetimeEvent : System.Web.Management.WebManagementEvent

type WebApplicationLifetimeEvent = class
    inherit WebManagementEvent

Public Class WebApplicationLifetimeEvent
Inherits WebManagementEvent

Inheritance: Object

WebBaseEvent

WebManagementEvent
WebApplicationLifetimeEvent

Examples

The following code example shows how to derive from the WebApplicationLifetimeEvent class to create a custom event.


using System;
using System.Text;
using System.Web;
using System.Web.Management;

namespace SamplesAspNet
{
  // Implements a custom WebManagementEvent class. 
    public class SampleWebApplicationLifetimeEvent :
        System.Web.Management.WebApplicationLifetimeEvent
    {
        private string customCreatedMsg, customRaisedMsg;

        // Invoked in case of events identified only by 
        // their event code.
        public SampleWebApplicationLifetimeEvent(string msg, 
            object eventSource, int eventCode):
          base(msg, eventSource, eventCode)
        {
            // Perform custom initialization.
            customCreatedMsg =
            string.Format("Event created at: {0}",
            DateTime.Now.TimeOfDay.ToString());
        }

        // Invoked in case of events identified by their 
        // event code.and related event detailed code.
        public SampleWebApplicationLifetimeEvent(string msg, 
            object eventSource, int eventCode, 
            int eventDetailCode):
          base(msg, eventSource, eventCode, eventDetailCode)
        {
            // Perform custom initialization.
            customCreatedMsg =
             string.Format("Event created at: {0}",
             DateTime.Now.TimeOfDay.ToString());
        }


        // Raises the SampleWebRequestEvent.
        public override void Raise()
        {
            // Perform custom processing. 
            customRaisedMsg = string.Format(
                "Event raised at: {0}\n", 
                DateTime.Now.TimeOfDay.ToString());
            // Raise the event.
            base.Raise();
        }

        //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(
                 "*SampleWebApplicationLifetimeEvent Start *");
            formatter.AppendLine("Custom information goes here");
            formatter.AppendLine(
                "* SampleWebApplicationLifetimeEvent End *");
            // Display custom event timing.
            formatter.AppendLine(customCreatedMsg);
            formatter.AppendLine(customRaisedMsg);
        
            formatter.IndentationLevel -= 1;
        }
    }
}

Imports System.Text
Imports System.Web
Imports System.Web.Management


' Implements a custom WebManagementEvent class. 

Public Class SampleWebApplicationLifetimeEvent
    Inherits System.Web.Management.WebApplicationLifetimeEvent
    Private customCreatedMsg, customRaisedMsg As String
    
    ' 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 SampleWebRequestEvent.
    Public Overrides Sub Raise() 
        ' Perform custom processing. 
        customRaisedMsg = _
        String.Format("Event raised at: {0}" + _
        vbLf, DateTime.Now.TimeOfDay.ToString())
        ' Raise the event.
        MyBase.Raise()
    
    End Sub
    
    '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( _
        "*SampleWebApplicationLifetimeEvent Start *")
        formatter.AppendLine("Custom information goes here")
        formatter.AppendLine( _
        "* SampleWebApplicationLifetimeEvent End *")
        ' Display custom event timing.
        formatter.AppendLine(customCreatedMsg)
        formatter.AppendLine(customRaisedMsg)

        formatter.IndentationLevel -= 1

    End Sub
End Class

The following configuration-file excerpt shows how to configure the healthMonitoring section of a configuration file to add the SampleWebApplicationLifetimeEvent code defined above to the ASP.NET health-monitoring system. To add the event to the system, you must define the event by adding a new entry to the eventMappings section and map the event to a provider by adding a new entry to the rules section.

<healthMonitoring  
  enabled="true"  
  heartBeatInterval="0">  

    <eventMappings>  
       <clear />  
       <!-- Configure the application lifetime event -->  
       <!-- object to handle the Web application events. -->  
       <add name="SampleApplicationLifetimeEvents"  
         type="System.Web.Management.SampleWebApplicationLifetimeEvent,  
         System.Web,Version=2.0.3600.0,  
         Culture=neutral,PublicKeyToken=b03f5f7f11d50a3a" />  
     </eventMappings>  

    <rules>  
      <clear/>  
       // Configure the connection between the   
       // application lifetime event object   
       // and the provider that must process it.  
       <add name="Custom Application Events"  
         eventName="SampleApplicationLifetimeEvents"  
         provider="EventLogProvider"  
         profile="Default"  
         minInterval="00:01:00" />  
    </rules>  

</healthMonitoring>

Remarks

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.

Application lifetime events include events such as application startup and shutdown events. If an application is terminated, you can determine why by viewing the related event message field.

When a WebApplicationLifetimeEvent instance occurs, ASP.NET health monitoring updates the Application Lifetime Events performance counter. You can log these events by adding the WebApplicationLifetimeEvent object to the rules subsection of the healthMonitoring section of the configuration file, as shown in the following example.

<rules>  
  <add name="Application Events"  
    eventName="Application Lifetime Events"  
    provider="EventLogProvider"  
    profile="Default"  
    minInterval="00:01:00" />  
</rules>

The Application Lifetime Events performance counter contains the sum total of all ASP.NET lifetime events. To view this performance counter in System Monitor (PerfMon), in the Add Counters window select ASP.NET from the Performance object drop-down list. Select the Application Lifetime Events performance counter, and click the Add button. For more information, see "Using the System Monitor (PerfMon) with ASP.NET Applications" on MSDN. If you allow events to be logged by the standard EventLogWebEventProvider, you can view them in Event Viewer by selecting the Application log.

Caution

Because the WebApplicationLifetimeEvent object is a high-volume event, logging it is resource-intensive and might slow down your system. It can also cause other events to be overwritten in the case of the EventLogWebEventProvider class due to the high volume of events and the way the event logging works.

Note

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

Notes to Inheritors

When formatting 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.

Constructors

WebApplicationLifetimeEvent(String, Object, Int32, Int32)	Initializes the WebApplicationLifetimeEvent class using the supplied parameters.
WebApplicationLifetimeEvent(String, Object, Int32)	Initializes the WebApplicationLifetimeEvent class using the supplied parameters.

Properties

EventCode	Gets the code value associated with the event. (Inherited from WebBaseEvent)
EventDetailCode	Gets the event detail code. (Inherited from WebBaseEvent)
EventID	Gets the identifier associated with the event. (Inherited from WebBaseEvent)
EventOccurrence	Gets a counter that represents the number of times the event has occurred. (Inherited from WebBaseEvent)
EventSequence	Gets the number of times the event has been raised by the application. (Inherited from WebBaseEvent)
EventSource	Gets the object that raises the event. (Inherited from WebBaseEvent)
EventTime	Gets the time when the event was raised. (Inherited from WebBaseEvent)
EventTimeUtc	Gets the time when the event was raised. (Inherited from WebBaseEvent)
Message	Gets the message that describes the event. (Inherited from WebBaseEvent)
ProcessInformation	Gets information about the ASP.NET application-hosting process. (Inherited from WebManagementEvent)

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
FormatCustomEventDetails(WebEventFormatter)	Provides standard formatting of the event information. (Inherited from WebBaseEvent)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
IncrementPerfCounters()	Used internally to increment performance counters.
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
Raise()	Raises an event by notifying any configured provider that the event has occurred. (Inherited from WebBaseEvent)
ToString()	Formats event information for display purposes. (Inherited from WebBaseEvent)
ToString(Boolean, Boolean)	Formats event information for display purposes. (Inherited from WebBaseEvent)

Applies to

Jaa