Event Log

Top  Previous  Next

The Event Log component is intended for viewing and managing server events in the real-time mode. It also provides access to event history and allows to acknowledge events.

To allow using Event Filters, AggreGate Client creates one Event Log component per every server connection when it is active (established). Event Log component is automatically closed when connection to the corresponding server is broken.

Event Log window consist of two main parts: Current Events and Event History:

cl_event_log

Both parts have a toolbar that helps to access frequently used functions. In the left part of both toolbars the is a drop down box that allows to select an Event Filter. Initially, these the selected filter is <Empty Filter> what means that no events are shown.

In some cases Event Log component shows a predefined set of event types. In this case list of Event Filters and related buttons ("Reactivate Filter", "Configure Filter") are not available.

Columns of event tables can be resized and reordered. To resize a column click on its margin and drag the mouse to left or right. To change column order, drag column header and drop it to a new location. Column size and order is applied to the current filter only. It is stored in the workspace and reused when AggreGate Client is restarted.

It is also possible to sort events. To enable sorting, click on the column header. Subsequent clicks will change sorting order for this column between ascending and descending.

Double-clicking the separator between headers of two columns will auto-fit the left-hand's column width (i.e, resize it to fit everything in it).

It is important to note that sorting of event history is performed on the server, so it may take considerable time.

Double clicking on any event opens Data Table associated with it in a Data Table Editor.

Current Events

Current Events table shows events happening on the server in the real time. Events are filtered according to the currently selected Event Filter or by the custom filtering rules specified by the server during execution of Show Event Log UI Procedure. In order to minimize the amount of transferred data, filtering is performed on the server.

Current Events Toolbar

cl_el_current_events_toolbar

The drop-down box selects Event Filter that will be used to filter events that will be shown in the log.

el_reactivate

Reactivate Current Filter. This operation allows to re-enter filter parameters.

el_configure

Configure Current Filter. Edit settings of currently selected filter.

el_enable_hscroll el_disable_hscroll

Enable/Disable Horizontal Scrolling. If disabled, width of all columns is adjusted automatically to fit the width of Event Log window. If enabled, Event Log has a horizontal scrollbar and width of all columns is adjusted to fit their contents. This option is disabled by default.

el_severity_stats

View Severity Statistics. Shows the number of events of each level in the Current Events window.

el_export

Export. Exports events currently shown in the Current Events window to a file.

el_clear

Clear Current Events. Clearing the current events table doesn't remove these events from the server and doesn't prevent new events from appearing in the table.

Event History

Event History displays events that happened in the past and were saved by the server. Not all events are persistently saved in the history. Events are filtered according to the currently selected Event Filter or by the custom filtering rules specified by the server during execution of Show Event Log UI Procedure.

Event History Toolbar

cl_el_event_history_toolbar

Event Filter selected in the drop-down box is used to filter out events that will be shown.

el_reactivate

Reactivate Current Filter. This operation allows to re-enter filter parameters.

el_configure

Configure Current Filter. Edit settings of currently selected filter.

el_enable_hscroll el_disable_hscroll

Enable/Disable Horizontal Scrolling. If disabled, width of all columns is adjusted automatically to fit the width of Event Log window. If enabled, Event Log has a horizontal scrollbar and width of all columns is adjusted to fit their contents. This option is disabled by default.

el_severity_stats

View Severity Statistics. Shows the number of events of each level in the currently loaded event history.

el_export

Export. Exports events currently shown in the Event History window to a file.

note_warning-wt

Only events shown in the currently selected range will be exported. To export larger number of events, increase the Rows Per Page setting (see below).

el_refresh

Refresh. Refreshes event history. This operation causes the server to reload the history according to the current filter. The actual visible events may change after this operation.

el_first

First. Scrolls history list to the first page.

el_previous

Previous. Loads previous page of the history list.

el_next

Next. Loads next page of the history list.

el_last

Last. Scrolls history list to the last page.

cl_el_event_history_rows

Rows Per Page. Defines how many events are shown at once.

The total number of events corresponding to the filter and range of currently shown events is indicated in the right part of toolbar.

Context Menu

Context menu is available upon right click on one of the events in the Event Log. It includes two items:

Show Event Data. Opens Data Table associated with the event in the Data Table Editor.
Acknowledge Event. Allows user to set event acknowledgement. This operation is available only for persistent events.
View Acknowledgements. View event acknowledgements in the Data Table Editor.
Delete Event. Permanently delete event from event history. This operation is available only for persistent events.
Create Alert for this Event. Create new alert that will be raised when this event will occur and satisfy specified criteria. You will be prompted to enter alert settings using a Data Table Editor. See alerts section for details.

Event context menu also contains a Related Actions submenu with list of actions related to the context where event was occurred or related to the event itself.

For example, for a Device Server-related event, "Reboot Device Server", "Configure Device Server" and other operations may be shown:

cl_el_context_menu

Acknowledging Events

Event acknowledgement function is available for persistent events only. When Acknowledge Event menu item is activated, user is prompted to enter acknowledgement text:

cl_el_ack

When acknowledgement is set, its time, author and text appear in special column of the events table:

cl_el_ack_set

Events Export

Event Log has support for event exporting to a number of well-known file formats. When events are exported, a Data Table containing events data is prepared first. This table contains the following fields:

Event Time
Events Context
Event Name
Event Level
Event Data (contents of event's Data Table encoded into a string)
One additional field per every field declared in event format

Here is a list of supported export formats:

Extension

Description

Notes

TBL

AggreGate Native Format

Data Table is encoded according to Data Table Encoding standard and written to a file.

XML

Extensible Markup Language

Data Table is encoded according to Data Tables XML Encoding standard and written to a file.

HTML

Hypertext Markup Language


CSV

Character Separated Values

User may specify a number of CSV encoding/decoding settings before export/import takes place.

XLS

Microsoft Excel