Working with the system event log

The event log stores information about all events that occur in the system. It is useful to view logged information if unwanted behavior occurs in the system and you want to find out where the problem originates or get additional details.

Viewing the event log

To view the event log, open the Event log application.

If you click Display event () next to an event, the system displays a dialog with full details about the event.

Configuring the event log

You can configure the following event log settings:

• General event log settings
• Configuring permissions for the event log
• Logging system events to trace
• Logging system events in the Windows Event Viewer
• Setting up email notifications for errors

General event log settings

You can configure the following settings for the event log in Settings -> System:

Configuring permissions for the event log

To allow users to work with the event log, configure permissions for your website’s roles:

1. Open the Permissions application.

2. Select permissions for Modules and the Event log.

3. Assign the following permissions to roles:

   • Read – allows members of the roles to access the event log. Only users with the Global administrator privilege level can view events logged on a global application level.
   • Clear log – allows members of the roles to delete the records in the event log.

Logging system events to trace

You can set up the system to log application events in trace. You can then implement your own listener, such as the TextWriterTraceListener or use the out-of-the-box Xperience functionality to log events into the Windows Event Viewer.

To enable logging of system events to trace:

1. In the Xperience administration interface, open the Settings application.
2. Select the System category.
3. In the Event log settings group, enable Log to trace.
4. Save the changes.

The system now logs events to trace. You can now implement your own listener, such as the TextWriterTraceListener.

Logging system events in the Windows Event Viewer

You can set up the system to log events in the Windows Event Viewer. This is achieved using the EventLogTraceListener.

Registering Xperience in the Windows Event Log

1. Run the installer.
2. Select your country, accept the license agreement, and click Next.
3. Modify the installation that you want to register in Windows Event Log.
4. Select the Registration of Xperience in Windows Event Log check box.
5. Apply Changes.

The installer registers Xperience in the Windows Event Log.

Enabling logging of events into Windows Event Log

1. In the Xperience administration interface, open the Settings application.
2. Select the System category.
3. In the Event log settings group, enable Log to trace and Use EventLog trace listener.
4. Save the changes.

The system now logs events to both the event log and Windows Event Viewer.

Setting up email notifications for errors

You can configure the system to automatically send email notifications whenever errors occur in the application.

1. Open the Settings application.
2. Select the System category.
3. Enter the target email addresses for the notifications into the Error notification email address setting.
   • Use semicolons to separate multiple addresses.
4. Type a sender address into the No-reply email address settings.
   • The notification emails use the sender address in their From field.
5. Save the settings.

Event log API

You can find an API example of logging events into the event log in Designing secure error messages. More examples are provided in the API Examples documentation.

Customizing event logging

If you wish to customize the way the system logs events, see Customizing event logging.