Sheet - Group sequence

Standard sheets

Two predefined sheets are provided in the analyzer/config/report/sheet/group-sequence directory of your Jeyzer installation. Those can be referenced in your report.xml.

Refer to the below sections for any customization.

Configuration

Specific sheet attributes :
type : must be set to group_sequence
link_type : the link acronym label and id when the sheet gets referenced from other ones (ex: Monitoring Events sheet).
Acronym must be composed of three letters.

The Task Sequence sheet contains those following configurable parts :

Headers
Row headers
Stack groups
Charts

Headers

See Headers section

Row headers

Row headers display figures in relation with the stack groups.

Row headers can get navigation links pointing to their action by setting the group_link to true.

<row_headers>
  <group_id group_link="true"/>
  <executor/>
</row_headers>

Pane freeze
For readability convenience, the left pane is frozen automatically only if there is less than 5 row headers to display.
To change this behavior, you may either force/disable the freezing at the sheet configuration level.

<row_headers freeze="true">

Or change the global setting at the setup level in the config/setup/default_setup.xml.

<row_headers unfreeze_pane_threshold="5"/>

Threshold highlight
Row header numeric values can be highlighted in color when reaching a predefined threshold.
Threshold is optional and set to 70 when the row header is percentage based.

<group_size color="RGB-231-213-137" threshold="10"/>

Highlights
Highlights of specific values are supported
See the highlights section.

Row headers reference list

Name	Configuration id	Description
Action principal	`function_principal`	Action principal of the stack group, also known as action function principal
Contention type	`contention_type_principal`	Contention type principal of the stack group
Duration	`action_duration`	Minimum duration observance of the stack group in seconds
Group id	`group_id`	Internal id of the stack group. Unique
Group size	`group_size`	Number of recording snapshots in which the stack group is observed sequentially
Lock state	`lock_state`	Action lock state. Letter codes identify the type of lock : D = deadlock L = locked / lock owner S = suspended on debug breakpoint
Operation principal	`operation_principal`	Operation principal of the action
Start time	`action_start_time`	Action start time
Thread type	`executor`	The thread type, also known as executor

Stack groups

The stack group layout is following a Gantt chart mode.

Stack group display is fully configurable and allows through the usage of display rules (consider it as decorators):

the display of values, taken out from the current stack group
Multiple fields display is possible : each field value will be separated from each other by a slash separator

the look and feel adjustment, based on a current group stack field value
Multiple display adjustment is possible (color cell background, underlined text, wrapped text, cell comment..) applied in the declaration order which means that the last one takes over (important when dealing with background colors).

Threshold highlight
Action numeric values can be highlighted in color when reaching a predefined threshold.
Threshold is optional and set to 70 when the action field is percentage based.

<group_size color="ORANGE" threshold="50"/>

Highlights
Highlights of specific values are supported
See the highlights section.

Legend
Field legend is automatically displayed when the display rule supports it.
Legend content varies from one field to another.
For the text fields, the legend relies on the highlights.

Statistics
Some display rules do support the statistics display, along with the legend.
Statistics apply on value based fields as ranges and on text fields as enum.
Stats display can be be disabled with the stat attribute.

<advanced_operation stats="false">

Stack group reference list

Name	Configuration id	Description	Legend support	Stats support
Advanced contention type	`advanced_contention_type`	Displays the contention type(s) of the stack group The `all_contention_types` indicates if the full list of contentions must be displayed or only the principal one (`default)` This rule is usually associated with a set of highlights.`<advanced_contention_type all_contention_types="true"/>`	Yes	No
Advanced function rule	`advanced_function`	Displays the function principal of the current stack The `display_operation` and `display_contention_type` permit to append to it the operation principal and contention type principal of the stack group. This rule is usually associated with a set of highlights. `<advanced_function display_operation="true" display_contention_type="false"/>`	Yes	No
ATBI of interest	`atbi_of_interest`	Permits to identify the ATBI stacks of interest, meaning the ones with a large stack. When the stack is higher than the given `threshold`, the cell will be colorized and the text set as (ATBI). Useful when doing manual analysis profile enrichment `<atbi_of_interest threshold="10" color="ORANGE"/>`	Yes	No
Biased lock	`biased_lock`	Underlines the cell value if the stack contains one or more biased locks	Yes	No
Contention type	`contention_type`	Displays the full list of contention types Use the Function histogram to get stats on contention types	Yes	No
Function	`function`	Displays the full list of functions Use the Function histogram to get stats on functions	Yes	No
Group size	`group_size`	Displays the size of the current group stack Example : x99	No	No
Lock state	`lock_state`	Displays the lock information in this priority order : deadlock, locked & locker, locked, locking, code locked (locker), suspended. Locks ids are displayed when appropriate and links permit to navigate to the lock owner thread. `<lock_state color="ORANGE" lock_owner="RGB-209-47-109" lock_owner_and_locked="RGB-174-76-169" deadlock="RED" suspended="RED"/>`	Yes	Yes
Long running action	`long_running`	Set the cell background color with `color` when the action size (number of stacks composing it) is greater or equal to `threshold` Multiply this threshold by the recording period time to get the time length `<long_running color="LIGHT_YELLOW" threshold="10"/>`	Yes	Yes
Long stack	`long_stack`	Cell text size gets increased if the associated stack size is greater or equal to `threshold` Scope reduction to ATBI only is possible with the `atbi_only` attribute. The cell text size is set with `font_size`. <long_stack threshold=”15″ font_size=”15″ atbi_only=”false”/> Since Jeyzer 2.2	Yes	No
Operation	`operation`	Displays the full list of operations Use the Function histogram to get stats on functions	Yes	No
OTBI of interest	`otbi_of_interest`	Permits to identify the OTBI stacks of interest, meaning the ones with a large stack. When the stack is higher than the given `threshold`, the cell will be colorized and the text set as (OTBI). Useful when doing manual analysis profile enrichment `<otbi_of_interest threshold="12" color="RGB-146-208-80"/>`	Yes	No
Stack	`stack`	Adds the stack content as a cell comment. It includes the stack headers. When a large number of actions is identified (>1000 by default), the stack display is optimized by repeating the identical stacks less frequently : this speeds up the report generation, reduces slightly the JZR report size and makes it more readable.	No	No
Stack size	`stack_size`	Displays the stack size. Highlights the cell with `color` when the stack contains no function (= ATBI) and it size is below or equal to `threshold` Useful when doing manual analysis profile enrichment `<stack_size threshold="12" color="RGB-233-140-63"/>`	No	No
Thread state	`state`	Displays the thread state This rule is usually associated with a set of default highlights : `<state> <highlights highlights_config_file="${JEYZER_ANALYZER_CONFIG_DIR}/report/highlights/thread-states.xml"/> </state>`	Yes	No
Text wrap	`wrap_text`	Wraps the cell text	No	No

Charts

See the Charts section

JZR report