Table Of Contents

Previous topic

Reef Client Overview

Next topic

Performance Data Management Dashboard

Event Management Dashboard

The Event Management Dashboard consists of a tabbed view containing three tabs:

Summary Tab

The Summary Tab data consists of three panels:

_images/summary_tab.png

Summary Tab

Event Distribution Panel

This panel displays various event distribution pie charts including:

  • Severity - The number of events per severity (unknown, info, minor, major and critical).
  • State - The number of events per state (new, updated, manually cleared and automatically cleared).
  • Type - The number of events per type (fault, clear, info, unknown).
  • Age - The number of events whose last seen attribute falls into one of the following age categories: less than 30 minutes old, over 30 minutes old, over 1 day old, over 1 month old.
  • Criticals - The number of critical events per node.
  • Node - The number of events per node.
  • Owner - The number of events per owner.

Critical Events Summary Panel

This panel displays:

  • How many critical events there are in total
  • When the last critical event was seen
  • The node that currently has the most critical events.

Service States Panel

Services are a representation of a filtered set of events. For example, a service might represent all the events with a particular node attribute value, events of a certain age or type, or all of these.

This panel is able to display up to 18 services. Each service is labelled with its name and the number of events the service filter gives rise to. The colour of the service icon is determined by the highest severity event the service represents. For example if a service represents at least one critical event its icon will be red. If a service represents at least one major event its icon will be amber, yellow for at least one minor event and so on for services with only info events (and lower) and only unknown events. A service with no events will have a green icon.

Navigating to a Related Event List

Click on a service state icon or label to navigate to the Events Tab with appropriately filtered content, i.e. the contents of the event list will be the events represented by the service. For example, if you click on the service called Earth the event list will contain all the events that are represented by the Earth service.

Changing the Displyed Service Order

The Summary Tab Docker contains a set of radio buttons that when clicked will change the order (left to right, top to bottom) in which services are displayed in the Service States Panel:

  • Service Name - Sort alphabetically by service name
  • State (ascending) - Sort alphabetically (A-Z) by service state
  • State (descending) - Sort alphabetically (Z-A) by service state
  • Most recent critical - Sort according to each service’s most recent critical event.
  • Event count - Sort according to each service’s event count in descending order.

Note that as new events enter the system and the order of services change based on the currently selected sort order, the displayed order will be updated accordingly.

Service Tab

The Service Tab displays a service panel for each configured service. Each panel provides a chart describing various event distributions and a message stating when the last critical event represented by this service was seen. The panel title-bar represents the current service state with an icon (coloured in the same way as the services in the Service States Panel), the service name and how many events the service currently represents.

_images/em_service_tab.png

Service Tab

The Service Tab also has a Summary Tab Docker that can be used to change the displayed service sort order (left to right, top to bottom).

_images/service_tab_docker.png

Summary Tab Docker

Navigating Through the Distributions

You can navigate through the various distributions provided by each service panel by performing a Ctrl+Click on the chart and it will display the next distribution. A Ctrl+Click on the last distribution will cause the first to be displayed again.

Note

Click-through to a related event list is not currently supported.

Changing the Distribution Chart Type

Each service panel can be toggled between a pie chart or a bar chart by performing a Shift+Click on the chart. Ctrl+Click on a bar chart will navigate through the available distributions in the same way as described above.

Changing the Displyed Service Order

The Summary Tab Docker contains a set of radio buttons that when clicked will change the order (left to right, top to bottom) in which services are displayed in the Service States Panel:

  • Service Name - Sort alphabetically by service name
  • State (ascending) - Sort alphabetically (A-Z) by service state
  • State (descending) - Sort alphabetically (Z-A) by service state
  • Most recent critical - Sort according to each service’s most recent critical event.
  • Event count - Sort according to each service’s event count in descending order.

Note that as new events enter the system and the order of services changes, based on the currently selected sort order, the displayed order will also be updated.

Events Tab

The Events Tab displays a sortable, filterable, paginated Event List. This is where you will browse and interact with events gathered by the system. The event list can display the events in a number of colour modes. It is possible to configure which columns are displayed.

_images/em_event_tab.png

Events Tab

The Events Tab also has a multi-tab Summary Tab Docker that is used for various operations and is described in more detail later in this section.

_images/events_tab_docker.png

Summary Tab Docker

Event List

The event list displays all the events gathered by the system. By default the following event attributes are displayed: Type, Severity, Count, State, Node, First Seen, Last Seen, Owner, Description. Using the Settings Tab you can hide these or additionally display the following attributes: Key, Label, IP, Expires, Group and Source. Refer to Reef Events for a description of the event attributes.

Events are (by default) split into pages of 100 events each and you can use the buttons on the Actions Tab to navigate to subsequent pages.

By default events are colour coded by severity (e.g. red for critical events) but you can use the controls in the Actions Tab to change the event colour mode (e.g. colour the events by type or state).

Event Selection

Select an event by clicking on a row in the event list. When a row is selected, event details and event logs are available for inspection in the Details Tab, Logs Tab and Attributes Tab respectively. Also, the docker title bar is updated to reflect the selection.

Multiple selections are possible by using the Ctrl and Shift modifier keys so that Ctrl+click will select multiple individual events and Shift+click will select all events from the last selection to the current selection (this is normal list multiple selection behaviour in most systems). The following keystrokes are also understood:

  • up, down - moves a single selection to the last or previous event respectively. If the shift-key modifier is used a multiple selection is made/un-made as the up and down keys are pressed.
  • page-up and page-down keyboard keys have a similar effect but for the all events that are visible (not to be confused with all the events on the current page.
  • Ctrl+A - selects all the events on the current page.
  • Ctrl+C - Copy the selected events. Your computer desktop’s clipboard will be populated with a comma-separated-value representation of the events selected.

Note

Event selection freezes the event list. This ensures that you can examine events without updates changing things unnecessarily. When an event (or events) is selected the Message Pane in the Application Control Bar displays the Event List Frozen Message. To un-freeze the event list you must remove any selections. To do this simply click the Event List Frozen Message. (You can also Ctrl+click each selected event until there are no more events selected).

_images/msgpanefrozen.png

Event List Frozen Message

Column Sorting

It is possible to sort the event list alphanumerically in ascending or descending order for one or more columns.

Note

The severity column exhibits special behaviour and is sorted by severity, not alphanumerically. This means an ascending sort will display events unknown -> critical top to bottom. A descending sort of the severity column will display events critical -> unknown top to bottom.

When a column is sorted, event data is sorted for all event data across all pages. To sort a column in ascending order, click the column header for the first time. An up-arrow indicating the column is sorted in ascending order will be displayed alongside the column label.

To sort a column in descending order, click the column header again. A down-arrow indicating the column is sorted in descending order will be displayed along-side the column label.

Clicking subsequent columns will sort the events in groups based on the last column sorted, i.e. sorting the count column followed by the node column will display:

  • All the events for the fist (alphanumerically speaking) node ascending by count, lowest to highest.
  • Followed by all the events for the next node (alphanumerically speaking) ascending by count lowest to highest.
  • And so on.

Note

The severity column sort order is always primary and does not participate in multiple-column sorts.

To delselect a column’s sort-order, Ctrl+click the column header. Any up-arrow or down-arrow displayed will be removed and the column will revert to its original, unsorted order.

Filtering the Event List

The event list can be filtered in a number of ways. One way already discussed is exercising the click-throughs from the Summary Tab. After performing a click-through you can show all the events again clicking the Show All button on the Filters Tab.

The Filters Tab contains other built-in filters which will be described later in this section. Reef also allows you to perform ad-hoc filtering for each column, described below.

Column Filtering

Each column in the Event List has a filter box above the column header. Entering a value using the filter box will filter the events displayed, across all pagess. As you refine the filter terms the number of pages may decrease as less events fulfil the filter criteria you entered.

When you enter a filter term in one or more filter boxes the Message Pane display the following message:

_images/msgpanefilter.png

Click on the message to clear all current filter terms defined.

There are different types of filter boxes including a Text Filter, a Numeric Filter and a Date Filter.

Text Filter

_images/text_filter_box.png

The text filter allows you to enter a regular expression to match attribute values in the column being filtered. This can be a simple string, e.g. if you want to look for all critical events just type crit in the filter box for the Severity column. The regular expression entered is treated case-insensitively. Below are some examples of more sophisticated filter terms:

  • Severity column, crit|maj - Only show events that have a critical or major severity.
  • Description column, ^There has been - Only show events that have a description that starts with the string ‘There has been’.
  • Owner column, ^s.*h$ - Only show events that have an owner whose name starts with the letter ‘s’ and ends with the letter ‘h’. This filter term would, for example, include events with owners Smith and Standish.

There is a full Regular Expression Syntax reference in an appendix to this document.

Numeric Filter

_images/num_filter_box.png

This filter allows you to filter based on numeric ranges rather than string pattern matching. Click on the filter box to display the Numeric Filter Dialogue.

_images/filter_num_dialog.png

Numeric Filter Dialogue

The numeric filter has three modes; Greater Than, Less Than and Range. For the first two modes, move the slider’s cursor to the desired value. By default the maximum value is 100 and the slider will snap to x10 incements. Use the Maximum radio buttons to increase the maximum if necessary and un-check the Snap check-box to provide a x1 slider granularity.

Click the Range mode to filter for events with a numeric column value that falls between two specific values.

If you need to see behind the Numeric Filter Dialogue while defining values simply click (anywhere on the dialogue that is not a control) and drag it to another position.

When the desired value has been set, click the Set button and the filter term will be applied. Click Clear to clear an existing filter term (this is analogous to deleteing the contents of a Text Filter). Click Cancel to leave the numeric filter term in the state it was before the numeric filter box dialogue was opened.

Date Filter

_images/date_filter_box.png

This filter allows you to filter based on a date range rather than string pattern matching. Click on the filter box to display the Date Filter Dialogue.

_images/filter_date_dialog.png

Date Filter Dialogue

The date filter allows you to define a start and end date in one of two modes:

  • Delta - a date and time that can only be in the past referenced as Days-Hours-Minutes ago. Use the up and down buttons to select the desired number of days, hours and minutes for a delta value.
  • Absolute - an absolute date and time that can be in the past or the future. Use the Calendar Control to pick the desired date and up and down buttons on the hours and minutes fields to select the desired time (in 24-hour format).
_images/filter_date_dialog_cal.png

Calendar Control

You are allowed to combine delta and absolute start and end dates, the only rule is that the start date (defined by the upper control) represents a date/time prior to end date (defined by the lower control). A description of the settings are displayed at the bottom of the dialogue. If the settings break the rules described above, an error message is displayed instead.

If you need to see behind the Date Filter Dialogue while defining values simply click (anywhere on the dialogue that is not a control) and drag it to another position.

When the desired value has been set, click the Set button and the filter term will be applied. Click Clear to clear an existing filter term (this is analogous to deleteing the contents of a Text Filter). Click Cancel to leave the date filter term in the state it was before the date filter box dialogue was opened.

Actions Tab

The Actions Tab contains controls to:

_images/events_tab_docker.png

Actions Tab

Acknowledge an Event

When you acknowledge an event the owner attribute is set to your username, indicating that you have taken ownership of the event. When one or more events are selected the the Acknowledge button is enabled. Click the Acknowledge button to acknowledge all selected events.

Clear an Event

When you clear an event its state is set to man_cleared and its expire time is set to now + 5 minutes after which time the event is deleted from the event database. When one or more events are selected the the Clear button is enabled. Click the Clear button to clear all selected events.

Delete one or all Events

When you delete an event its expire time is set to now which causes the event to be immediately deleted from the event database. When one or more events are selected the the Delete button is enabled. Click the Delete button to delete all selected events.

Note

The Delete keystroke has the same effect as clicking the Delete button on the action tab.

The Delete All button is always enabled. Clicking this button will delete all events in the event database, so use with caution. You will be prompted with an Are You Sure dialogue first.

Note

If you use the Ctrl+A keystroke and click Delete or use the Delete keystroke only delete the events on the current page will be deleted.

Colour Coding

The actions tab provides controls to change the event colour coding:

  • Severity - events are coloured based on the value of the Severity column.
  • State - events are coloured based on the value of the State column.
  • Type - events are coloured based on the value of the Type column.
  • None - events are not colour coded.

Filters Tab

The filters tab provides buttons to:

  • Show all events currently in the events database (i.e. remove all filtering).
  • Show all events with a Critical severity.
  • Show all events with a Major severity.
  • Show all events with a Minor severity.
  • Show all events with an Info severity.
  • Show all events with an Unknown severity.

Details Tab

The details tab displays event attribute values of the last selected event.

Logs Tab

As discussed in the Event Logs section an event records updates to its attributes as they are updated and those logs are displayed here for the last selected event.

Attributes Tab

As discussed in the Additional Event Fields section an event may have additional attributes that Reef does not support by default and those attributes are displayed here for the last selected event.

Settings Tab

This tab enables the user to select which event attributes should be displayed in the event list.