Sheet - Task sequence

Standard sheets

Some predefined sheets focusing on various areas (CPU, memory, contentions..) are provided in the analyzer/config/report/sheet/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 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
Actions
Charts

Headers

See Headers section

Row headers

Row headers display figures in relation with the actions.

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

<row_headers>
  <thread_id action_link="true"/>
  <thread_name/>
</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.

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

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

Row headers reference list

Headers in bold can manage figure variants and therefore be instantiated multiple times : declaration example is provided in their description.

Name	Configuration id	Description
Action principal	`function_principal`	Action principal also known as action function principal
Contention type	`contention_type_principal`	Contention type principal
CPU	`action_consumed_cpu`	CPU usage of the current action The `color_activity` permits to highlight any CPU usage > 0 `<action_consumed_cpu color_activity="RGB-225-255-225"/>`
CPU runnable	`cpu_runnable`	Number of stacks within the action that were eligible for immediate CPU usage
Duration	`action_duration`	Action minimum duration in seconds
Frozen	`frozen_code_state`	Number of stacks which were consecutively identical
Jeyzer MX action	`jzr_mx_action_function_principal`	Action principal obtained through the Jeyzer Publisher MX interface
Jeyzer MX action start time	`jzr_mx_action_start_time`	Action start date obtained through the Jeyzer Publisher MX interface
Jeyzer MX action all context parameters	`jzr_mx_all_context_params`	List of all applicative context parameters (name value pair) associated to the current action (first recording snapshot) obtained through the Jeyzer Publisher MX interface This field display makes sense only if the set of applicative context parameters is constant by nature
Jeyzer MX action context id	`jzr_mx_context_id`	Applicative action context id obtained through the Jeyzer Publisher MX interface
Jeyzer MX action context parameter number	`jzr_mx_context_param_number`	Action numeric parameter referenced by its `name` obtained through the Jeyzer Publisher MX interface `<jzr_mx_context_param_number name="location_index" display="Location index" display_comment="Location index"/>` This field display makes sense only if the parameter is constant by nature
Jeyzer MX action context parameter string	`jzr_mx_context_param`	Action text parameter referenced by its `name` obtained through the Jeyzer Publisher MX interface `<jzr_mx_context_param name="location_name" display="Location name" display_comment="Location name"/>` This field display makes sense only if the parameter is constant by nature
Jeyzer MX action user	`jzr_mx_action_user`	Action user identifier obtained through the Jeyzer Publisher MX interface
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
Memory	`action_consumed_memory`	Allocated memory in Mb for the current action The `color_activity` permits to highlight any memory allocation > 0 `<action_consumed_memory color_activity="RGB-225-255-225"/>`
Operation principal	`operation_principal`	Operation principal of the action
Size	`action_size`	Number of recording snapshots captured for the current action
Start time	`action_start_time`	Action start time
Thread id	`thread_id`	Thread id. Unique
Thread name	`thread_name`	Thread name. No guaranteed to be unique
Thread type	`executor`	The thread type, also known as executor

Actions

The action layout is following a Gantt chart mode.

Action 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 action stack
Multiple field 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 action 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.

<consumed_memory color="ORANGE" threshold="100"/>

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">

Action reference list

Name	Configuration id	Description	Legend support	Stats support
Advanced contention type	`advanced_contention_type`	Displays the contention type(s) of the current stack 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 current stack. This rule is usually associated with a set of highlights. `<advanced_function display_operation="true" display_contention_type="false"/>`	Yes	No
Applicative activity usage	`act_usage`	Displays the CPU applicative usage of the thread This rule is usually associated with a default set of highlights : `<act_usage> <highlights highlights_config_file="${JEYZER_ANALYZER_CONFIG_DIR}/report/highlights/cpu-ranges.xml"/> </act_usage>`	Yes	Yes
Applicative memory usage	`applicative_memory_activity`	Displays the Memory applicative usage of the thread	Yes	Yes
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
Consumed memory	`consumed_memory`	Displays the consumed memory (allocated bytes in the last period) in Mb If the thread did consume some memory (between 0 and the `threshold`), the cell will be colorized with the `color_activity` one.`<consumed_memory color="ORANGE" threshold="100" color_activity="RGB-225-255-225"/>`	Yes	Yes
Contention type	`contention_type`	Displays the full list of contention types Use the Function histogram to get stats on contention types	Yes	No
CPU details	`cpu_details`	Displays the CPU consumption percentages at process (cpu), user (usr), system (sys = cpu – usr) and applicative level. Set the `value_activity` to true to display only the positive values and ignore the zero ones. This rule is usually associated with a default set of highlights applied on the CPU process usage : `<cpu_details value_activity="true"> <highlights highlights_config_file="${JEYZER_ANALYZER_CONFIG_DIR}/report/highlights/cpu-ranges.xml"/> </cpu_details>`	Yes	No
CPU usage	`cpu_usage`	Displays the CPU consumption percentages at process level (cpu) This rule is usually associated with a default set of highlights : `<cpu_usage value_activity="true"> <highlights highlights_config_file="${JEYZER_ANALYZER_CONFIG_DIR}/report/highlights/cpu-ranges.xml"/> </cpu_usage>`	Yes	Yes
Frozen code state	`frozen_code_state`	Add a border of the given `color` to the action cells with an identical stack Points out the freeze impression `<frozen_code_state color="RED"/>`	Yes	Yes
Function	`function`	Displays the full list of functions Use the Function histogram to get stats on functions	Yes	No
Jeyzer MX all context parameters	`jzr_mx_all_context_params`	Adds, as a cell comment, the list of applicative context parameters (name value pair) obtained through the Jeyzer Publisher MX interface	No	No
Jeyzer MX context parameter number	`jzr_mx_context_param_number`	Displays the last numeric value of the given `name` MX parameter obtained through the Jeyzer Publisher MX interface `<jzr_mx_context_param_number name="processed-entity-age"/>`	No	No
Jeyzer MX context parameter string	`jzr_mx_context_param`	Displays the last textual value of the given `name` MX parameter obtained through the Jeyzer Publisher MX interface This rule is usually associated with a set of highlights. `<jzr_mx_context_param name="processed-entity-name"/>`	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. The class name on which the lock is put on is displayed as suffix (since Jeyzer 2.6). `<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
Sys CPU usage	`sys_usage`	Displays the CPU consumption percentages at sys level (sys = cpu – usr) This rule is usually associated with a default set of highlights : `<sys_usage value_activity="true"> <highlights highlights_config_file="${JEYZER_ANALYZER_CONFIG_DIR}/report/highlights/cpu-ranges.xml"/> </sys_usage>`	Yes	Yes
Text wrap	`wrap_text`	Wraps the cell text	No	No
Usr CPU usage	`usr_usage`	Displays the CPU consumption percentages at usr level This rule is usually associated with a default set of highlights : `<usr_usage value_activity="true"> <highlights highlights_config_file="${JEYZER_ANALYZER_CONFIG_DIR}/report/highlights/cpu-ranges.xml"/> </usr_usage>`	Yes	Yes

Charts

See the Charts section

JZR report