The Java Service Wrapper Configuration Files
The configuration files for the Java Service Wrapper reside in the following directory.
<SuiteInstallDir>/profiles/CTP/configuration
When you start Software AG Runtime, property settings in the following files determine the configuration of the JVM and the behavior of the logging and monitoring features of the Java Service Wrapper. For an overview of the Java Service Wrapper, see the webMethods cross-product document Working with the webMethods Product Suite and the Java Service Wrapper .
File name | Description |
wrapper.conf | Contains property settings that are installed for the Java Service Wrapper. Important: | Do not modify the contents of this file unless asked to do so by Software AG. |
|
custom_wrapper.conf | Contains properties that modify the installed settings in wrapper.conf. If you need to modify the property settings for the Java Service Wrapper, you make your changes in this file. |
Do not make any CentraSite configuration changes to the Java Service Wrapper other than the ones described in theCentraSite documentation.
JVM Configuration
When the Java Service Wrapper launches the JVM, it provides configuration settings that, among other things, specify the size of the Java heap, the size of the PermGen etc.
JVM Configuration Properties
The properties which starts with wrapper.java in the Java Service Wrapper configuration files determine the configuration of the JVM in which the Software AG Runtime runs.
You can modify the following JVM property settings to suit your needs. For procedures and additional information, see the webMethods cross-product document Working with the webMethods Product Suite and the Java Service Wrapper .
Property | Description |
wrapper.java.initmemory | Initial size (in MB) of the Java heap. |
wrapper.java.maxmemory | Maximum size (in MB) to which the Java heap can grow. |
wrapper.java.additional.n | Additional Java parameters to be passed in on the command line. Example -XX:MaxPermSize=256M |
Wrapper Log
The Java Service Wrapper records console output in a log file. The log contains the output sent to the console by the wrapper itself and by the JVM in which the Software AG Runtime is running. The wrapper log is especially useful when the Software AG Runtime runs as a Windows service, because console output is normally not available to you in this mode.
The Java Service Wrapper log for CentraSite is located in the following file:
<SuiteInstallDir>/profiles/CTP/logs/wrapper.log
To view the log, simply open the log file in a text editor.
Logging Properties
The properties start with wrapper.console and wrapper.log in the wrapper configuration files determine the content, format, and behavior of the wrapper log.
The logging settings that CentraSite installs are suitable for most environments. However, you can modify the following properties if the installed settings do not suit your needs. For procedures and additional information, see the webMethods cross-product document Working with the webMethods Product Suite and the Java Service Wrapper .
Property | Description |
wrapper.console.loglevel | Level of messages to display in the console. |
wrapper.console.format | Format of messages in the console. |
wrapper.logfile | File in which to log messages. |
wrapper.logfile.loglevel | Level of messages to write in the log file. |
wrapper.logfile.format | Format of messages in the log file. |
wrapper.logfile.maxsize | Maximum size to which the log can grow. |
wrapper.logfile.maxfiles | Number of old logs to maintain. |
wrapper.syslog.loglevel | Level of messages to write to the Event Log on Windows systems or the syslog on UNIX. |
Fault Monitoring
The Java Service Wrapper can monitor the JVM for the certain conditions and then restart the JVM or perform other actions when it detects these conditions.
The following table describes the fault-monitoring features CentraSite uses or allows you to configure. To learn more about these features, see the webMethods cross-product document Working with the webMethods Product Suite and the Java Service Wrapper .
Feature | Enabled? | User Configurable? |
JVM timeout | Yes | Yes. Do not change the installed settings unless asked to do so by Software AG. |
Deadlock detection | No | Yes. |
Console filtering | No | Yes. |
JVM Timeout Properties
The properties that start with wrapper.ping in the wrapper configuration files determine the ping interval and timeout period. To use timeout-detection with CentraSite, you can configure the following properties. For procedures and additional information, see the webMethods cross-product document Working with the webMethods Product Suite and the Java Service Wrapper .
Example:
The following simple example will configure the Wrapper to ping the JVM every 5 seconds and automatically restarts the JVM if it does not receive a response to a ping within 30 seconds.
wrapper.ping.timeout=30
wrapper.ping.interval=5
wrapper.ping.timeout.action=RESTART
Property | Value |
wrapper.ping.timeout | The length of time, in seconds, that the Java Service Wrapper waits for a response to a ping. If it does not receive a response in the specified time, it initiates the action specified in wrapper.ping.timeout.action. The default value is 30 seconds. If this value is modified, the preferred value for CentraSite is 60 seconds. Example wrapper.ping.timeout=60 |
wrapper.ping.interval | How often, in seconds, the Java Service Wrapper pings the JVM to determine whether it is active. The default value is 5 seconds. Example wrapper.ping.interval=5 |
wrapper.ping.timeout.action | The action that occurs if the Java Service Wrapper does not receive a response to a ping in the allotted time. The default action is RESTART. If this value is modified, the preferred value for CentraSite is DEBUG,DUMP,RESTART. Example wrapper.ping.timeout.action=DEBUG,DUMP,RESTART |
Deadlock-Detection Properties
The wrapper.check.deadlock properties in the wrapper configuration files determine whether the wrapper monitors the JVM for deadlocks and what action it takes when a deadlock occurs. To use deadlock-detection with CentraSite, you can configure the following properties. For procedures and additional information, see the webMethods cross-product document Working with the webMethods Product Suite and the Java Service Wrapper .
Example:
The following simple example will configure the Wrapper to log the location of a deadlock and then immediately restart the JVM.
wrapper.check.deadlock=TRUE
wrapper.check.deadlock.interval=60
wrapper.check.deadlock.action=RESTART
wrapper.check.deadlock.output=FULL
Property | Value |
wrapper.check.deadlock | Flag (TRUE or FALSE) that enables or disables deadlock detection. The default setting is FALSE. Example wrapper.check.deadlock=FALSE |
wrapper.check.deadlock.interval | How often, in seconds, the Java Service Wrapper evaluates the JVM for a deadlock condition. The default value is 60 seconds. Example wrapper.check.deadlock.interval=60 |
wrapper.check.deadlock.action | Action that occurs if the Java Service Wrapper detects a deadlock condition. Software AG recommends that you specify the DUMP, RESTART actions if you enable deadlock detection for CentraSite. The default action is RESTART. If this value is modified, the preferred value for CentraSite is DUMP,RESTART. Example wrapper.check.deadlock.action=DUMP,
RESTART |
wrapper.check.deadlock.output | Information to be logged if the Java Service Wrapper detects a deadlock condition.Software AG recommends that you specify the FULL output if you enable deadlock detection for CentraSite. The default output level is FULL. Example wrapper.check.deadlock.output=FULL |
Console Filtering Properties
The wrapper.filter properties in the wrapper configuration files determine whether the wrapper monitors the console for specified messages and what action it takes when a specified message occurs. To use console filtering with CentraSite, you can configure the following properties. For procedures and additional information, see the webMethods cross-product document Working with the webMethods Product Suite and the Java Service Wrapper .
Property | Value |
wrapper.filter.trigger.n | Required. String of text that you want to detect in the console output. Example wrapper.filter.trigger.1=
OutOfMemoryError |
wrapper.filter.action.n | Action that occurs when the Java Service Wrapper detects the string of text. The default action is RESTART. Example wrapper.filter.action.1=RESTART |
wrapper.filter.allow_wildcards.n | Flag (TRUE or FALSE) that specifies whether the Java Service Wrapper processes wildcard characters that appear in wrapper.filter.trigger.n. The default setting is FALSE. Example wrapper.filter.allow_wildcards.1=TRUE |
wrapper.filter.message.n | Message that displays when Java Service Wrapper detects the string of text. Example wrapper.filter.message.1=The JVM
has run out of memory. |
Generating a Thread Dump
The Java Service Wrapper provides a utility for generating a thread dump of the JVM when the Software AG Runtime is running as a Windows service. A thread dump can help you locate thread contention issues that can cause thread blocks or deadlocks.
For information about generating a thread dump using the Java Service Wrapper, see the webMethods cross-product document Working with the webMethods Product Suite and the Java Service Wrapper .
