Class EventLogServiceExtensions

Namespace

CMS.Core

Assembly

CMS.Core.dll

Extension methods for the IEventLogService

public static class EventLogServiceExtensions

Inheritance

object

EventLogServiceExtensions

Remarks

These extension methods are maintained for backward compatibility. For new development, use Microsoft.Extensions.Logging.ILogger instead.

Methods

LogError(IEventLogService, string, string, string, LoggingPolicy)

Writes a new error to the event log.

public static void LogError(this IEventLogService eventLogService, string source, string eventCode, string eventDescription = null, LoggingPolicy loggingPolicy = null)

Parameters

eventLogService IEventLogService

Event log service that logs the arguments

source string

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

eventCode string

Event code (Security, Update, Delete, etc.)

eventDescription string

Additional event information

loggingPolicy LoggingPolicy

Logging policy

Remarks

Parameters source and eventCode are limited to 100 characters. If a longer value needs to be logged, use the eventDescription parameter.

This method is maintained for backward compatibility. For new development, use Microsoft.Extensions.Logging.ILogger instead.

LogEvent(IEventLogService, EventTypeEnum, string, string, string)

Writes a new record to the event log.

public static void LogEvent(this IEventLogService eventLogService, EventTypeEnum eventType, string source, string eventCode, string eventDescription = null)

Parameters

eventLogService IEventLogService

Event log service that logs the arguments

eventType EventTypeEnum

Type of the event EventTypeEnum

source string

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

eventCode string

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

eventDescription string

Detailed description of the event

Remarks

Parameters source and eventCode are limited to 100 characters. If a longer value needs to be logged, use the eventDescription parameter.

This method is maintained for backward compatibility. For new development, use Microsoft.Extensions.Logging.ILogger instead.

LogException(IEventLogService, string, string, Exception, string, LoggingPolicy)

Writes a new error to the event log.

public static void LogException(this IEventLogService eventLogService, string source, string eventCode, Exception ex, string additionalMessage = null, LoggingPolicy loggingPolicy = null)

Parameters

eventLogService IEventLogService

Event log service that logs the arguments

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.

Remarks

Parameters source and eventCode are limited to 100 characters. If a longer value needs to be logged, use the additionalMessage parameter.

This method is maintained for backward compatibility. For new development, use Microsoft.Extensions.Logging.ILogger instead.

LogInformation(IEventLogService, string, string, string, LoggingPolicy)

Writes a new information to the event log.

public static void LogInformation(this IEventLogService eventLogService, string source, string eventCode, string eventDescription = null, LoggingPolicy loggingPolicy = null)

Parameters

eventLogService IEventLogService

Event log service that logs the arguments

source string

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

eventCode string

Event code (Security, Update, Delete, etc.)

eventDescription string

Additional event information

loggingPolicy LoggingPolicy

Logging policy

Remarks

Parameters source and eventCode are limited to 100 characters. If a longer value needs to be logged, use the eventDescription parameter.

This method is maintained for backward compatibility. For new development, use Microsoft.Extensions.Logging.ILogger instead.

LogWarning(IEventLogService, string, string, Exception, string, LoggingPolicy)

Writes a new warning to the event log.

public static void LogWarning(this IEventLogService eventLogService, string source, string eventCode, Exception ex, string additionalMessage = null, LoggingPolicy loggingPolicy = null)

Parameters

eventLogService IEventLogService

Event log service that logs the arguments

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

Remarks

Parameters source and eventCode are limited to 100 characters. If a longer value needs to be logged, use the additionalMessage parameter.

This method is maintained for backward compatibility. For new development, use Microsoft.Extensions.Logging.ILogger instead.

LogWarning(IEventLogService, string, string, string, LoggingPolicy)

Writes a new warning to the event log.

public static void LogWarning(this IEventLogService eventLogService, string source, string eventCode, string eventDescription = null, LoggingPolicy loggingPolicy = null)

Parameters

eventLogService IEventLogService

Event log service that logs the arguments

source string

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

eventCode string

Event code (Security, Update, Delete, etc.)

eventDescription string

Additional event information

loggingPolicy LoggingPolicy

Logging policy

Remarks

Parameters source and eventCode are limited to 100 characters. If a longer value needs to be logged, use the eventDescription parameter.

This method is maintained for backward compatibility. For new development, use Microsoft.Extensions.Logging.ILogger instead.