WebSuccessAuditEvent Class

WebSuccessAuditEvent Class

 

Provides information about successful security events.

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


public class WebSuccessAuditEvent : WebAuditEvent

NameDescription
System_CAPS_protmethodWebSuccessAuditEvent(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 WebSuccessAuditEvent class using the supplied parameters.

System_CAPS_protmethodWebSuccessAuditEvent(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 WebSuccessAuditEvent class using the supplied parameters.

NameDescription
System_CAPS_pubpropertyEventCode

Gets the code value associated with the event.(Inherited from WebBaseEvent.)

System_CAPS_pubpropertyEventDetailCode

Gets the event detail code.(Inherited from WebBaseEvent.)

System_CAPS_pubpropertyEventID

Gets the identifier associated with the event.(Inherited from WebBaseEvent.)

System_CAPS_pubpropertyEventOccurrence

Gets a counter that represents the number of times the event has occurred.(Inherited from WebBaseEvent.)

System_CAPS_pubpropertyEventSequence

Gets the number of times the event has been raised by the application.(Inherited from WebBaseEvent.)

System_CAPS_pubpropertyEventSource

Gets the object that raises the event.(Inherited from WebBaseEvent.)

System_CAPS_pubpropertyEventTime

Gets the time when the event was raised.(Inherited from WebBaseEvent.)

System_CAPS_pubpropertyEventTimeUtc

Gets the time when the event was raised.(Inherited from WebBaseEvent.)

System_CAPS_pubpropertyMessage

Gets the message that describes the event.(Inherited from WebBaseEvent.)

System_CAPS_pubpropertyProcessInformation

Gets information about the ASP.NET application-hosting process.(Inherited from WebManagementEvent.)

System_CAPS_pubpropertyRequestInformation

Get the information associated with the Web request.(Inherited from WebAuditEvent.)

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodFormatCustomEventDetails(WebEventFormatter)

Provides standard formatting of the event information.(Inherited from WebBaseEvent.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodIncrementPerfCounters()

This API supports the product infrastructure and is not intended to be used directly from your code. Increments the Audit Success Events Raised performance counter.(Overrides WebBaseEvent.IncrementPerfCounters().)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodRaise()

Raises an event by notifying any configured provider that the event has occurred.(Inherited from WebBaseEvent.)

System_CAPS_pubmethodToString()

Formats event information for display purposes.(Inherited from WebBaseEvent.)

System_CAPS_pubmethodToString(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 WebSuccessAuditEvent class is used when a successful security-related operation occurs. An example of this is a successful URL authorization for a Web request.

The following list describes the features for which events of type WebSuccessAuditEvent are raised by ASP.NET:

When a WebSuccessAuditEvent is raised, ASP.NET health monitoring increments the related Audit Success Events Raised performance counter and then checks the healthMonitoring configuration to determine whether any providers subscribe to the event. If providers subscribe to the event, ASP.NET dispatches the event to them for processing.

System_CAPS_noteNote

To view the Audit Success Event Raised performance counter in System Monitor (PerfMon), in the Add Counters window select ASP.NET from the Performance object drop-down list, select the Audit Success Event Raised performance counter, and click the Add button. For more information, see Monitoring ASP.NET Application Performance.

Because success audits represent an expected condition, you may not want to subscribe to them. You can subscribe to them in order to provide access auditing for the site.

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

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


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

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


        // Invoked in case of events identified only by their event code.
        public SampleWebSuccessAuditEvent(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 
        // event detailed code.
        public SampleWebSuccessAuditEvent(string msg, object eventSource,
            int eventCode, int detailedCode)
            :
        base(msg, eventSource, eventCode, detailedCode)
        {
            // Perform custom initialization.
            customCreatedMsg =
            string.Format("Event created at: {0}",
                DateTime.Now.TimeOfDay.ToString());
        }



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

            // Raise the event.
            WebBaseEvent.Raise(this);
        }


        // Obtains the current thread information.
        public WebRequestInformation GetRequestInformation()
        {
            // No customization allowed.
            return RequestInformation;
        }


        //Formats Web request event information.
        //This method is invoked indirectly by the provider using one of the
        //overloaded ToString methods.
        public override void FormatCustomEventDetails(WebEventFormatter formatter)
        {
            base.FormatCustomEventDetails(formatter);

            // Add custom data.
            formatter.AppendLine("");


            formatter.IndentationLevel += 1;
            formatter.AppendLine(
                "******** SampleWebSuccessAuditEvent Start ********");
            formatter.AppendLine(string.Format("Request path: {0}",
                RequestInformation.RequestPath));
            formatter.AppendLine(string.Format("Request Url: {0}",
                RequestInformation.RequestUrl));

            // Display custom event timing.
            formatter.AppendLine(customCreatedMsg);
            formatter.AppendLine(customRaisedMsg);

            formatter.AppendLine(
                "******** SampleWebSuccessAuditEvent End ********");

            formatter.IndentationLevel -= 1;

        }
    }

}

The following example is an excerpt of the configuration file that enables ASP.NET health monitoring 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="SampleWebSuccessAuditEvent" 
      type="SamplesAspNet.SampleWebSuccessAuditEvent,
      websuccessauditevent,Version=1.0.1663.31140, 
      Culture=neutral, 
      PublicKeyToken=0d1fa0f69d94de96, 
      processorArchitecture=MSIL"/>
  </eventMappings>
  <rules>
    <add name="Custom Failure Audit Default"
      eventName=" SampleWebFailureAuditEvent "
      provider="EventLogProvider"
      profile="Default"/>  
  </rules>
</healthMonitoring>

.NET Framework
Available since 2.0

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

Return to top
Show:
© 2016 Microsoft