Table of Contents

Class EventLogProvider

Namespace
CMS.EventLog
Assembly
CMS.EventLog.dll

Provides basic operations with the event log.

[ProviderInterface(typeof(IEventLogInfoProvider))]
public class EventLogProvider : AbstractInfoProvider<EventLogInfo, EventLogProvider>, IInfoProvider, ICustomizableProvider, IBulkOperationProvider, IWebFarmProvider, IInfoValidator<EventLogInfo>, IInfoByGuidProvider<EventLogInfo>, IInfoByNameProvider<EventLogInfo>, IBulkInfoProvider<EventLogInfo>, IEventLogInfoProvider, IInfoProvider<EventLogInfo>, IInfoByIdProvider<EventLogInfo>
Inheritance
object
EventLogProvider
Implements
Inherited Members
Extension Methods

Constructors

EventLogProvider()

Initializes a new instance of the EventLogProvider class.

public EventLogProvider()

Properties

Errors

Counter of errors.

[Obsolete("Property was not intended for public use and will be removed in the next version.")]
[ObsoleteSince(28, 3)]
public static IPerformanceCounter Errors { get; }

Property Value

IPerformanceCounter

LogDocumentFieldChanges

Indicates if log should contain the changes to particular document document fields.

public static bool LogDocumentFieldChanges { get; set; }

Property Value

bool

LogFieldChanges

Indicates if log should contain the changes to particular fields.

public static bool LogFieldChanges { get; set; }

Property Value

bool

LoggingEnabled

Indicates if logging is enabled.

public static bool LoggingEnabled { get; set; }

Property Value

bool

Warnings

Counter of warnings.

[Obsolete("Property was not intended for public use and will be removed in the next version.")]
[ObsoleteSince(28, 3)]
public static IPerformanceCounter Warnings { get; }

Property Value

IPerformanceCounter

Methods

CanLogEvent(EventLogInfo, bool)

Returns true if the event can be logged

protected virtual bool CanLogEvent(EventLogInfo eventObject, bool logDirectly)

Parameters

eventObject EventLogInfo

Event object

logDirectly bool

Whether the event is being logged directly (meaning not using the thread worker).

Returns

bool

CannotLogEventInternal(Exception)

Executes when the event logging throws an error.

protected virtual void CannotLogEventInternal(Exception ex)

Parameters

ex Exception

Exception thrown upon problem with logging

ClearHashtables(bool)

Clears up hashtables of EventLogProvider.

protected override void ClearHashtables(bool logTasks)

Parameters

logTasks bool

If true, web farm tasks are logged

GetEventLogText(EventLogInfo)

Creates string representation of event log object.

public static string GetEventLogText(EventLogInfo eventLogInfo)

Parameters

eventLogInfo EventLogInfo

EventLogInfo object

Returns

string

GetEventLogTextInternal(EventLogInfo)

Creates string representation of event log object.

protected virtual string GetEventLogTextInternal(EventLogInfo eventLogInfo)

Parameters

eventLogInfo EventLogInfo

EventLogInfo object

Returns

string

GetExceptionLogMessage(Exception)

Gets complete log for exception with message and deep stack trace.

public static string GetExceptionLogMessage(Exception ex)

Parameters

ex Exception

Exception to log

Returns

string

GetExceptionLogMessageInternal(Exception)

Gets complete log for exception with message and deep stack trace.

protected virtual string GetExceptionLogMessageInternal(Exception ex)

Parameters

ex Exception

Exception to log

Returns

string

GetLogItems()

Gets the log items count.

[Obsolete("Method was not intended for public use and will be removed in the next version.")]
[ObsoleteSince(28, 2)]
public static int GetLogItems()

Returns

int

GetLogItemsInternal()

Returns the log items count.

[Obsolete("Method was not intended for public use and will be removed in the next version.")]
[ObsoleteSince(28, 2)]
protected virtual int GetLogItemsInternal()

Returns

int

Remarks

This method get item count straight from database without any caching.

GetLogSize()

Gets the log size.

public static int GetLogSize()

Returns

int

GetLogSizeInternal()

Gets the log size.

protected virtual int GetLogSizeInternal()

Returns

int

LogEvent(EventLogInfo)

Writes a new record to the event log.

public static EventLogInfo LogEvent(EventLogInfo eventObject)

Parameters

eventObject EventLogInfo

Event object.

Returns

EventLogInfo

LogEventInternal(EventLogInfo)

Writes a new record to the event log.

protected virtual EventLogInfo LogEventInternal(EventLogInfo eventObject)

Parameters

eventObject EventLogInfo

Contains event

Returns

EventLogInfo

LogEventInternal(EventLogInfo, bool)

Writes a new record to the event log.

protected virtual EventLogInfo LogEventInternal(EventLogInfo eventObject, bool logDirectly)

Parameters

eventObject EventLogInfo

Contains event

logDirectly bool

If true, the event is logged directly to the database. Otherwise, the event is logged to the queue processed by background worker to optimize performance.

Returns

EventLogInfo

LogEventInternal(string, string, string, string, string, int, string, string, string, string, string, DateTime?, LoggingPolicy)

Writes a new record to the event log.

[Obsolete("Method was not intended for public use and will be removed in the next version.")]
[ObsoleteSince(28, 2)]
protected virtual EventLogInfo LogEventInternal(string eventType, string source, string eventCode, string eventDescription, string eventUrl, int userId, string userName, string ipAddress, string machineName, string urlReferrer, string userAgent, DateTime? eventTime, LoggingPolicy loggingPolicy)

Parameters

eventType string

Type of the event. Please use predefined constants from EventLogProvider

source string

Source of the event (Content, Administration, etc.)

eventCode string

Event code (UPDATEDOC, SENDEMAIL, DELETE, etc.)

eventDescription string

Detailed description of the event

eventUrl string

Event URL address

userId int

ID of the user, who caused logged event

userName string

Name of the user, who caused logged event

ipAddress string

IP Address of the user, who caused logged event

machineName string

Name of machine

urlReferrer string

Referrer URL

userAgent string

User agent

eventTime DateTime?

Date and time when the event occurs

loggingPolicy LoggingPolicy

Logging policy.

Returns

EventLogInfo

LogExceptionInternal(string, string, Exception, string, LoggingPolicy)

Writes a new error to the event log.

[Obsolete("Method was not intended for public use and will be removed in the next version.")]
[ObsoleteSince(28, 2)]
protected virtual void LogExceptionInternal(string source, string eventCode, Exception ex, string additionalMessage, LoggingPolicy loggingPolicy)

Parameters

source string

Source of the event (Content, Administration, etc.)

eventCode string

Event code (UPDATEDOC, SENDEMAIL, DELETE, etc.)

ex Exception

Exception to be logged

additionalMessage string

Additional information to the exception message

loggingPolicy LoggingPolicy

Logging policy.

LogMetadata()

Returns true if the metadata should be logged.

public static bool LogMetadata()

Returns

bool

Set(EventLogInfo)

Inserts or updates the info object in the underlying data store.

public override void Set(EventLogInfo info)

Parameters

info EventLogInfo

Info object to be inserted or updated.

Exceptions

ArgumentNullException

Thrown when info is null.