Use the commands in Table 8-3 to display information about dumps and to execute dumps.
Table 8-3 Diagnostic Dump Commands
Use this command... | To... | Use with WLST... |
---|---|---|
Display a description of the specified diagnostic dump. |
Online |
|
Execute the specified diagnostic dump. |
Online |
|
Display the set of diagnostic dumps that can be executed. |
Online |
Use with WLST: Online
Description
Displays a description of the specified diagnostic dump.
Syntax
describeDump(name [,appName] [.server])
Argument | Definition |
---|---|
name |
The name of the dump for which to display information. |
appName |
The name of the deployed application for which information is gathered. For example, if you have multiple ADF applications deployed, each may register a dump called adf.dump. To execute this command for a specific application, you must specify the application name. |
server |
The name of the Managed Server from which to collect information. This argument is valid only when you are connected to the Administration Server. |
Example
The following example displays information about the dump with the name odl.logs. You use the listDumps command to retrieve the list of available dumps.
describeDump(name="odl.logs")
Name: odl.logs
Description: Dump contents of diagnostic logs
Run Mode: asynchronous
Mandatory Arguments:
Optional Arguments:
Name Type Description
match_all BOOLEAN Whether to match both ECID and time range or any one of them.
timestamp LONG Log message timestamp in milliseconds
ecid STRING Log message execution context ID (ecid)
exclude_access_logs BOOLEAN Excludes access logs from dump.
timerange LONG Time range in minutes
Use with WLST: Online
Description
Executes the specified diagnostic dump.
Syntax
executeDump(name [,args] [,outputFile] [,id] [,adrHome] [,server])
Argument | Definition |
---|---|
name |
The name of the diagnostic dump to execute. |
args |
Mandatory or optional arguments to pass to the dump. |
outputFile |
The name of the file to which to write the dump. If you do not specify this argument, the output is written to the console. |
id |
The ID of the incident to which to associate the dump. By default, the specified dump will not be associated with an incident. |
adrHome |
The ADR home that contains the incident. If you do not specify this argument, the default ADR home is used. The default ADR Home is the following location: ADR_BASE/diag/OFM/domain_name/server_name |
server |
The name of the Managed Server from which to collect information. This argument is valid only when you are connected to the Administration Server. |
Arguments that are either required or are optional can be specified using the "args" keyword. For example:
executeDump("java.sysprops",args={"prop" : "os.name"})
Examples
The following example executes the dump with the name jvm.threads and writes it to the file dumpout.txt:
executeDump(name="jvm.threads", outputFile="/tmp/dumpout.txt")
Diagnostic dump jvm.threads output written to /tmp/dumpoutput.txt
The following example executes the dump with the name jvm.threads and the Incident ID for 33 and writes it to the file dumpout.txt:
executeDump(name="jvm.threads", outputFile="/tmp/dumpout.txt", id="33")
Diagnostic dump jvm.threads output associated with incident 33 in ADR Home diag/ofm/base_domain/AdminServer
The following example executes a dump with the argument prop
set to the value os.name
:
executeDump(name="java.sysprops",args={"prop" : "os.name"})
Use with WLST: Online
Description
Displays the set of diagnostic dumps that can be executed.
Syntax
listDumps([appName] [,server])
Argument | Definition |
---|---|
appName |
The name of a deployed application for which diagnostics are being gathered. For example, if you have multiple ADF applications deployed, each may register a dump called adf.dump. To execute this command for a specific application, you must specify the application name. If you specify this argument, the command returns the dumps for the specified application. If you do not specify this argument, the command returns the system dumps. |
server |
The name of the Managed Server from which to collect information. This argument is valid only when you are connected to the Administration Server. |
Example
The following example lists all of the available dumps.
listDumps()
adf.DiagnosticsJarsVersionDump
dfw.samplingArchive
dms.configuration
dms.ecidctx
dms.metrics
http.requests
jvm.classhistogram
jvm.threads
mds.MDSInstancesDump
odl.activeLogConfig
odl.logs
odl.quicktrace
opss.diagTest
opss.identityStoreUserRoleApiConfig
opss.securityContext
wls.image
Use the command describeDump(name=<dumpName>) for help on a specific dump.