WebApplicationInformation Class
Definition
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.
Provides information associated with health events.
public ref class WebApplicationInformation sealedpublic sealed class WebApplicationInformationtype WebApplicationInformation = classPublic NotInheritable Class WebApplicationInformation- Inheritance
-
WebApplicationInformation
Examples
The following code example has two parts. The first part is an excerpt of the configuration file that enables ASP.NET to use a custom event. The second shows how to create that custom event by using the WebApplicationInformation class.
Ensure that your custom event is raised at the proper time, that is, when the equivalent system health event it replaces would be raised.
<healthMonitoring
enabled="true" heartBeatInterval="0">
<eventMappings>
<add name="SampleApplicationInformation"
type="SamplesAspNet.SampleWebApplicationInformation, webapplicationinformation, Version=1.0.1585.27289, Culture=neutral, PublicKeyToken=3648e5c763a8239f, processorArchitecture=MSIL"/>
</eventMappings>
<rules>
<add name="Custom Application Information"
eventName="SampleApplicationInformation"
provider="EventLogProvider"
profile="Default"/>
</rules>
</healthMonitoring>
using System;
using System.Text;
using System.Web;
using System.Web.Management;
namespace SamplesAspNet
{
// Implements a custom WebBaseEvent that uses
// WebApplicationInformation.
public class SampleWebApplicationInformation :
WebBaseEvent
{
private StringBuilder eventInfo;
// Instantiate SampleWebGet
public SampleWebApplicationInformation(string msg,
object eventSource, int eventCode):
base(msg, eventSource, eventCode)
{
// Perform custom initialization.
eventInfo = new StringBuilder();
eventInfo.Append(string.Format(
"Event created at: {0}",
EventTime.ToString()));
}
// Raises the event.
public override void Raise()
{
// Perform custom processing.
eventInfo.Append(string.Format(
"Event raised at: {0}",
EventTime.ToString()));
// Raise the event.
base.Raise();
}
public string GetApplicationDomain()
{
// Get the name of the application domain.
return (string.Format(
"Application domain: {0}",
ApplicationInformation.ApplicationDomain));
}
public string GetApplicationPath()
{
// Get the name of the application path.
return (string.Format(
"Application path: {0}",
ApplicationInformation.ApplicationPath));
}
public string GetApplicationVirtualPath()
{
// Get the name of the application virtual path.
return (string.Format(
"Application virtual path: {0}",
ApplicationInformation.ApplicationVirtualPath));
}
public string GetApplicationMachineName()
{
// Get the name of the application machine name.
return (string.Format(
"Application machine name: {0}",
ApplicationInformation.MachineName));
}
public string GetApplicationTrustLevel()
{
// Get the name of the application trust level.
return (string.Format(
"Application trust level: {0}",
ApplicationInformation.TrustLevel));
}
//Formats Web request event information.
public override void FormatCustomEventDetails(
WebEventFormatter formatter)
{
base.FormatCustomEventDetails(formatter);
// Add custom data.
formatter.AppendLine("");
formatter.AppendLine(
"Custom Application Information:");
formatter.IndentationLevel += 1;
// Display the application information.
formatter.AppendLine(GetApplicationDomain());
formatter.AppendLine(GetApplicationPath());
formatter.AppendLine(GetApplicationVirtualPath());
formatter.AppendLine(GetApplicationMachineName());
formatter.AppendLine(GetApplicationTrustLevel());
formatter.IndentationLevel -= 1;
formatter.AppendLine(eventInfo.ToString());
}
}
}
Imports System.Text
Imports System.Web
Imports System.Web.Management
'Implements a custom WebBaseEvent that uses
' WebApplicationInformation.
Public Class SampleWebApplicationInformation
Inherits WebBaseEvent
Private eventInfo As StringBuilder
' Instantiate SampleWebGet
Public Sub New(ByVal msg As String, _
ByVal eventSource As Object, _
ByVal eventCode As Integer)
MyBase.New(msg, eventSource, eventCode)
' Perform custom initialization.
eventInfo = New StringBuilder()
eventInfo.Append(String.Format( _
"Event created at: {0}", EventTime.ToString()))
End Sub
' Raises the event.
Public Overrides Sub Raise()
' Perform custom processing.
eventInfo.Append(String.Format( _
"Event raised at: {0}", EventTime.ToString()))
' Raise the event.
MyBase.Raise()
End Sub
Public Function GetApplicationDomain() As String
' Get the name of the application domain.
Return String.Format( _
"Application domain: {0}", _
ApplicationInformation.ApplicationDomain)
End Function 'GetApplicationDomain
Public Function GetApplicationPath() As String
' Get the name of the application path.
Return String.Format( _
"Application path: {0}", _
ApplicationInformation.ApplicationPath())
End Function 'GetApplicationPath
Public Function GetApplicationVirtualPath() As String
' Get the name of the application virtual path.
Return String.Format( _
"Application virtual path: {0}", _
ApplicationInformation.ApplicationVirtualPath())
End Function 'GetApplicationVirtualPath
Public Function GetApplicationMachineName() As String
' Get the name of the application machine name.
Return String.Format( _
"Application machine name: {0}", _
ApplicationInformation.MachineName())
End Function 'GetApplicationMachineName
Public Function GetApplicationTrustLevel() As String
' Get the name of the application trust level.
Return String.Format( _
"Application trust level: {0}", _
ApplicationInformation.TrustLevel())
End Function 'GetApplicationTrustLevel
'Formats Web request event information.
Public Overrides Sub FormatCustomEventDetails( _
_
ByVal formatter As WebEventFormatter)
MyBase.FormatCustomEventDetails(formatter)
' Add custom data.
formatter.AppendLine( _
"Custom Application Information:")
formatter.IndentationLevel += 1
' Display the application information.
formatter.AppendLine(GetApplicationDomain())
formatter.AppendLine(GetApplicationPath())
formatter.AppendLine(GetApplicationVirtualPath())
formatter.AppendLine(GetApplicationMachineName())
formatter.AppendLine(GetApplicationTrustLevel())
formatter.IndentationLevel -= 1
formatter.AppendLine(eventInfo.ToString())
End Sub
End Class
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.
Instances of the WebApplicationInformation class contain information that is obtained using any of the types derived from the WebManagementEvent type.
Your application needs the appropriate permissions to access protected information provided by this type.
The following is an excerpt of a configuration file you could use to enable ASP.NET to log error events that contain application information.
<healthMonitoring
enabled="true" heartBeatInterval="0">
<rules>
<add
name="All Errors Default"
eventName="All Errors"
provider="EventLogProvider"
profile="Default"
minInterval="00:01:00" />
</rules>
</healthMonitoring>
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 creating a custom event class, see the example provided in this topic.
Properties
| ApplicationDomain |
Gets the current application domain name. |
| ApplicationPath |
Gets the application physical path. |
| ApplicationVirtualPath |
Gets the application logical path. |
| MachineName |
Gets the application machine name. |
| TrustLevel |
Gets the application trust level. |
Methods
| Equals(Object) |
Determines whether the specified object is equal to the current object. (Inherited from Object) |
| FormatToString(WebEventFormatter) |
Formats the application information. |
| GetHashCode() |
Serves as the default hash function. (Inherited from Object) |
| GetType() |
Gets the Type of the current instance. (Inherited from Object) |
| MemberwiseClone() |
Creates a shallow copy of the current Object. (Inherited from Object) |
| ToString() |
Formats event information for display purposes. |
