Skip Headers
Oracle® Fusion Middleware WebLogic Scripting Tool Command Reference
11g Release 2 (11.1.2)

Part Number E28155-03
Go to Documentation Home
Home
Go to Table of Contents
Contents
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

6 DMS Custom WLST Commands

Use the Dynamic Monitoring Service (DMS) commands in the categories in Table 6-1 to view performance metrics and to configure Event Tracing.

Note:

To use these DMS custom WLST commands, you must invoke the WLST script from the Oracle Common home. See "Using Custom WLST Commands" in the Oracle Fusion Middleware Administrator's Guide.

Table 6-1 DMS Command Categories

Command category Description

DMS Metric Commands

View information about performance metrics.

DMS Event Tracing Commands

Configure Event Tracing


DMS Metric Commands

Use the commands in Table 6-2 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 the Oracle Fusion Middleware Administrator's Guide and the appendix "Instrumenting Applications with DMS" in the Oracle Fusion Middleware Performance Guide.

Table 6-2 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

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.


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 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

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.

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 soa_server1 and bam_server1:

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.example.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.example.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

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.

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='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 soa_server1 and bam_server1 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

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-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
.
.
.

DMS Event Tracing Commands

Use the commands in Table 6-3 to configure Event Tracing. Event Tracing configures live tracing with no restarts. DMS metrics that were updated using Oracle Fusion Middleware products may be traced using the DMS Event Tracing feature.

For information about using DMS Event Tracing, see "DMS Tracing and Events" in the Oracle Fusion Middleware Performance Guide.

Table 6-3 DMS Tracing Commands

Use this command... To... Use with WLST...

addDMSEventDestination

Add a new destination to the Event Tracing configuration.

Online

addDMSEventFilter

Add a filter to the Event Tracing configuration.

Online

addDMSEventRoute

Adds the specified event route to the Event Tracing configuration

Online

enableDMSEventTrace

Enable an event trace and create a filter with a specified condition and destination and an enabled event-route.

Online

listDMSEventConfiguration

Display an overview of the event tracing configuration.

Online

listDMSEventDestination

Display the full configuration for a destination or a list of all destinations.

Online

listDMSEventFilter

Displays the configuration of a filter or a list of all filters.

Online

listDMSEventRoutes

Displays event routes and their status (enabled or disabled).

Online

removeDMSEventDestination

Removes the specified destination.

Online

removeDMSEventFilter

Removes the specified filter.

Online

removeDMSEventRoute

Removes the specified event route.

Online

updateDMSEventDestination

Updates configuration of an event destination.

Online

updateDMSEventFilter

Updates the configuration of an event filter.

Online

updateDMSEventRoute

Updates the configuration of an event route.

Online


addDMSEventDestination

Command Category: DMS Event Tracing

Use with WLST: Online

Description

Adds a new destination to the Event Tracing configuration. If a destination with the same ID already exists, the command reports this and does not add the destination. You must be connected to the Administration Server to add a destination. If you are not, an error is returned.

Syntax

addDMSEventDestination(id=id [, name=dest_name] ,class=class_name
              [, props= {'name': 'value'...}] [,server=server_name])
Argument Definition
id

The unique identifier for the specified destination.

name

Optional. A name for the destination.

class

The full class name of the destination.

See Table 6-4 for a list of available classes.

props

Optional. The name/value properties to use for the destination. Some destinations require properties. For example, the LoggerDestination class requires the property loggerName.

See addDMSEventFilter for information about the syntax and allowed values.

server

Optional. The server on which to perform this operation. The default is the server to which you are connected.


Table 6-4 shows the built-in destinations, with the full runtime class name.

Table 6-4 Built-In Destinations

Runtime Destination Class Name Description

oracle.dms.trace2.runtime.LoggerDestination

Uses ODL to send the log messages to a file.

oracle.dms.event.HTTPRequestTrackerDestination

Dumps the set of active HTTP requests, allowing an administrator to get a snapshot of activity.

oracle.dms.jrockit.jfr.JFRDestination

Passes events to the JRockit Flight Recorder so that they can be viewed in the context of other data coming from the JRockit JVM and WLDF using JRockit Mission Control.

oracle.dms.jmx.MetricMBeanFactory

Exposes Nouns as MBeans.

oracle.dms.util.StackTraceCollatorDestination

Collates the stack traces that are in play whenever the events of interest occur. This is primarily a debugging tool.

The collated data is written out on shutdown, and also when an event being handled has not been reported for a certain period of time (defaults to one minute).


Examples

The following example adds a destination with the ID jfr, the name Flight-Recorder, and the class oracle.dms.event.JRockitFlightRecorder:

addDMSEventDestination(id='jfr', name='Flight-Recorder',
                             class='oracle.dms.event.JRockitFlightRecorder')

Destination "jfr" added.

The following example adds a destination with the ID destination1, the name File-system, the class oracle.dms.trace2.runtime.LoggerDestination. Because the LoggerDestination requires the property loggerName, it sets the value to trace2-logger:

addDMSEventDestination(id='destination1', name='File-system',
                        class='oracle.dms.trace2.runtime.LoggerDestination', 
                        props={'loggerName': 'trace2-logger'})
 
Destination "destination1" added. 

The following example attempts to add a destination with an ID that already exists:

addDMSEventDestination(id='destination1', name='File-system',
                        class='oracle.dms.trace2.runtime.LoggerDestination', 
                        props={'loggerName': 'trace2-logger'})
 
Destination "destination1" already exists. Unable to add this.

addDMSEventFilter

Command Category: DMS Event Tracing

Use with WLST: Online

Description

Adds a filter to the Event Tracing configuration. If a filter with the same ID already exists, the command returns an error and does not add the filter.

You must be connected to the Administration Server to add an event filter. If you are not, an error message is reported.

Syntax

addDMSEventFilter(id=id [, name=name] [, etypes] 
                   , props= {'prop-name': 'value'...} 
                   [, server=server_name])
Argument Definition
id

The unique identifier for specified filter.

name

Optional. The name of the filter.

etypes

Optional. A string containing a comma-separated list of event/action pairs. This argument allows you to create a filter with a broader granularity when used with a condition. It also allows you to create a filter with a broader range of metrics. For example, all nouns or all nouns with the action create.

props

prop-name: The name of the filter property. <condition> is the only valid property, and only one condition may be specified.

value: The value of the property of the filter.

server

Optional. The server on which to perform this operation. The default is the server to which you are connected.


The following shows the syntax for etypes:

<etypes>:==
<type>:[<action>]

The following lists the valid etypes:

EXECUTION_CONTEXT
EXECUTION_CONTEXT:START
EXECUTION_CONTEXT:STOP
HTTP_REQUEST
HTTP_REQUEST:START
HTTP_REQUEST:STOP
NOUN
NOUN:CREATE
NOUN:DELETE
STATE_SENSOR
STATE_SENSOR:CREATE
STATE_SENSOR:DELETE

The following shows an etype with two event/action pairs, separated by a comma:

etypes='NOUN:DELETE, STATE_SENSOR:DELETE'

The following shows the syntax for the <condition> property of the argument props. The arguments are described in the tables following the syntax:

<condition>::=
<type>  [<operator> <condition>]
<type>::=  
<nountype> | <context>
<nountype>::=
NOUNTYPE <nountype-operator> value
<nountype-operator>::=
"equals" | "starts_with" | "contains" | "not_equals"
<context>::=
CONTEXT <name> <context-operator> [<value>] [IGNORECASE=true|false] [DATATYPE="string|long|double"
]
<context-operator>::=
"equals" | "starts_with" | "contains" | "not_equals" | "is_null" | "gt" | "le" | "ge"
<operator>::=
 AND |OR 

The following table describes the arguments for <type>:

Value Description
<nountype>

Each Sensor, with its associated metric, is organized in a hierarchy according to Nouns. A Noun type is a name that reflects the set of metrics being collected. For example, JDBC could be a Noun type. For information about Sensors and Nouns, see "Understanding DMS Terminology (Nouns and Sensors)" in the Oracle Fusion Middleware Performance Guide

<context>

An Execution Context is an association of the Execution Context ID (ECID), Relationship ID (RID), and Maps of Values. This argument allows the data stored in the map of values to be inspected and used by the filter. For example, if the map contains the key "user", you can create a filter that returns requests with "user" equal to "bruce".


The following table describes the arguments for <nountype>:

Value Description
NOUNTYPE

A keyword.

<nountype-operator>

The following are valid operators:

  • equals: Filters only if the Noun type name equals the value.

  • starts_with: Filters only if the Noun type name starts with the value.

  • contains: Filters only if the Noun type name equals the value.

  • not_equals: Filters only if the Noun type name does not equal the value.

value

The name of the Noun type on which to operate. The name can be any object for which you want to measure performance.


The following table describes <context>

Value Description
CONTEXT

A keyword.

name

The name of the context to filter.

value

The name of the context on which to operate.

<context-operator>

The following are valid operators:

  • equals: Filters only if the context name equals the value.

  • starts_with: Filters only if the context name starts with the value.

  • contains: Filters only if the context name equals the value.

  • not_equals: Filters only if the context name does not equal the value.

  • is_null: Filters only if the context name is null.

  • lt: Filters only if the context name is less than the value.

  • gt: Filters only if the context name is greater than the value.

  • le: Filters only if the context name is less than or equal to the value.

  • ge: Filters only if the context name is greater than or equal to the value.

IGNORECASE

Optional. If specified, the case of the value is ignored.

DATATYPE

Optional. The valid values are string, long, or double. The default is string.


Examples

The following example adds a filter with the name MyFilter, specifying a Noun type and context:

addDMSEventFilter(id='mds1', name='MyFilter', 
        props={'condition': 'NOUNTYPE equals MDS_Connections AND CONTEXT user equals bruce IGNORECASE'})
 
Filter "mds1" added.
 
 

The following example attempts to add a filter with the same id. The command returns an error:

addDMSEventFilter(id='mds1', name='MyFilter', 
      props={'condition': 'NOUNTYPE equals MDS_Connections AND CONTEXT user equals bruce'})
 
Filter "mds1" already exists. Unable to add this.

The following example adds a filter with two event/action pairs:

addDMSEventFilter(id='mds2', name='MyFilter', 
          etypes='NOUN:CREATE,HTTP_REQUEST:START', 
          props={'condition': 'NOUNTYPE equals MDS_Connections 
                  AND CONTEXT user equals bruce IGNORECASE=true'})
 Filter "mds2" added.

addDMSEventRoute

Command Category: DMS Event Tracing

Use with WLST: Online

Description

Adds the specified event route to the Event Tracing configuration. If an event route with the same ID already exists, the command returns an error and does not add the event route.

You must be connected to the Administration Server to add an event route. If you are not, an error is returned.

Syntax

addDMSEventRoute([filterid=filter_id], destinationid=destination_id, [enable=true|false] [,server=server_name])
Argument Definition
filterid

Optional. The unique identifier for the filter.

destinationid

The unique identifier for the specific destination. The destination must exist.

enable

Optional. Enables the filter. Valid values are true and false. The default is true.

server

Optional. The server on which to perform this operation. The default is the server to which you are connected.


Examples

The following example adds an event route with the filter id of mds1 and the destination id of jrf:

addDMSEventRoute(filterid='mds1', destinationid='jfr', enable='false')
Event-route for filter "mds1", destination "jfr" added.

The following example attempts to add an event route that already exists:

addDMSEventRoute(filterid='mds1', destinationid='jfr', enable='false')
Event-route for filter "mds1", destination "jfr" already exists. Unable to add this.

enableDMSEventTrace

Command Category: DMS Event Tracing

Use with WLST: Online

Description

Enables an event trace and creates a filter with a specified condition and destination and an enabled event-route. This is a simple way to start filtering, without having to explicitly create a filter, destination and event-route, but with less configuration options. The specified destination must exist.

You must be connected to the Administration Server to enable a DMS event trace. If you are not, an error is returned.

If you require a more complex configuration, use the addDMSEventDestination, addDMSEventFilter, and addDMSEventRoute.

Syntax

enableDMSEventTrace(destinationid=destinationid [, etypes=etype] 
                     [, condition=condition]  [, server=server_name])
Argument Definition
destinationid

The unique identifier for the specific destination. Any existing destination is valid.

etypes

Optional. A string containing a comma-separated list of event/action pairs. See addDMSEventFilter for a list of available etypes.

condition

Optional. A condition on which to filter. See addDMSEventFilter for the syntax for a condition.

If no condition is specified, all DMS events will be passed

server

Optional. The server on which to perform this operation. The default is the server to which you are connected.


Example

The following example enables an event trace with a specified condition:

enableDMSEventTrace(condition='CONTEXT username EQUALS Joe AND CONTEXT ip EQUALS 192.168.1.5')
 
Filter "EventTrace9", using Destination "LoggerDestination" added, and event-route enabled.

listDMSEventConfiguration

Command Category: DMS Event Tracing

Use with WLST: Online

Description

Displays an overview of the Event Tracing configuration.

Syntax

listDMSEventConfiguration([server=server_name]] 
Argument Definition
server

Optional. The server on which to perform this operation. The default is the server to which you are connected.


Example

The following example lists the configuration for the Managed Server to which you are connected:

listDMSEventConfiguration()
 
Event routes:
  FILTER      DESTINATION
  MyFilter    des1
  MyFilter    des2
  null        des3
 
Filters with no event route:
  Fred
 
Destinations with no event route:
  des4

listDMSEventDestination

Command Category: DMS Event Tracing

Use with WLST: Online

Description

For a specific destination, display the full configuration. If no destination ID is specified, list the destination ID and name for all the destinations in the Event Tracing configuration.

Syntax

listDMSEventDestination([id=id] [, server=server_name)
Argument Definition
id

Optional. The unique identifier for the specific destination.

server

Optional. The server on which to perform this operation. The default is the server to which you are connected.


Examples

The following example displays information about the destinations for the Managed Server to which you are connected:

listDMSEventDestination()
ID  : destination1
NAME: File-system
ID  : jrf                  
NAME: Flight-Recorder
 

The following example displays information about the destinations for the Managed Server, MS1:

listDMSEventDestination(server='MS1')
ID        NAME
Network1  Send file over network
desman1   File-system

The following example displays information about the destination destination1:

listDMSEventDestination(id='destination1')
ID: destination1
NAME: File-system
CLASS: oracle.dms.trace2.runtime.LoggerDestination
PROPERTIES:  
NAME       VALUE   
LoggerName trace2-logger

listDMSEventFilter

Command Category: DMS Event Tracing

Use with WLST: Online

Description

For a specific filter, displays the full configuration. If you do not specify a filter ID, the command displays the filter ID and name for all the filters in the Event Tracing configuration.

Syntax

listDMSEventFilter([id=id] [, server=server_name])
Argument Definition
id

Optional. The unique identifier for specified filter.

server

Optional. The server on which to perform this operation. The default is the server to which you are connected.


Example

The following example displays the list of all the filters in the Event Tracing configuration:

listDMSEventFilter()
 
ID    NAME
mds1  MyFilter
mds2  MDS2Filter

The following example displays the configuration of the filter mds1:

listDMSEventFilter(id='mds1')
 
ID  : mds1
NAME: MyFilter
PROPERTIES
CONDITION: NOUNTYPE equals MDS_Connections AND CONTEXT user equals
bruce IGNORECASE=false

listDMSEventRoutes

Command Category: DMS Event Tracing

Use with WLST: Online

Description

List the events routes and their status (enabled or disabled) that are associated with the specified filter or destination. If you do not specify a filterid or destinationid, this command lists all the event routes in the Event Tracing configuration.

Syntax

listDMSEventRoutes([filterid=filter_id] [, destinationid=destination_id]
                   [, server=server_name])
Argument Definition
filterid

Optional. The unique identifier for the filter.

destinationid

Optional. The unique identifier for the specific destination. The destination must exist.

server

Optional. The server on which to perform this operation. The default is the server to which you are connected.


Examples

The following example lists all event routes:

listDMSEventRoutes()
  FILTER     : mdsbruce          
  DESTINATION: jfr            
  ENABLED    : false
  FILTER     : null          
  DESTINATION: destination1   
  ENABLED    : true

The following example lists the event routes with the filter id of filter1:

listDMSEventRoutes(filterid='filter1')
  FILTER     : filter1          
  DESTINATION: jfr            
  ENABLED    : true
  FILTER     : filter1          
  DESTINATION: destination1   
  ENABLED    : true
 

The following example lists the event routes with the destination id of destination1:

listDMSEventRoutes(destinationid='destination1')
  FILTER     : filter1          
  DESTINATION: destination1   
  ENABLED    : true

removeDMSEventDestination

Command Category: DMS Event Tracing

Use with WLST: Online

Description

Removes an existing destination from the Event Tracing configuration. You can remove a destination only if no event route depends on the destination. If an event route that depends on the destination exists, a warning is returned.

You must be connected to the Administration Server to remove a destination. If you are not, an error is returned.

Syntax

removeDMSEventDestination(id=id [, server=server_name]) 
Argument Definition
id

The unique identifier for the destination to be removed.

server

Optional. The server on which to perform this operation. The default is the server to which you are connected.


Examples

The following example removes the destination jfr:

removeDMSEventDestination(id='jfr')
 
Destination "jfr" removed. 

The following example attempts to remove the destination styx.inpass.db1. However, because an event route exists for the destination, the command returns an error.

removeDMSEventDestination(id='styx.inpass.db1')
 
Destination "'styx.inpass.db1'" cannot be removed. An event-route currently 
exists for that destination. Remove the event-route first using the command 
removeDMSEventRoute(). 

removeDMSEventFilter

Command Category: DMS Event Tracing

Use with WLST: Online

Description

Removes an existing filter from the Event Tracing configuration. You can remove a filter only if no event route depends on the filter. If an event route that depends on the filter exists, a warning is returned.

You must be connected to the Administration Server to remove an event filter. If you are not, an error is returned.

Syntax

removeDMSEventFilter(id=id [, server=server_name])
Argument Definition
id

The unique identifier for the filter to be removed.

server

Optional. The server on which to perform this operation. The default is the server to which you are connected.


Example

The following example removes the filter mds1:

removeDMSEventFilter(id='mds1')
 
Filter "mds1" removed. 

The following example attempts to remove a filter for which and event-route currently exists:

removeDMSEventFilter(id='allaccounts')
 
Filter "allaccounts" cannot be removed. An event-route currently exists for that
filter. Remove the event-route first using the command removeDMSEventRoute().

removeDMSEventRoute

Command Category: DMS Event Tracing

Use with WLST: Online

Description

Removes the specified event route. You must be connected to the Administration Server to add an event route. If you are not, an error is returned.

Syntax

removeDMSEventRoute([filterid=filter_id] [, destinationid=destination_id]
                    [, server=server_name])
Argument Definition
filterid

Optional. The unique identifier for the filter.

destinationid

Optional. The unique identifier for the specific destination. The destination must exist.

server

Optional. The server on which to perform this operation. The default is the server to which you are connected.


Example

The following example removes the event route with the filterid mds1 and the destination jfr:

removeDMSEventRoute(filterid='mds1', destinationid='jfr')
Event-route for filter "mds1", destination "jfr" removed

The following example removes the event route with the destination destination1:

removeDMSEventRoute(destinationid='destination1')
Event-route for filter "None", destination "destination1" removed

updateDMSEventDestination

Command Category: DMS Event Tracing

Use with WLST: Online

Description

Updates an existing destination, allowing a specified argument to be updated. You must be connected to the Administration Server to update a destination. If you are not, an error is returned.

Syntax

updateDMSEventDestination(id=id [, name=dest_name], class=class_name 
                 [,props= {'name': 'value'...}] [, server=server_name)
Argument Definition
id

The unique identifier for the destination to be updated.

name

Optional. A name for the destination.

class

The full classname of the destination.

See Table 6-4 for a list of available destinations.

props

Optional. The name/value properties to use for the destination. You can add a new property, or update or remove an existing one. If you update properties, you must specify all properties. If you omit a property, it is removed. For example, if a destination contains the properties LoggerName and severity, and you omit severity, it will be removed from the destination.

See addDMSEventFilter for information about the syntax and allowed values.

server

Optional. The server on which to perform this operation. The default is the server to which you are connected.


Examples

The following example updates the name of the destination jfr:

updateDMSEventDestination(id='jfr', name='Alternative Flight-Recorder')
 
Destination "jfr" updated. 

The following example attempts to update a destination that does not exist. The command returns an error:

updateDMSEventDestination(id='destination1', 
           props={'loggerName': 'MyNewTrace2-logger'})
 
Destination "destination1" does not yet exist. Unable to update this.

updateDMSEventFilter

Command Category: DMS Event Tracing

Use with WLST: Online

Description

Updates an existing filter in the Event Tracing configuration.

You must be connected to the Administration Server to update an event filter. If you are not, an error is returned.

Syntax

updateDMSEventFilter(id=id [, name=name] [,etypes=etypes], 
                     props= {'prop-name': 'value'...} 
                     [,server=server_name])
Argument Definition
id

The unique identifier for the filter to be updated.

name

Optional. The name of the filter to be updated.

etypes

Optional. A string containing a comma-separated list of event/action pairs. See addDMSEventFilter for a list of valid values.

props

prop-name: The name of the filter property. <condition> is the only valid property, and only one condition may be specified. See addDMSEventFilter for information on the syntax of prop-name.

value: The value of the property of the filter.

server

Optional. The server on which to perform this operation. The default is the server to which you are connected.


Examples

The following example updates the filter properties for the filter with the id mds1:

updateDMSEventFilter(id='mds1', 
 props={'condition': 'NOUNTYPE equals XYZ_Total_Connections AND CONTEXT user equals bruce'})
 
Filter "mds1" updated.

The following example attempts to update a filter that does not exist:

updateDMSEventFilter(id='Filter2')
 
Filter "Filter2" does not yet exist. Unable to update this.

updateDMSEventRoute

Command Category: DMS Event Tracing

Use with WLST: Online

Description

Enables or disables the specified event route. You must be connected to the Administration Server to update an event route. If you are not, an error is returned.

Syntax

updateDMSEventRoute([filterid=filter_id], destinationid=destination_id 
         [, enable=true|false] [, server=server_name])
Argument Definition
filterid

Optional. The unique identifier for the filter.

destinationid

Optional. The unique identifier for the specific destination. The destination must exist.

enable

Optional. Enables the filter. Valid values are true and false.

server

Optional. The server on which to perform this operation. The default is the server to which you are connected.


Example

The following example disables the event route with the filterid mds1 and the destinationid jfr:

updateDMSEventRoute(filterid='mds1', destinationid='jfr', enable='false')
Event-route for filter "mds1", destination "jfr" disabled .