7 DMS Custom WLST Commands

Use the Dynamic Monitoring Service (DMS) commands to view a specific performance metric, a set of performance metrics, or all performance metrics for a particular server or component.

For additional details about metrics, see the chapter "Monitoring Oracle Fusion Middleware" in the Oracle Fusion Middleware Administrator's Guide.

Note:

To use these commands, you must invoke WLST from the Oracle home in which the component has been installed. See "Using Custom WLST Commands" in the Oracle Fusion Middleware Administrator's Guide.

DMS Commands

Use the commands in Table 7-1 to view information about performance metrics.

Table 7-1 DMS Commands

Use this command...	To...	Use with WLST...
displayMetricTableNames	Displays the names of the available DMS metric tables.	Online
displayMetricTables	Displays the content of the DMS metric tables.	Online
dumpMetrics	Displays available metrics.	Online
reloadMetricRules	Reloads the metric rules.	Online

displayMetricTableNames

Use with WLST: Online

Description

Displays the names of the available DMS metric tables. The returned value is a string array containing metric table names.

Syntax

displayMetricTableNames([servers])

Argument	Definition
servers	Optional. Specifies the servers from which to retrieve metrics. Valid values are a list of WebLogic server names and OPMN-managed component names. To specify one server, use the following syntax: servers='servername' To specify multiple servers, use one of the following syntax options: servers=['servername1', 'servername2', ...] servers=('servername1', 'servername2', ...) If this argument is not specified, the command returns the list of metric table names from all WebLogic servers and OPMN-managed components.

Argument

Definition

servers

Optional. Specifies the servers from which to retrieve metrics. Valid values are a list of WebLogic server names and OPMN-managed component names.

To specify one server, use the following syntax:

servers='servername'

To specify multiple servers, use one of the following syntax options:

servers=['servername1', 'servername2', ...]
servers=('servername1', 'servername2', ...)

If this argument is not specified, the command returns the list of metric table names from all WebLogic servers and OPMN-managed components.

Example

The following example displays metric table names from all WebLogic servers and OPMN-managed components:

displayMetricTableNames()
ADF
ADFc
ADFc_Metadata_Service
ADFc_Region
ADFc_Taskflow
ADFc_Viewport
BAM_common_connectionpool
BAM_common_connectionpool_main
BAM_common_messaging
BAM_common_messaging_consumers
.
.
.

The following example displays metric table names for the WebLogic Managed Server called soa_server1:

displayMetricTableNames(servers='soa_server1')
ADF
JVM
JVM_ClassLoader
JVM_Compiler
JVM_GC
JVM_Memory
JVM_MemoryPool
JVM_MemorySet
JVM_OS
JVM_Runtime
.
.
.

The following example displays metric table names for two WebLogic Managed Servers:

displayMetricTableNames(servers=['soa_server1', 'bam-server1'])
ADF
ADFc
ADFc_Metadata_Service
ADFc_Region
ADFc_Taskflow
ADFc_Viewport
BAM_common_connectionpool
BAM_common_connectionpool_main
BAM_common_messaging
BAM_common_messaging_consumers
.
.
.

displayMetricTables

Use with WLST: Online

Description

Displays the content of the DMS metric tables.

The returned value is an array of JMX javax.management.openmbean.CompositeData objects. Each array element has the following fields:

The Table field is the metric table name.
The Schema field is a javax.management.openmbean.TabularData object containing the metric table schema information.
The Rows field is a javax.management.openmbean.TabularData object containing the metric table Rows.

The javax.management.openmbean.TabularData object for the metric table schema contains the following four fields:

The Column field contains the name of the column.
The Type field contains the type of the column value.
The Unit field contains the unit of the column.
The Description field contains the description of the column.

The javax.management.openmbean.TabularData object for the metric rows contains a field for every metric. It uses the metric name as the field name.

Syntax

displayMetricTables([metricTable_1], [metricTable_2], [...,] [servers] [variables])

Argument	Definition
metricTable_n	Optional. Specifies a list of metric tables. By default, this argument displays all available metrics. The metric table name can contain special characters for simple pattern. matching. The character '?' matches any single character. The character '*' matches zero or more characters. You specify the name of the metric, without an argument name. You can specify zero or more metric table names, in a comma-separated list.
servers	Optional. Specifies the servers from which to retrieve metrics. Valid values are a list of WebLogic server names and OPMN-managed component names. To specify one server, use the following syntax: servers='servername' To specify multiple servers, use one of the following syntax options: servers=['servername1', 'servername2', ...] servers=('servername1', 'servername2', ...) If this argument is not specified, the command returns the list of metric tables from all WebLogic servers and OPMN-managed components.
variables	Optional. Defines the metric aggregation parameters. Valid values are a set of name-value pairs in a Jython map. It uses the following syntax: variables={name1:value1, name2:value2, ...} The specific name-value pairs depend on the aggregated metric tables. Each aggregated metric table has its specific set of variable names.

Argument

Definition

metricTable_n

Optional. Specifies a list of metric tables. By default, this argument displays all available metrics. The metric table name can contain special characters for simple pattern. matching. The character '?' matches any single character. The character '*' matches zero or more characters.

You specify the name of the metric, without an argument name.

You can specify zero or more metric table names, in a comma-separated list.

servers

Optional. Specifies the servers from which to retrieve metrics. Valid values are a list of WebLogic server names and OPMN-managed component names.

To specify one server, use the following syntax:

servers='servername'

To specify multiple servers, use one of the following syntax options:

servers=['servername1', 'servername2', ...]
servers=('servername1', 'servername2', ...)

If this argument is not specified, the command returns the list of metric tables from all WebLogic servers and OPMN-managed components.

variables

Optional. Defines the metric aggregation parameters. Valid values are a set of name-value pairs in a Jython map. It uses the following syntax:

variables={name1:value1, name2:value2, ...}

The specific name-value pairs depend on the aggregated metric tables. Each aggregated metric table has its specific set of variable names.

Example

The following example displays the data from the JVM and the weblogic.management.runtime.WebAppComponentRuntimeMBean metric tables, and limits it to data retrieved from Server-0 and Server-2:

displayMetricTables('JVM','weblogic.management.runtime.WebAppComponentRuntimeMBean',
    servers=['soa_server1','bam_server1'])
.
.
.
ApplicationRuntime:     soa-infra
ComponentName:  /integration/services/IdentityService
ContextRoot:    /integration/services/IdentityService
DeploymentState:        2
FilterDispatchedRequestsEnabled:        false
IndexDirectoryEnabled:  false
JSPDebug:       false
JSPKeepGenerated:       false
JSPPageCheckSecs:       1
JSPVerbose:     true
ModuleId:       /integration/services/IdentityService
ModuleURI:      IdentityService.war
Name:   soa_server1_/integration/services/IdentityService
ObjectName:     com.bea:ApplicationRuntime=soa-infra,Name=soa_server1_/integration/services/IdentityService, 
 ServerRuntime=soa_server1,Type=WebAppComponentRuntime
OpenSessionsCurrentCount:       0
OpenSessionsHighCount:  0
.
.
.

The following example displays the aggregated metric tables with the specified metric aggregation parameters:

displayMetricTables('j2ee_application:webservices_port_rollup',
      servers=['soa_server1','bam_server1'],
      variables={'host':'hostname', 'servletName':'dms'})
----------------------------------------
j2ee_application:webservices_port_rollup
----------------------------------------
 
Faults: 0
Requests:       0
Requests.averageTime:   0.0
Requests.totalTime:     0.0
ServerName:     soa_server1
moduleName:     RuntimeConfigService
moduleType:     WEBs
portName:       RuntimeConfigServicePortSAML
processRequest.active:  0
service.throughput:     0.0
service.time:   0.0
startTime:      1238182359291
webserviceName: RuntimeConfigService
 
Faults: 0
Requests:       0
Requests.averageTime:   0.0
Requests.totalTime:     0.0
ServerName:     soa_server1
moduleName:     TaskMetadataService
moduleType:     WEBs
portName:       TaskMetadataServicePort
processRequest.active:  0
service.throughput:     0.0
service.time:   0.0
startTime:      1238182358096
webserviceName: TaskMetadataService
.
.
.

The following example displays the metric tables which names match the specified patterns:

displayMetricTables('J??', 'JVM_*')
.
.
.
---------------
JVM_ThreadStats
---------------
 
Host:   hostname.us.oracle.com
JVM:    JVM
Name:   threads
Parent: /JVM/MxBeans
Process:        AdminServer:9001
ServerName:     AdminServer
contention.value:       enabled in JVM
daemon.value:   60      threads
deadlock.value: 0       threads
live.value:     61      threads
peak.value:     66      threads
started.value:  241     threads
 
Host:   hostname.us.oracle.com
JVM:    JVM
Name:   threads
Parent: /JVM/MxBeans
Process:        soa_server1:9001
ServerName:     soa_server1
contention.value:       enabled in JVM
daemon.value:   68      threads
deadlock.value: 0       threads
live.value:     74      threads
peak.value:     74      threads
started.value:  105     threads
.
.
.

dumpMetrics

Use with WLST: Online

Description

Displays available metrics in the internal format or in XML. The returned value is a text document.

Syntax

dumpMetrics([servers,] [format])

Argument	Definition
servers	Optional. Specifies the servers from which to retrieve metrics. Valid values are a list of WebLogic server names and OPMN-managed component names. To specify one server, use the following syntax: servers='servername' To specify multiple servers, use one of the following syntax options: servers=['servername1', 'servername2', ...] servers=('servername1', 'servername2', ...) If this argument is not specified, the command returns the list of metric tables from all WebLogic servers and OPMN-managed components.
format	Optional. Specifies the command output format. Valid values are 'raw' (the default) and 'xml'. For example: format='raw' format='xml' DMS raw format is a simple metric display format; it displays one metric per line.

Argument

Definition

servers

Optional. Specifies the servers from which to retrieve metrics. Valid values are a list of WebLogic server names and OPMN-managed component names.

To specify one server, use the following syntax:

servers='servername'

To specify multiple servers, use one of the following syntax options:

servers=['servername1', 'servername2', ...]
servers=('servername1', 'servername2', ...)

If this argument is not specified, the command returns the list of metric tables from all WebLogic servers and OPMN-managed components.

format

Optional. Specifies the command output format. Valid values are 'raw' (the default) and 'xml'. For example:

format='raw'
format='xml'

DMS raw format is a simple metric display format; it displays one metric per line.

Example

The following example outputs all available metrics, including native WebLogic Server metrics and internal DMS metrics, in the XML format:

dumpMetrics(format='xml')
<table name='weblogic_j2eeserver:jvm' keys='ServerName serverName'
 componentId='bam_server1' cacheable='false'>
<row cacheable='false'>
<column name='serverName'><![CDATA[bam_server1]]></column>
<column name='nurserySize.value' type='DOUBLE'>0.0</column>
<column name='jdkVersion.value'><![CDATA[1.6.0_05]]></column>
<column name='jdkVendor.value'><![CDATA[BEA Systems, Inc.]]></column>
<column name='daemonThreads.active' type='LONG'>68</column>
<column name='cpuUsage.percentage' type='DOUBLE'>100.0</column>
<column name='threads.active' type='LONG'>71</column>
<column name='ServerName'><![CDATA[bam_server1]]></column>
<column name='heapUsed.value' type='DOUBLE'>0.0</column>
</row>

The following example outputs metrics from Server-0 in the default raw format:

dumpMetrics(servers='Server-0')
.
.
.
    /JVM/MxBeans/threads/Thread-44 [type=JVM_Thread]
     ECID.value:        null
     RID.value: null
     blocked.value:     0       msec
     blockedCount.value:        1       times
     cpu.value: 40      msecs
     lockName.value:    null
     lockOwnerID.value: null
     lockOwnerName.value:       null
     name.value:        LDAPConnThread-0 ldap://10.229.149.27:7001
     state.value:       RUNNABLE
     waited.value:      0       msec
     waitedCount.value: 0       times
    /JVM/MxBeans/threads/Thread-45 [type=JVM_Thread]
     ECID.value:        null
     RID.value: null
     blocked.value:     0       msec
.
.
.

The following example outputs metrics from Server-0 and Server-1 in XML format:

dumpMetrics(servers=['soa_server1', 'bam_server1'], format='xml')
<table name='oracle_soainfra:high_latency_sync_composites' keys='ServerName
 soainfra_composite soainfra_composite_revision soainfra_domain'
 componentId='bam_server1' cacheable='false'>
</table>
<table name='weblogic_j2eeserver:ejb_transaction' keys='ServerName appName
 ejbModuleName name serverName' componentId='bam_server1' cacheable='false'>
<row cacheable='false'>
<column name='serverName'><![CDATA[bam_server1]]></column>
<column name='name'><![CDATA[MessagingClientParlayX]]></column>
<column name='ejbTransactionCommit.percentage' type='DOUBLE'>0.0</column>
<column name='ejbTransactionRollback.completed' type='LONG'>0</column>
<column name='ejbTransactionTimeout.throughput' type='DOUBLE'>0.0</column>
<column name='ejbTransactionCommit.completed' type='LONG'>0</column>
<column name='ejbTransactionTimeout.completed' type='LONG'>0</column>
<column name='appName'><![CDATA[usermessagingserver]]></column>
<column name='ejbTransactionRollback.throughput' type='DOUBLE'>0.0</column>
<column name='ServerName'><![CDATA[bam_server1]]></column>
<column name='ejbTransactionCommit.throughput' type='DOUBLE'>0.0</column>
<column name='ejbModuleName'><![CDATA[sdpmessagingclient-ejb-parlayx.jar]]></column>
</row>
.
.
.

reloadMetricRules

Use with WLST: Online

Description

Reloads the metric rules. You must run this command after you deploy OPMN-managed components or after you modify metric rules. Generally, Oracle does not recommend that you modify metric rules.

Syntax

reloadMetricRules([servers])

Argument	Definition
servers	Optional. Specifies the servers that should reload their metric rules. Valid values are a list of WebLogic server names and OPMN-managed component names. To specify one server, use the following syntax: servers='servername' To specify multiple servers, use the following syntax: servers=['servername1', 'servername2', ...] servers=('servername1', 'servername2', ...) If this argument is not specified, the command reloads the metric rules for all WebLogic servers and OPMN-managed components.

Argument

Definition

servers

Optional. Specifies the servers that should reload their metric rules. Valid values are a list of WebLogic server names and OPMN-managed component names.

To specify one server, use the following syntax:

servers='servername'

To specify multiple servers, use the following syntax:

servers=['servername1', 'servername2', ...]
servers=('servername1', 'servername2', ...)

If this argument is not specified, the command reloads the metric rules for all WebLogic servers and OPMN-managed components.

Example

The following example reloads metric rules at the specified Managed Server:

reloadMetricRules(servers='soa_server1')
Location changed to domainRuntime tree. This is a read-only tree with DomainMBean
 as the root. 
For more help, use help(domainRuntime)
 
loaded 'server-oracle_eps_server-11.0.xml'
loaded 'server-weblogic_j2eeserver-11.0.xml'
loaded 'server-oracle_bamweb-11.0.xml'
loaded 'server-oracle_federation-11.0.xml'
loaded 'server-portal-11.0.xml'
loaded 'server-weblogic_j2ee_application_webcenter-11.0.xml
.
.
.