6.2 DMS Metric Commands

Use the commands in Table 6-3 to view information about 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 Administering Oracle Fusion Middleware and the chapter "Using the Oracle Dynamic Monitoring Service" in Tuning Performance.

Table 6-3 DMS Metric Commands

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

6.2.1 displayMetricTableNames

Command Category: DMS Metrics

Use with WLST: Online

Description

Displays the names of the available DMS metric tables. The returned value is a list of 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 instance names and system 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 for all WebLogic servers and system components. For system components, such as Oracle HTTP Server, use the following format: servers=['component_name], servertype='component_type')

Argument

Definition

servers

Optional. Specifies the servers from which to retrieve metrics. Valid values are a list of WebLogic Server instance names and system 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 for all WebLogic servers and system components.

For system components, such as Oracle HTTP Server, use the following format:

servers=['component_name], servertype='component_type')

Examples

The following example displays metric table names for all WebLogic servers and system 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 wls_server1:

displayMetricTableNames(servers='wls_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=['wls_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
.
.
.

The following example displays the metric table names for the Oracle HTTP Server instance ohs_1:

displayMetricTableNames(servers='ohs_1', servertype='OHS')

6.2.2 displayMetricTables

Command Category: DMS Metrics

Use with WLST: Online

Description

Displays the content of the DMS metric tables.

The returned value is list of DMS metric tables, with the following information about each table:

The metric table name.
The metric table schema information.
The metric table Rows.

The metric table schema information contains the following:

The name of the column.
The type of the column value.
The unit of the column.
The description of the column.

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 metric table name. You can specify multiple metric table names in a comma-separated list. These are the same names output by the WLST command displayMetricTableNames.
servers	Optional. Specifies the servers from which to retrieve metrics. Valid values are a list of WebLogic Server instance names and system 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 for all WebLogic servers and system components. For system components, such as Oracle HTTP Server, use the following format: servers=['component_name], servertype='component_type')
variables	Optional. Defines the metric aggregation parameters. Valid values are a set of name-value pairs. 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 metric table name. You can specify multiple metric table names in a comma-separated list.

These are the same names output by the WLST command displayMetricTableNames.

servers

Optional. Specifies the servers from which to retrieve metrics. Valid values are a list of WebLogic Server instance names and system 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 for all WebLogic servers and system components.

For system components, such as Oracle HTTP Server, use the following format:

servers=['component_name], servertype='component_type')

variables

Optional. Defines the metric aggregation parameters. Valid values are a set of name-value pairs. 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.

Examples

The following example displays the data from the JVM and the weblogic.management.runtime.WebAppComponentRuntimeMBean metric tables, and limits it to data retrieved from wls_server1 and wls_server2:

displayMetricTables('JVM','weblogic.management.runtime.WebAppComponentRuntimeMBean',
    servers=['wls_server1','wlsserver2'])
.
.
.

---
JVM
---
 
Host:   host.example.com
Name:   JVM
Parent: /
Process:        wls_server_2:7004
ServerName:     wls_server_2
activeThreadGroups.maxValue:    8.0     groups
activeThreadGroups.minValue:    7.0     groups
activeThreadGroups.value:       8       groups
activeThreads.maxValue: 58.0    threads
activeThreads.minValue: 39.0    threads
activeThreads.value:    57      threads
freeMemory.maxValue:    174577.0        kbytes
freeMemory.minValue:    12983.0 kbytes
freeMemory.value:       98562   kbytes
startTime.value:        1368467917680   msecs
.
.
.

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

displayMetricTables('j2ee_application:webservices_port_rollup',
      servers=['wls_server1','ls_server1'],
      variables={'host':'hostname', 'servletName':'dms'})
----------------------------------------
j2ee_application:webservices_port_rollup
----------------------------------------
 
Faults: 0
Requests:       0
Requests.averageTime:   0.0
Requests.totalTime:     0.0
ServerName:     wls_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:     wls_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.com
JVM:    JVM
Name:   threads
Parent: /JVM/MxBeans
Process:        AdminServer:7001
ServerName:     AdminServer
contention.value:       enabled in JVM
daemon.value:   85      threads
deadlock.value: 0       threads
live.value:     89      threads
peak.value:     95      threads
started.value:  836     threads
.
.
.

6.2.3 dumpMetrics

Command Category: DMS Metrics

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 instance names and system 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 for all WebLogic servers and system components. For system components, such as Oracle HTTP Server, use the following format: servers=['component_name], servertype='component_type')
format	Optional. Specifies the command output format. Valid values are 'raw' (the default), 'xml, and 'pdml'. For example: format='raw' format='xml' format='pdml' 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 instance names and system 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 for all WebLogic servers and system components.

For system components, such as Oracle HTTP Server, use the following format:

servers=['component_name], servertype='component_type')

format

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

format='raw'
format='xml'
format='pdml'

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

Examples

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='wls_server1' cacheable='false'>
<row cacheable='false'>
<column name='serverName'><![CDATA[wls_server2]]></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[wls_server2]]></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://host: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 wls_server1 and wls_server2 in XML format:

dumpMetrics(servers=['wls_server1', 'wls_server2'], format='xml')
<table name='oracle_soainfra:high_latency_sync_composites' keys='ServerName
 soainfra_composite soainfra_composite_revision soainfra_domain'
 componentId='wls_server2' cacheable='false'>
</table>
<table name='weblogic_j2eeserver:ejb_transaction' keys='ServerName appName
 ejbModuleName name serverName' componentId='wls_server2' cacheable='false'>
<row cacheable='false'>
<column name='serverName'><![CDATA[wls_server2]]></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[wls_server2]]></column>
<column name='ejbTransactionCommit.throughput' type='DOUBLE'>0.0</column>
<column name='ejbModuleName'><![CDATA[sdpmessagingclient-ejb-parlayx.jar]]></column>
</row>
.
.
.

6.2.4 reloadMetricRules

Command Category: DMS Metrics

Use with WLST: Online

Description

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

Syntax

reloadMetricRules()

Example

The following example reloads metric rules for all servers running in the domain:

reloadMetricRules()
Location changed to domainRuntime tree. This is a read-only tree with DomainMBean
 as the root. 
For more help, use help(domainRuntime)
loaded 'server-mds-11.0.xml'
loaded 'server-weblogic_j2ee_application_webservices-11.0.xml'
loaded 'server-weblogic_j2eeserver_adf-11.0.xml'
loaded 'server-weblogic_soa_composite-11.0.xml'
loaded 'server-weblogic_j2eeserver_webservices-11.0.xml'
loaded 'server-oracle_sdpmessaging-11.0.xml'
loaded 'server-weblogic_j2ee_application_webcenter-11.0.xml'
loaded 'server-weblogic_j2eeserver-11.0.xml'
reloaded metric rules for server 'wls_server_1'

.
.
.