Program guide > Troubleshoot
Use trace to monitor and troubleshoot the environment. You must provide trace for a server when you work with IBM support.
Enable trace can help you monitor and fix problems in your deployment of WebSphere eXtreme Scale.
- Trace within a WAS environment
See the WebSphere Application Server Information Center for more information.
- Trace on the stand-alone catalog or container server
You can enable trace from server start in two ways. Trace can be set from the startOgServer command or from a server properties file.
- Enable trace from the startOgServer command
You can set trace on a catalog service or container server by using the -traceSpec and -traceFile parameters. For example: startOgServer.sh catalogServer -traceSpec ObjectGridPlacement=all=enabled -traceFile /home/user1/logs/trace.log
The -traceFile parameter is optional. If you do not set a -traceFile location, the trace file goes to the same location as the SystemOut logs.
See Start stand-alone servers for more details on starting servers.
- Enable trace from a properties file
To enable trace from a properties file, create a file, such as a server.properties file, with the following contents:
workingDirectory=<directory> traceSpec=<trace_specification> systemStreamToFileEnabled=true
The workingDirectory property is the root directory for the logs and optional trace file. WebSphere eXtreme Scale creates a directory with the name of the catalog or container server with a SystemOut.log file, a SystemErr.log file, and a trace file if trace was enabled with the traceSpec option. If the workingDirectory is not set, the default working directory is the location used to start the servers, such as <eXtremeScale_home>/bin.
To use a properties file during server startup, use the -serverProps option and provide the server properties file location.
See Starting stand-alone servers and Server properties file<add link> for more information.
- Trace on the catalog service
You can set trace on a catalog service by using the -traceSpec and -traceFile parameters during catalog service startup. For example:
startOgServer.sh catalogServer -traceSpec ObjectGridPlacement=all=enabled -traceFile /home/user1/logs/trace.log
If you start the catalog service in the <eXtremeScale_home>/bin directory, the logs and trace files will be in a logs/<catalog_service_name> directory in the bin directory. See Start the catalog service process in a stand-alone environment for more details on starting a catalog service.
- Trace on a stand-alone container
You can enable trace on a container server in two ways. You can create a server properties file as explained in the logs section, or you can enable trace by using the command line on startup. To enable container trace with a server properties file, update the traceSpec property with the required trace specification. To enable container trace using start parameters, use the -traceSpecand -traceFile parameters. For example:
startOgServer.sh c0 -objectGridFile ../xml/myObjectGrid.xml -deploymentPolicyFile ../xml/myDepPolicy.xml -catalogServiceEndpoints server1.rchland.ibm.com:2809 -traceSpec ObjectGridPlacement=all=enabled -traceFile /home/user1/logs/trace.log
If you start the server in the <eXtremeScale_home>/bin directory, the logs and trace files are in the logs/<server_name> directories in the bin directory See Start container processes for more information.
- Trace with the ObjectGridManager interface
Another option is to set trace during run time on an ObjectGridManager interface. Setting trace on an ObjectGridManager interface can be used to get trace on an eXtreme Scale client while it connects to an eXtreme Scale and commits transactions.
To set trace on an ObjectGridManager interface, supply a trace specification and a trace log.
ObjectGridManager manager = ObjectGridManagerFactory.getObjectGridManager(); ... manager.setTraceEnabled(true); manager.setTraceFileName("logs/myClient.log"); manager.setTraceSpecification("ObjectGridReplication=all=enabled");
- Enable trace with the xsadmin utility
To enable trace with the xsadmin utility, use the setTraceSpec option. Use the xsadmin utility to enable trace on a stand-alone environment during run time instead of during startup. You can enable trace on all servers and catalog services or you can filter the servers based on the ObjectGrid name, and so on. For example, to enable ObjectGridReplication trace with access to the catalog service server, run:
<eXtremeScale_home>/bin>xsadmin.bat -setTraceSpec "ObjectGridReplication=all=enabled"
You can also disable trace by setting the trace specification to *=all=disabled.See Use the xsAdmin sample utility for more information.
- ffdc directories and files
FFDC files are for IBM support to aid in debug. These files might be requested by IBM support if a problem occurs. These files are in a directory labeled, ffdc, and contain files that resemble the following:
Troubleshoot client connectivity
IBM Support Assistant for WebSphere eXtreme Scale