Event Logs

Description

The Events Log Viewer allows you to view the events that were logged in Ambience. The log viewer displays a limit of 500 records. You can also download the log in CSV or JSON format.

Module Interface

Interface Description Required Privilege
Event Logs Allows access to Event Logs page. mod-events-log-viewer

Log Parameters

There are two panels in the Event Logs. The left panel allows you to select the desired start and end dates, and filters for the log. The right panel allows you to select the desired column fields to be displayed and it consists of two pages; namely “System” and “When”.

Left Panel

The left panel allows you to select the start and end dates, as well as setting up the filters.

To select the start date, select the checkbox on the left of the “Start” field. By default, the current date is used. To choose another date, click in the “Calendar” icon and choose the desired date. Do the same for the end date.

There are three types of filters:

  • “Exclude Regular Events” filter
  • “Show Error & Warn Only” filter
  • Criteria filter

The “Exclude Regular Events” filter allows you to excludes regular events from the log, such as AmbienceAgenda (e.g., hourly scheduled activity) and MinuteMinder (records server statistics every minute).

The “Show Error & Warn Only” filter allows you to display only error and warning events in the log.

The Criteria filter allows you to filter the log according to parameters selected. For this filter, by default one blank filter is shown for you to enter your filter criteria (cannot be deleted). for you to enter your filter criteria. You can add more filters by clicking on the “+” icon.

To create a criteria, click on the textbox next to the “+” icon to display a drop-down list. Select the desired column field from the drop-down list. Select the appropriate operator in the centre textbox. In the third textbox, key in the desired value. To clear or delete a filter, click on the icon.

Right Panel

The right panel allows you to select the column fields to be displayed in the viewer. In consists of two pages:

  • System - allows you to select the system parameters
  • When - defines when the event occurs

By default, the “System” page is displayed with default fields. You can change the setting by selecting or unselecting the fields in the panel.

To go to the “When” page, click on “System” and select “When”. The fields available for “When” will appear. Select or unselect the fields according.

Note the “When” option “run” is the unique value for which server session. If you are only interested in things that happened this time you ran the server, then look at the system information:

The Run ID is the number of times you have started Ambience. You can filter by run = 461 to only see events from the current server session. If you stop and restart, Run ID will be 462.

Viewer Usage

To generate the events log, select the desired date range and set up the filters in the left panel. In the right panel, select the desired column fields in the “System” and “When” panels.

Click on the “View” button and the events log will appear in the panel below.

By default the log is in descending order. You can re-sort the log in ascending order by clicking on the “Descending” field and select “Ascending” from the drop-down list.

If the generated log does not have the column fields you desire, you can add the columns by selecting the column field checkboxes in the right panel and vice versa.

You can add the third filter by clicking on the desired cell field, for example, JVMMinuteMinder in the “logger” column. The filter will automatically fills up. By default, the “Equal” operator is selected. If it is not the desired operator, click on the “Equals” operator and select the desired operator from the drop-down list.

Click on the “View” button to re-generate the log. Now the events with selected field are displayed.

The log can be downloaded by clicking on the “Download” button that appear in the page and select a format option from the drop-down list.

The log can be downloaded either in CSV or JSON format.