Use the commands in Table 8-2 to view problems and incidents and to create incidents.
Table 8-2 Incident Commands
Use this command... | To... | Use with WLST... |
---|---|---|
Create an aggregated incident, containing zip files that contain copies of incidents that match the specified criteria. |
Online |
|
Create a diagnostic incident. |
Online |
|
Retrieve the contents of the specified incident file. |
Online |
|
List the set of ADR Home paths. |
Online |
|
List a set of diagnostic incidents. |
Online |
|
List a set of diagnostic problems. |
Online |
|
List the incidents that meet the specified criteria. |
Online |
|
Reload all custom diagnostic rules or the specified rule. |
Online, Offline |
|
Show the details of a specified incident. |
Online |
Use with WLST: Online
Description
Creates an aggregated incident, containing zip files that contain copies of incidents that match the specified criteria.
Syntax
createAggregatedIncident(query [, servers])
Argument | Definition |
---|---|
query |
An expression composed of simple expressions, which can be connected by Boolean operators. An expression contains an incident attribute, an operator, and a string, in the following format: attribute operator "string" Simple expressions can be connected by the Boolean operators AND or OR, grouped by parentheses () The following incident attributes are supported:
Custom incident attributes are also supported. For example, TRACEID, APP, URI, AND DSID are supported. The following operators are supported:
|
servers |
The name of one or more servers to query. This argument is optional. If you do not specify it, the command operates on all servers in the domain. This option is only valid when you are connected to the Administration Server. |
Examples
The following example creates an aggregated incident for al incidents that contain the ODL_TRACE_ID of 123456 on the server wls_server1:
createAggregatedIncident(query="ORDL_TRACE_ID equals 123456", servers="wls_server1")
Incident 55 created, containing the following incidents:
Server wls_server1
Incident Id Problem Key Incident Time
15 TRACE [123456] [MANUAL] Mon Apr 15 11:22:12 EDT 2013
The following example creates an aggregated incident for al incidents that contain the ODL_TRACE_ID of 123456 on all servers in the domain:
createAggregatedIncident(query="ORDL_TRACE_ID equals 123456", servers="wls_server1")
Incident 55 created, containing the following incidents:
Server wls_server1, wls_server2
Incident Id Problem Key Incident Time
15 TRACE [123456] [MANUAL] Mon Apr 15 11:22:12 EDT 2013
Use with WLST: Online
Description
Creates a diagnostic incident, using the specified information to determine the set of diagnostic rules and actions to execute.
Syntax
createIncident([adrHome] [,incidentTime] [,messageId] [,ecid] [,appName] [,description] [,server])
Argument | Definition |
---|---|
adrHome |
The path for the ADR Home in which to create the incident. The ADR Home must exist. If this argument is not specified, the default ADR Home is used. The default ADR Home is the following location: ADR_BASE/diag/OFM/domain_name/server_name |
incidentTime |
The timestamp at which the incident occurred. If this not specified, the current time is used. You can specify the following:
|
messageId |
The ID of the error message. For example, MDS-50400. |
ecid |
The Execution Context ID for the error message. |
appNname |
The name of the deployed application for which the 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. |
description |
Descriptive text to associate with the incident. This is useful when reviewing the incident at a later time. |
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 creates an incident that is related to messages with the ID MDS-50400:
createIncident(messageId="MDS-50400", description="sample incident")
Incident Id: 3
Problem Id: 2
Problem Key: MDS-50400 [MANUAL]
Incident Time:Tue May 28 11:52:45 PDT 2013
Error Message Id: MDS-50400
Execution Context:null
Flood Controlled: false
Dump Files :
jvm_threads25_i3.txt
dms_metrics26_i3.txt
dfw_samplingArchive28_i3.readme.txt
odl_logs29_i3.txt
Use with WLST: Online
Description
Retrieves the contents of the specified incident file.
Syntax
getIncidentFile(id, name [,outputFile] [,adrHome] [,server])
Argument | Definition |
---|---|
id |
The ID of the incident that you want to retrieve. |
name |
The name of the file to retrieve. To find the name of the file, use the showIncident command. |
outputFile |
The name of the file to which to write the output. |
adrHome |
The path for the ADR Home from which to retrieve the information. If this argument is not specified, the default ADR Home will be queried. 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. |
Example
The following example writes the contents of the incident dms_metrics3_i1.dmp to the specified output file:
getIncidentFile(id='1', name='dms_metrics3_i1.dmp', outputFile='/tmp/incident1_dms.txt')
The content of 'dms_metrics3_i1.dmp'is written to /tmp/incident1_dms.txt
Use with WLST: Online
Description
Lists the paths of all of the ADR Homes for the server.
Syntax
listADRHomes([server])
Argument | Definition |
---|---|
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 the paths of the ADR homes:
listADRHomes()
diag/ofm/base_domain/AdminServer
diag/ofm/EMGC_DOMAIN/EMOMS
Use with WLST: Online
Description
Lists the set of diagnostic incidents for the given problem ID, if specified, or all available incidents.
Syntax
listIncidents([id] [, adrHome] [,server])
Argument | Definition |
---|---|
id |
The ID of the problem for which you want to list the set of diagnostic incidents. |
adrHome |
The path for the ADR Home from which to query incidents. If this argument is not specified, the default ADR Home will be queried. 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. |
Example
The following example lists the incidents associated with the problem with the ID 1
:
listIncidents(id="1")
Incident Id Incident Time Problem Key
2 Tue May 28 11:05:59 PDT 2013 MDS-50500 [MANUAL]
1 Tue May 28 11:02:22 PDT 2013 MDS-50500 [MANUAL]
Use with WLST: Online
Description
Lists the set of diagnostic problems associated with the specified ADR Home.
Syntax
listProblems([adrHome][,server])
Argument | Definition |
---|---|
adrHome |
The path for the ADR Home from which to query problems. If this argument is not specified, the default ADR Home will be queried. 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. |
Example
The following example lists the diagnostic problems in the default ADR home:
listProblems()
Problem Id Problem Key
1 MDS-50500 [MANUAL]
2 JOC-38922 [AdminServer] [oracle.cache.network]
Use with WLST: Online
Description
Lists the incidents that meet the specified criteria. You can query for the value of particular attributes across one or more servers, or all servers in a domain.
Syntax
queryIncidents(query [,servers])
Argument | Definition |
---|---|
query |
An expression composed of simple expressions, which can be connected by Boolean operators. An expression contains an incident attribute, an operator, and a string, in the following format: attribute operator "string" Simple expressions can be connected by the Boolean operators AND or OR, grouped by parentheses () The following incident attributes are supported:
Custom incident attributes are also supported. For example, TRACEID, APP, URI, AND DSID are supported. In addition, the context values, as shown in the incident readme.txt file, are supported. For example, DFW_APP_NAME and DFW_USER_NAME are supported. The following operators are supported:
|
servers |
The name of one or more servers to query. This argument is optional. If you do not specify it, the command operates on all servers in the domain. This option is only valid when you are connected to the Administration Server. |
Examples
The following example queries all incidents in the domain for the ECID f19wAgN000001:
queryIncidents(query="ECID equals f19wAgN000001")
The following example queries all incidents that occurred between April 1, 2013 and April 15, 2013, for the server wls_server1:
queryIncidents(query="TIMESTAMP from '2013-04-01 00:00'AND TIMESTAMP to '2013-04-15 00:00'", servers=["wls_server1"])
Use with WLST: Online, Offline
Description
Reloads all custom diagnostic rules or the specified custom diagnostic rule.
Syntax
reloadCustomRules([name] [, server])
Argument | Definition |
---|---|
name |
The name of a custom diagnostic rule. This argument is optional. If you specify it, only the named rule is reloaded. If you do not specify this argument, all custom diagnostic rules are reloaded. The file containing the custom diagnostic rule must be located in one of the following directories: DOMAIN_HOME/config/fmwconfig/dfw DOMAIN_HOME/config/fmwconfig/servers/server_name/dfw |
server |
The name of the server to which to reload the rules. This argument is optional. If you do not specify it, the rules are reloaded to all servers. This option is only valid when you are connected to the Administration Server. |
Example
The following example reloads the custom diagnostic rule myCustomRules.xml:
reloadCustomRules(name='myCustomRules.xml')
Use with WLST: Online
Description
Shows the details of the specified incident.
Syntax
showIncident(id, [adrHome][, server])
Argument | Definition |
---|---|
id |
The ID of the incident that you want to view. |
adrHome |
The path for the ADR Home from which to query the incident. If this argument is not specified, the default ADR Home will be queried. 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. |
Example
The following example displays information about the incident with the ID 10:
showIncident(id="10")
Incident Id: 10
Problem Id: 10
Problem Key: MDS-50500 [MANUAL]
Incident Time:Tue May 28 11:02:22 PDT 2013
Error Message Id: MDS-50500
Execution Context:
Flood Controlled: false
Dump Files :
readme.txt
jvm_threads10_i1.txt
dms_metrics11_i1.txt
dfw_samplingArchive13_i1.JVMThreadDump.txt
dfw_samplingArchive13_i1.readme.txt
odl_logs14_i1.txt
dms_metrics20_i1.txt