Overview

This section covers the properties that can be used to print tables of performance statistics for the system, Wrapper process and JVM. These statistics were added in version 3.5.52 to help understand issues in situations such as when the JVM is detected hung.

The data are subject to change in future versions of the Wrapper, but currently include memory and CPU usage. They are collected at regular intervals by the Wrapper and then printed retrospectively when certain events occur. This allows analysis of what happened during a given period before a problem occurred and, when included in the logs, are a useful information for technical support.


Triggering the printing of statistics:

The 'STATS' keyword can be used in the value of any action property to configure when statistics should be printed.

Example: Print statistics every day at 1:00 AM. 
wrapper.timer.1.action=STATS
wrapper.timer.1.interval=hour=1

It is also possible to use the 'STATS' keyword in the command file to trigger the printing of statistics at any time.


The following properties can be used to configure how the statistics should be printed:

NOTE

This feature is currently only available for Windows, but can be added to other platforms upon request.

wrapper.stats.enable
Compatibility :3.5.52
Editions :Professional EditionStandard EditionCommunity Edition (Not Supported)
Platforms :WindowsMac OSX (Not Supported)Linux (Not Supported)IBM AIX (Not Supported)FreeBSD (Not Supported)HP-UX (Not Supported)Solaris (Not Supported)IBM z/OS (Not Supported)IBM z/Linux (Not Supported)

This property can be used to enable or disable the ability to print performance statistics. When set to FALSE, no statistics will be collected.

Statistics collection has been optimized to have a negligible impact on performance while the Wrapper is running. In most cases it's preferred to leave the value of this property to TRUE, otherwise the information will not be available for analysis in the event of a problem. Keep in mind that performance-related issues can be rare but are often difficult to reproduce, and the ability to consult what happened afterwards is valuable.

The default value is TRUE.

Example: Disable statistics. 
wrapper.stats.enable=FALSE

wrapper.stats.system.enable
Compatibility :3.5.52
Editions :Professional EditionStandard EditionCommunity Edition (Not Supported)
Platforms :WindowsMac OSX (Not Supported)Linux (Not Supported)IBM AIX (Not Supported)FreeBSD (Not Supported)HP-UX (Not Supported)Solaris (Not Supported)IBM z/OS (Not Supported)IBM z/Linux (Not Supported)

This property can be used to enable or disable the ability to print performance statistics for the System. Currently, the Physical memory, Committed memory, and Cache are included in the system statistics.

The property is ignored if wrapper.stats.enable is set to FALSE.

The default value is TRUE.

Example: 
wrapper  | System:
wrapper  |                          Physical         Committed          Cache
wrapper  | -------------------------------------------------------------------
wrapper  | 12:00:44 - 12:00:54 |  13.0 GB (41%)  |  14.4 GB (39%)   |   3.5 GB
wrapper  | 12:00:54 - 12:01:04 |  13.0 GB (41%)  |  14.5 GB (39%)   |   3.5 GB
wrapper  | 12:01:04 - 12:01:14 |  12.9 GB (40%)  |  14.4 GB (39%)   |   3.5 GB
wrapper  | 12:01:14 - 12:01:24 |  12.8 GB (40%)  |  14.2 GB (38%)   |   3.5 GB
wrapper  | 12:01:24 - 12:01:34 |  12.8 GB (40%)  |  14.2 GB (39%)   |   3.5 GB
wrapper  | 12:01:34 - 12:01:44 |  12.8 GB (40%)  |  14.2 GB (38%)   |   3.5 GB
wrapper  | 12:01:44 - 12:01:54 |  12.8 GB (40%)  |  14.2 GB (38%)   |   3.5 GB
wrapper  | 12:01:54 - 12:02:04 |  12.8 GB (40%)  |  14.2 GB (38%)   |   3.5 GB
wrapper  | 12:02:04 - 12:02:14 |  12.7 GB (40%)  |  14.1 GB (38%)   |   3.5 GB
wrapper  | 12:02:14 - 12:02:20 |  12.7 GB (40%)  |  14.1 GB (38%)   |   3.5 GB

wrapper.stats.wrapper.enable
Compatibility :3.5.52
Editions :Professional EditionStandard EditionCommunity Edition (Not Supported)
Platforms :WindowsMac OSX (Not Supported)Linux (Not Supported)IBM AIX (Not Supported)FreeBSD (Not Supported)HP-UX (Not Supported)Solaris (Not Supported)IBM z/OS (Not Supported)IBM z/Linux (Not Supported)

This property can be used to enable or disable the ability to print performance statistics for the Wrapper process.

The property is ignored if wrapper.stats.enable is set to FALSE.

The following data will be printed:

  • The CPU usage in percentage.

  • The Working set, which is the size in the virtual address space of the Wrapper process that is currently resident in physical memory.

  • The Paged pool, which is the amount of kernel and device driver memory that can spill over from physical memory into the paging file (disk).

  • The Non-paged pool, which is the amount of kernel and device driver memory that cannot spill over from physical memory into the paging file.

  • The Committed pool, which is the amount of memory that the Wrapper process requested to use.

The default value is TRUE.

Example: 
wrapper  | Wrapper process:
wrapper  |                        CPU   Work. set    Paged    Non-paged  Committed
wrapper  | -----------------------------------------------------------------------
wrapper  | 12:00:14 - 12:00:24 |  0.0% |  11.7 MB | 160.6 KB |  16.0 KB |   3.0 MB
wrapper  | 12:00:24 - 12:00:34 |  0.0% |  11.7 MB | 160.6 KB |  16.0 KB |   3.0 MB
wrapper  | 12:00:34 - 12:00:44 |  0.0% |  11.7 MB | 160.6 KB |  16.0 KB |   3.0 MB
wrapper  | 12:00:44 - 12:00:54 |  0.0% |  11.7 MB | 160.6 KB |  16.0 KB |   3.0 MB
wrapper  | 12:00:54 - 12:01:04 |  0.0% |  11.7 MB | 160.6 KB |  16.0 KB |   3.0 MB
wrapper  | 12:01:04 - 12:01:14 |  0.0% |  11.7 MB | 160.6 KB |  16.0 KB |   3.0 MB
wrapper  | 12:01:14 - 12:01:24 |  0.0% |  11.7 MB | 160.6 KB |  16.0 KB |   3.0 MB
wrapper  | 12:01:24 - 12:01:34 |  0.0% |  11.7 MB | 160.6 KB |  16.0 KB |   3.0 MB
wrapper  | 12:01:34 - 12:01:44 |  0.0% |  11.7 MB | 160.6 KB |  16.0 KB |   3.0 MB
wrapper  | 12:01:44 - 12:01:45 |  0.0% |  11.7 MB | 160.6 KB |  16.0 KB |   3.0 MB

wrapper.stats.java.enable
Compatibility :3.5.52
Editions :Professional EditionStandard EditionCommunity Edition (Not Supported)
Platforms :WindowsMac OSX (Not Supported)Linux (Not Supported)IBM AIX (Not Supported)FreeBSD (Not Supported)HP-UX (Not Supported)Solaris (Not Supported)IBM z/OS (Not Supported)IBM z/Linux (Not Supported)

This property can be used to enable or disable the ability to print performance statistics for the JVM (java process).

The property is ignored if wrapper.stats.enable is set to FALSE.

The following data will be printed:

  • The CPU usage in percentage.

  • The Working set, which is the size in the virtual address space of the Java process that is currently resident in physical memory.

  • The Paged pool, which is the amount of kernel and device driver memory that can spill over from physical memory into the paging file (disk).

  • The Non-paged pool, which is the amount of kernel and device driver memory that cannot spill over from physical memory into the paging file.

  • The Committed pool, which is the amount of memory that the Java process requested to use.

The default value is TRUE.

Example: 
wrapper  | Java process:
wrapper  |                        CPU   Work. set    Paged    Non-paged  Committed     Page Faults
wrapper  | -------------------------------------------------------------------------------------------
wrapper  | 12:00:14 - 12:00:24 |  0.0% |  68.4 MB | 527.5 KB |  29.2 KB | 631.5 MB | ########        38
wrapper  | 12:00:24 - 12:00:34 |  0.0% |  68.4 MB | 527.5 KB |  29.2 KB | 631.5 MB |                  0
wrapper  | 12:00:34 - 12:00:44 |  0.0% |  68.4 MB | 527.5 KB |  29.2 KB | 631.5 MB | #                1
wrapper  | 12:00:44 - 12:00:54 |  0.0% |  68.4 MB | 527.5 KB |  29.2 KB | 631.5 MB | #                1
wrapper  | 12:00:54 - 12:01:04 |  0.0% |  68.4 MB | 527.5 KB |  29.2 KB | 631.5 MB |                  0
wrapper  | 12:01:04 - 12:01:14 |  0.0% |  68.5 MB | 527.5 KB |  29.2 KB | 631.5 MB | #                3
wrapper  | 12:01:14 - 12:01:24 |  0.0% |  68.6 MB | 529.0 KB |  29.2 KB | 631.5 MB | ######          24
wrapper  | 12:01:24 - 12:01:34 |  0.0% |  68.6 MB | 529.0 KB |  29.2 KB | 631.5 MB |                  0
wrapper  | 12:01:34 - 12:01:44 |  0.0% |  68.6 MB | 529.0 KB |  29.2 KB | 631.5 MB | #                1
wrapper  | 12:01:44 - 12:01:45 |  0.0% |  68.6 MB | 529.0 KB |  29.2 KB | 631.5 MB |                  0

wrapper.stats.lines
Compatibility :3.5.52
Editions :Professional EditionStandard EditionCommunity Edition (Not Supported)
Platforms :WindowsMac OSX (Not Supported)Linux (Not Supported)IBM AIX (Not Supported)FreeBSD (Not Supported)HP-UX (Not Supported)Solaris (Not Supported)IBM z/OS (Not Supported)IBM z/Linux (Not Supported)

This property specifies the maximum number of lines to be printed per statistics table.

Be aware that increasing the value of this property will result in more log output. The value can be balanced with wrapper.stats.interval to observe performance over a period of time that is right for you, while keeping a reasonable number of rows per table.

Valid values are in the range of "1" to "60".

The default value is 10.

Example: Limit to 5 lines. 
wrapper.stats.lines=5

wrapper.stats.interval
Compatibility :3.5.52
Editions :Professional EditionStandard EditionCommunity Edition (Not Supported)
Platforms :WindowsMac OSX (Not Supported)Linux (Not Supported)IBM AIX (Not Supported)FreeBSD (Not Supported)HP-UX (Not Supported)Solaris (Not Supported)IBM z/OS (Not Supported)IBM z/Linux (Not Supported)

This property specifies the interval, in seconds, at which statistics are collected. The starting time and ending time of each interval can be visualized in the first column of the tables.

Valid values are in the range of "1-86400" (1 second - 1 day).

The default value is one third of the value of wrapper.shutdown.timeout (so 10 seconds by default).

NOTE

The CPU usage is calculated based on an average over the entire interval.

The Page Faults count (for the Java process) is the total number of page faults during an interval.

Examples:

Example 1: Intervals of one minute, for a total duration of one hour. 
wrapper.stats.interval=60
wrapper.stats.lines=60

Example 2: Intervals of one hour, for a total duration of one day, and printed everyday at midnight. 
wrapper.stats.interval=3600
wrapper.stats.lines=24
wrapper.timer.1.action=STATS
wrapper.timer.1.interval=hour=0

wrapper.stats_on_failed_jvm_exit
Compatibility :3.5.52
Editions :Professional EditionStandard EditionCommunity Edition (Not Supported)
Platforms :WindowsMac OSX (Not Supported)Linux (Not Supported)IBM AIX (Not Supported)FreeBSD (Not Supported)HP-UX (Not Supported)Solaris (Not Supported)IBM z/OS (Not Supported)IBM z/Linux (Not Supported)

This property controls whether statistics should be printed when the Wrapper detects that the JVM is hung. It is similar to wrapper.request_thread_dump_on_failed_jvm_exit, which causes a thread dumps in the same situation of a hung JVM.

When this property is set to TRUE, the statistics will be printed before the thread dumps (if requested), which itself happens before the JVM process is being terminated.

The default value is TRUE.