7.5.2 Settings for using the user-extended trace based performance analysis
To use the user-extended trace based performance analysis, you must specify the following settings before you start the server:
-
J2EE server
-
Batch server
-
EJB client application
-
Settings for the methods to be traced by the user-extended trace based performance analysis
- Organization of this subsection
(1) J2EE server settings
Implement the J2EE server settings using the Easy Setup definition file.
Define the user-extended trace based performance analysis in the JavaVM startup parameter (add.jvm.arg) in the <configuration> tag of the logical J2EE server (j2ee-server) in the Easy Setup definition file.
The following table describes the definition of the user-extended trace based performance analysis in the Easy Setup definition file.
Item |
Specified parameter |
Settings |
---|---|---|
Settings to enable the user-extended trace based performance analysis |
jvm.userprf.Enable |
To use the user-extended trace based performance analysis, specify the settings to enable. |
Settings to specify the configuration file for the user-extended trace based performance analysis |
jvm.userprf.File#1 |
Specify the file path of the user-extended trace based performance analysis configuration file to be used for the user-extended trace based performance analysis. |
Settings related to application rewriting |
jvm.userprf.Limit |
Specify the maximum number of methods to be rewritten from the methods specified in the configuration file for the user-extended trace based performance analysis. Among the methods specified in the configuration file for the user-extended trace based performance analysis, the methods exceeding this value are not traced. |
jvm.userprf.Trace |
Specify whether log will be output when the class files specified in the configuration file for the user-extended trace based performance analysis are successfully rewritten. Note that if the rewriting of the class files fails, the log is necessarily output. |
|
Settings related to the output information of the user-extended trace based performance analysis |
jvm.userprf.ExtendedSetting#2 |
Specify whether the trace target can be specified for packages or classes in addition to methods. |
jvm.userprf.LineNumber |
Specify whether the line number of the line that the method executes last in the case of a normal exit, will be output to the trace information. |
|
jvm.userprf.ThrowableName |
Specify whether the exception or error class name will be output to the trace information. |
|
jvm.userprf.ThrowableNameEditMethod |
Specify how the name will be edited when the exception or error class name exceeds the limit of 32 characters. |
|
jvm.userprf.LogLevel |
Specify the trace output level of the user-extended trace based performance analysis. |
- #1
-
The default values are as follows:
In Windows
JDK-installation-directory\usrconf\userprf.cfg
In UNIX
/opt/Cosminexus/jdk/usrconf/userprf.cfg
- #2
-
The amount of methods to be traced increases due to the specification format of the user-extended trace based performance analysis configuration file permitted by setting up the jvm.userprf.ExtendedSetting property. Therefore, note that the amount of trace that is output increases and affects the system performance. For details on the notes for using the user-extended trace based performance analysis, see 7.8 Notes on using the user-extended trace based performance analysis.
For details on the Easy Setup definition file and the parameters to be specified, see 4.3 Easy Setup definition file in the uCosminexus Application Server Definition Reference Guide.
An example of definition is as follows:
... <param> <param-name>add.jvm.arg</param-name> <param-value>-Djvm.userprf.Enable=true</param-value> <param-value>-Djvm.userprf.File=Cosminexus-installation-directory/CC/server/usrconf/ejb/real-server-name/userprf.cfg</param-value> <param-value>-Djvm.userprf.LogLevel=class</param-value> </param> ...
- Reference note
-
You can also specify the J2EE server settings in the Start Parameter Settings window (defining the logical J2EE server) of the management portal. For details on how to specify the settings on the management portal, see 10.8.23 Startup parameter settings (J2EE server) in the uCosminexus Application Server Management Portal User Guide.
(2) Batch server settings
Implement the batch server settings using the Easy Setup definition file.
Define the user-extended trace based performance analysis in the JavaVM startup parameter (add.jvm.arg) in the <configuration> tag of the logical J2EE server (j2ee-server) in the Easy Setup definition file. For details on the parameter values to be specified, see (1) J2EE server settings.
(3) EJB client application settings
Implement the settings for an EJB client application, which is running with the cjclstartap command, using the option definition file for EJB client applications (usrconf.cfg).
Define the user-extended trace based performance analysis in the JavaVM startup parameter (add.jvm.arg) of the option definition file for EJB client applications (usrconf.cfg). For details on the parameter values to be specified, see (1) J2EE server settings.
An example of definition in the option definition file for EJB client applications (usrconf.cfg) is as follows:
... add.jvm.arg=-Djvm.userprf.Enable=true add.jvm.arg=-Djvm.userprf.File=user-definition-file-storage-directory#/userprf.cfg add.jvm.arg=-Djvm.userprf.LogLevel=class ...
- #
-
The directory specified in the user definition file storage destination environment variable (CJCLUSRCONFDIR). If the user definition file storage destination environment variable is not set, the current directory is referenced.
(4) Settings for the user-extended trace based performance analysis configuration file
To use the user-extended trace based performance analysis, you must create the configuration file for the user-extended trace based performance analysis and specify the settings for the methods to be traced.
Specify the settings for the methods to be traced in the UserPrfText parameter in the <configuration> tag of the logical J2EE server (J2EE-Server) in the Easy Setup definition file.
An example of definition is as follows:
... <param> <param-name>UserPrfText</param-name> <param-value> <![CDATA[ org.apache.struts.action.Action.execute(*), struts, true Info.getInfo(*), struts, true ]]> </param-value> </param> ...
For details on how to create the configuration file for the user-extended trace based performance analysis, see 7.5.3 Settings for the methods to be traced by the user-extended trace based performance analysis.
- Reference note
-
You can also set up the configuration file for the user-extended trace based performance analysis in the Start Parameter Settings window (defining the logical J2EE server) of the management portal or a user optional file (file specified in the jvm.userprf.File property).