WebAuditEvent Class

.NET Framework (current version)

Serves as the base class for all ASP.NET health-monitoring audit events.

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

Inheritance Hierarchy

System.Object
System.Web.Management.WebBaseEvent
System.Web.Management.WebManagementEvent
System.Web.Management.WebAuditEvent
System.Web.Management.WebFailureAuditEvent
System.Web.Management.WebSuccessAuditEvent

Syntax

C++

type WebAuditEvent = 
    class
        inherit WebManagementEvent
    end

Constructors

	Name	Description
	WebAuditEvent(String, Object, Int32)	This API supports the product infrastructure and is not intended to be used directly from your code. Initializes a new instance of the WebAuditEvent class using the supplied parameters.
	WebAuditEvent(String, Object, Int32, Int32)	This API supports the product infrastructure and is not intended to be used directly from your code. Initializes a new instance of the WebAuditEvent class with specified event parameters.

Properties

	Name	Description
	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.)
	RequestInformation	Get the information associated with the Web request.

Methods

	Name	Description
	Equals(Object)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	Finalize()	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(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()	This API supports the product infrastructure and is not intended to be used directly from your code. Used internally to increment performance counters.(Inherited from WebBaseEvent.)
	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.)

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 WebAuditEvent class is the base class from which the ASP.NET health-monitoring audit-event classes derive. The audit events generate information about security-related operations in a Web application and provide both a success and failure event for each audited operation.

The health-monitoring system can audit both successful and unsuccessful events, which means an application can be monitored for both normal and malfunctioning conditions. By default, only the failure audit events are recorded.

The following operations are audited by ASP.NET, and may generate success-or-failure health-monitoring audit events:

Login attempts made by users of an ASP.NET application. For more details about this auditing, see WebAuthenticationSuccessAuditEvent and WebSuccessAuditEvent.
Security-related events, such as authentication failures, failed resource access attempts, and other security-related events. The log of these events can be useful when investigating an intrusion or attack on the application. By default, no auditing support is provided for authorization failures of anonymous users. For more details about failure event audits, see WebAuthenticationFailureAuditEvent and WebFailureAuditEvent.
Custom events raised by an ASP.NET application. You can audit custom events by extending the functionality provided by the WebAuditEvent class and derived classes

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

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

Notes to Inheritors:

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

Examples

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

No code example is currently available or this language may not be supported.

The following is an excerpt of the configuration file that enables ASP.NET to use the event.

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

  <providers>
    <add name="EventLogProvider" 
      type="System.Web.Management.EventLogWebEventProvider,
      System.Web,Version=2.0.3600.0,Culture=neutral,
      PublicKeyToken=b03f5f7f11d50a3a"/>
  </providers>

  <eventMappings>
    <add  name="SampleWebAuditEvent" 
      type="SamplesAspNet.SampleWebAuditEvent,
      webauditevent,Version=1.0.1663.31140, 
      Culture=neutral, 
      PublicKeyToken=0d1fa0f69d94de96, 
      processorArchitecture=MSIL"/>
  </eventMappings>

  <rules>
    <add name="Custom Audit Default"
      eventName="SampleWebAuditEvent"
      provider="EventLogProvider"
      profile="Default"/>  
  </rules>

</healthMonitoring>

Version Information

.NET Framework
Available since 2.0

Thread Safety

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