Difference between revisions of "Event Tracer"

Latest revision as of 18:30, 11 May 2015

Event Tracer

The Event Tracer monitors and visualizes events occuring in the UBIK^® system environment immediately, while the event data is also written by the logging mechanism in the background. This enables the user to watch events as they happen without the need to open log files. These events can be errors and warnings as well as messages generated out of the customizing code for debugging purposes (see logging category types).

Logging list

The list shows all events that occured since the start of the Studio session. Every entry has an information header shown in the list, consisting of the type and the time it occured as well as the time that elapsed, which is updated frequently. Every entry then can be expanded to show the full information included in this event.

Message Types

UBIK^® Event Tracer is able to show the following event types:

Icon	Type	Content
	Error	events the user should pay high attention to because the system is in a vulnerable state (marked with red error symbol); if the error message also provides a stack trace, the stacktrace will be shown on the right of the list box
	Warning	events that have to be investigated because they are potentially important to the productive use of the system (marked with yellow warning symbol)
	Message	events that support the user in debugging or finding problems in general (marked with blue message symbol)

Toolbar

The Event Tracer features a toolbar with the following items, from left to right:

Icon	Item	Purpose
	Select Category	Here the user can check or uncheck the categories to be shown in the list; changing this will hide or show the selected category of events in the list
	Sort by time stamp	this will sort the entries by the time stamp; clicking this repeatedly will change the direction of the sorting between ascending and descending time stamp
	Sort by category	this will sort the entries by the level of importance; clicking this repeatedly will change the direction of the sorting between important messages shown on top or at the bottom of the list
	Expand all items	this will expand all list entries to show all the information behind
	Collapse all items	this will collapse all list entries to show their headers only
	Copy to Clipboard	this will copy the content of the currently selected event(s)
	Copy all to Clipboard	this will copy the content of the all listed events to the clipboard
	Save to file	Saves the content of the currently selected event(s) to a text file
	Save all to file	Saves the content of the all listed events to a text file
	Clear all items	Clears the event list

Status bar

The Event Tracer features a status bar at the bottom showing the following information:

number of each event type; clicking these items will also hide or show the respective type of events in the list.
last event including the time stamp; clicking on this item will automatically show and select the item in the events list.

Context Menu

By right-clicking an event in the list, a context menu is shown:

Icon	Item	Purpose
	Copy to Clipboard	Copy the content of the currently selected event(s)
	Copy all to Clipboard	Copy the content of all listed events to the clipboard
	Save to file	Save the content of the currently selected event(s) to a text file
	Save all to file	Save the content of all listed events to a text file
	Navigate to...	Navigate to the UBIK^® object involved in this message; this menu item is only enabled if there is information about the involved object

@@ Line 1: / Line 1: @@
 [[File:UI_EventTracer.png|thumb|220px|Event Tracer]]
-The Event Tracer is meant for the Studio user to monitor events happening in the system environment of {{UBIK}}. It is used to visualize events immediately in Studio while they are written by the logging mechanism in the background. This gives the Studio user the possibility to watch events as they happen in the system without the need to open the log files. These events can be errors and warnings but can also be messages that are for example generated out of the customizing code for debugging.
+The Event Tracer monitors and visualizes events occuring in the {{UBIK}} system environment immediately, while the event data is also written by the logging mechanism in the background. This enables the user to watch events as they happen without the need to open log files. These events can be errors and warnings as well as messages generated out of the customizing code for debugging purposes (see [[HowTo:Configure_Logging|logging category types]]).
-==Message Types==
+==Logging list==
+The list shows all events that occured since the start of the Studio session. Every entry has an information header shown in the list, consisting of the type and the time it occured as well as the time that elapsed, which is updated frequently. Every entry then can be expanded to show the full information included in this event.
+===Message Types===
 {{UBIK}} Event Tracer is able to show the following event types:
-* Errors: events the user should pay high attention to because the system is in a vulnerable state (marked with red erro symbol).
-* Warnings: events that have to be investigated because they are potentially important to the productive use of the system (marked with yellow warning symbol).
-* Messages: events that support the user in debugging or finding problems in general (marked with blue message symbol).
-===Logging list===
+{| class="wikitable" | width = "50%"
-The list shows all events that happened since the start of the Studio session. Every entry has an information header shown in the list, consisting of the type and the time it happened as well as the time that elapsed since it happened. Every entry then can be expanded to show the full amount of infomation included in this event:
+|-
+! Icon !! Type !! Content
+|-
+| align="center" | [[File:IC_EventTracer_Error.png]] || Error || events the user should pay high attention to because the system is in a vulnerable state (marked with red error symbol); if the error message also provides a stack trace, the stacktrace will be shown on the right of the list box
+|-
+| align="center" | [[File:IC_EventTracer_Warning.png]] || Warning|| events that have to be investigated because they are potentially important to the productive use of the system (marked with yellow warning symbol)
+|-
+| align="center" | [[File:IC_EventTracer_Message.png]] || Message|| events that support the user in debugging or finding problems in general (marked with blue message symbol)
+|}
 ==Toolbar==
@@ Line 16: / Line 24: @@
 {| class="wikitable" | width = "50%"
 |-
-! Item !! Purpose
+! Icon !! Item !! Purpose
 |- align="left"
-| Select Category || Here the user can check or uncheck the categories to be shown in the list; changing this will hide or show the selected category of events in the list
+| align="center" | [[File:IC_EventTracer_categories.png]] || Select Category || Here the user can check or uncheck the categories to be shown in the list; changing this will hide or show the selected category of events in the list
 |- align="left"
-| Sort by time stamp || this will sort the entries by the time stamp; clicking this repeatedly will change the direction of the sorting between ascending and descending time stamp
+| align="center" | [[File:IC_EventTracer_orderbytimeasc.png]] || Sort by time stamp || this will sort the entries by the time stamp; clicking this repeatedly will change the direction of the sorting between ascending and descending time stamp
 |- align="left"
+| align="center" | [[File:IC_EventTracer_orderbycatdesc.png]] || Sort by category || this will sort the entries by the level of importance; clicking this repeatedly will change the direction of the sorting between important messages shown on top or at the bottom of the list
 |- align="left"
-| Sort by category || this will sort the entries by the level of importance; clicking this repeatedly will change the direction of the sorting between important messages shown on top or at the bottom of the list
+| align="center" | [[File:IC_EventTracer_expandall.png]] || Expand all items || this will expand all list entries to show all the information behind
 |- align="left"
-| Expand all items || this will expand all list entries to show all the information behind
+| align="center" | [[File:IC_EventTracer_collapseall.png]] || Collapse all items || this will collapse all list entries to show their headers only
 |- align="left"
-| Collapse all items || this will collapse all list entries to show their headers only
+| align="center" | [[File:IC_EventTracer_copy.png]] || Copy to Clipboard || this will copy the content of the currently selected event(s)
 |- align="left"
-| Copy to Clipboard || this will copy the content of the currently selected event(s)
+| align="center" | [[File:IC_EventTracer_copyAll.png]] || Copy all to Clipboard || this will copy the content of the all listed events to the clipboard
 |- align="left"
-| Copy all to Clipboard || this will copy the content of the all listed events to the clipboard
+| align="center" | [[File:IC_EventTracer_SaveHS.png]] || Save to file || Saves the content of the currently selected event(s) to a text file
 |- align="left"
-| Save to file || Saves the content of the currently selected event(s) to a text file
+| align="center" | [[File:IC_EventTracer_SaveAllHS.png]] || Save all to file || Saves the content of the all listed  events to a text file
 |- align="left"
-| Save all to file || Saves the content of the all listed  events to a text file
+| align="center" | [[File:IC_EventTracer_removeall.png]] || Clear all items|| Clears the event list
-|- align="left"
-| Clear all items|| Clears the event list
 |}
+==Status bar==
+The Event Tracer features a status bar at the bottom showing the following information:
+* number of each event type; clicking these items will also hide or show the respective type of events in the list.
+* last event including the time stamp; clicking on this item will automatically show and select the item in the events list.
 ==Context Menu==
@@ Line 45: / Line 57: @@
 {| class="wikitable" | width = "50%"
 |-
-! Item !! Purpose
+! Icon !! Item !! Purpose
-| Copy to Clipboard || this will copy the content of the currently selected event(s)
+|- align="left"
+| align="center" | [[File:IC_EventTracer_copy.png]] ||Copy to Clipboard || Copy the content of the currently selected event(s)
 |- align="left"
-| Copy all to Clipboard || this will copy the content of the all listed events to the clipboard
+| align="center" | [[File:IC_EventTracer_copyAll.png]] ||Copy all to Clipboard || Copy the content of all listed events to the clipboard
 |- align="left"
-| Save to file || Saves the content of the currently selected event(s) to a text file
+| align="center" | [[File:IC_EventTracer_SaveHS.png]] || Save to file || Save the content of the currently selected event(s) to a text file
 |- align="left"
-| Save all to file || Saves the content of the all listed  events to a text file
+| align="center" | [[File:IC_EventTracer_SaveAllHS.png]] ||Save all to file || Save the content of all listed events to a text file
 |- align="left"
-| Navigate to... || Navigate to the ubik object involved in this message; this menu item is only enabled if there is information about the involved UBIK object included in the message
+| align="center" | [[File:IC_EventTracer_navigateto.png‎]] || Navigate to... || Navigate to the {{UBIK}} object involved in this message; this menu item is only enabled if there is information about the involved object
 |}
+== See also ==
+* [[Logging]]
 [[Category:Studio_tools]]