CLW Command Reference

This section contains details about CLW commands.
apmdevops106
This section contains details about CLW commands.
3
Note:
The syntax shown for each command does not include the invocation portion of the command. Each CLW command must begin with:
java -jar CLWorkstation.jar
Enterprise Manager Commands
The Enterprise Manager aggregates application performance data from agents, runs requested calculations, makes performance data available to authorized clients, and stores performance data.
Shut down Enterprise Manager
This command shuts down the Enterprise Manager. To run it, you must have shutdown or full permission. Any Workstation users connected to the Enterprise Manager are logged off when you shut down the Enterprise Manager.
Syntax
shutdown
Example
shutdown
Output
None.
Extract Persistent Data from SmartStor (Within a Time Range)
This command extracts historical data for a specified time period from SmartStor. You supply a regular expression that specifies the agents, a regular expression that specifies the metric groups, and the start and end of the time period. The
hh:mm:ss
portion of the date-time string is optional -- if you do not supply it, the default is 00:00:00 (midnight).
Syntax
get historical data from agents matching [REGULAR EXPRESSION] and metrics matching [REGULAR EXPRESSION] between
[EXACT MATCH] and [EXACT MATCH] with frequency of [EXACT MATCH] (second|seconds|sec|secs|s)
Example
get historical data from agents matching (.*weblogic.*) and metrics matching (Servlets:Responses Per Interval) between \"2011-10-12 00:00:00\" and \"2011-10-12 00:10:00\" with frequency of 60 seconds
This command extracts the persisted data for the Servlets:Responses Per Interval Metric Grouping, for all agents whose name includes the string weblogic. The data is extracted for the time period from midnight on October 12, 2011 through 10 minutes after midnight on October 12, 2011, with a frequency of 60 seconds.
Output
The SmartStor data is returned in comma-separated value (CSV) format.
Extract Persistent Data from SmartStor (Previous N Minutes with Frequency of N Seconds)
This command extracts historical data for a specified number of minutes prior to the execution of the command. The extracted data displays in seconds for a specific frequency. You supply a regular expression that specifies the agents, a regular expression that specifies the metric groups, the number of minutes of history to be extracted, and the frequency at which to extract the data.
Syntax
get historical data from agents matching [REGULAR EXPRESSION] and metrics matching [REGULAR EXPRESSION] for past [EXACT MATCH] (minute|minutes) with frequency of [EXACT MATCH] (second|seconds|sec|secs|s)
Example
get historical data from agents matching (.*weblogic.*) and metrics matching (Servlets:Responses Per Interval) for past 1 minute with frequency of 60 seconds
This command extracts the persisted data for the Servlets:Responses Per Interval Metric Grouping, for all agents whose name includes the string weblogic. The data is extracted for the time period of the past minute, with a frequency of 60 seconds.
Output
The SmartStor data is returned in comma-separated value (CSV) format.
Specify a pathname for authentication
Specifies the full pathname for a public key file to use instead of username/password authentication when connecting to the Enterprise Manager. The public key used is the same one used for Manager of Managers/Collector authentication.
For more information about configuring the public key, see APM Security.
Introscope Agent Commands
An agent runs as a part of the managed application on the Java Application machine. It collects and summarizes the probe-reported data and sends it to the Enterprise Manager.
List Agents
The List Agents command lists one or more agents that are connected to the Enterprise Manager. You supply a regular expression that determines which agents are listed.
Syntax
list agents matching <REGULAR EXPRESSION>
Example
list agents matching (.*)
This command lists all agents that are connected to the Enterprise Manager.
Output
Each agent is listed, prefixed by its Host and Process. Virtual agents are included in the list. For example:
jdoe-dt|Weblogic|WebLogicAgent
Custom Metric Host (Virtual)|Custom Metric Process (Virtual)|Custom Metric Agent (Virtual)
List Historical Agents
The List Historical Agents command lists all agents with data in SmartStor that are unmounted and not sending data to an Enterprise Manager.
Syntax
list historical agents
Example
list historical agents
Output
Each unmounted historical agent is listed on a separate line and is preceded with its host name and process. For example:
jdoe-dt|Weblogic|WebLogicAgent
List Historical Agents (Within a Time Range)
This command lists all unmounted agents that have historical data in SmartStor within the specified time range. Agents sending data are automatically mounted, so they are not listed.
You supply the start and end of the time period. The hh:mm:ss portion of the date-time string is optional -- if you do not supply it, the default is 00:00:00 (midnight).
Syntax
list historical agents between [TIME] and [TIME]
Example
list historical agents between \"2013-04-22 00:00:00\" and \"2013-04-23 00:10:00\"
This command lists all unmounted agents that sent data in the period from midnight on March 22, 2013 through 10 minutes after midnight on March 23, 2013.
Output
Each unmounted historical agent that sent data during the specified time range is listed on a separate line. The agent name is preceded with its host name and process. For example:
jdoe-dt|Weblogic|WebLogicAgent
Turn on Agents
This command starts or resumes Metric reporting from one or more agents. You supply a regular expression that specifies the target agents.
Syntax
turn on agents matching <REGULAR EXPRESSION>
Example
turn on agents matching (.*)
This command turns on all agents.
Output
None.
Turn off Agents
This command stops Metric reporting from one or more agents. You supply a regular expression that specifies the target agents.
Send Configuration File
This command sends a specified file to one or more agents. You supply the name of the file, a regular expression that specifies the target agents, and the source and destination directories.
Target agents must be configured to allow remote writes in their
introscope.agent.remoteagentconfiguration.enabled
property. The location and its default values vary. For more information, see the Java Agent or Microsoft .NET Agent sections.
You can only copy files explicitly specified in the agent’s
introscope.agent.remoteagentconfiguration.allowedfiles property
.
The default value of this property is
domainconfig.xml
, which is the file that contains all the information that Introscope needs to recognize transactions for CA CEM.
Generate Thread Dumps
This command generates thread dumps for the agent. By default, the thread dump file is created in the folder <
EM_HOME
>/threaddumps. 
EM_HOME
 is the home directory of the collector for the relevant agent.
The text format thread dump returned to the CLW client has the stack truncated if there are more than 10 elements (this number is nonconfigurable). This result is the same as when saving the thread dump from the Workstation Investigator using the Save as Text option. To see the full thread dump stack, load the thread dump into the Workstation Investigator.
Syntax
Use one of the following options to collect a new thread dump file:
get ThreadDump for the agent matching [REGULAR EXPRESSION] for performance
get ThreadDump for the agent matching [REGULAR EXPRESSION] for functional
If you do not want the text format thread dump to be sent back to the CLW client, use the "for performance" option (less overhead to the Enterprise Manager). Otherwise, use the "for functional" option. For both cases, the thread dump is persisted on the Enterprise Manager.
The [REGULAR EXPRESSION] in this command must match the Agent Name.
Example
In the following example, a Tomcat agent with name "*SuperDomain*|HostName|Tomcat|Tomcat_Agent" is used:
java -jar CLWorkstation.jar get ThreadDump for the agent matching ".*HostName\|Tomcat\|Tomcat_Agent.*" for functional
Output
.*HostName\|Tomcat\|Tomcat_Agent.*emConnection=available
TD enable on EM = true
TD enable onTomcat_Agent = true
SUCCEESS
"main" Id=1 RUNNABLE (in native)
...
Note:
By default the thread dump file is created in the folder <
EM_HOME
>/threaddumps, where
EM_HOME
is the home directory of the Collector for the agent.
Use the following command to retrieve the list of already collected thread dump files:
get List of ThreadDump filenames for the agent matching [REGULAR EXPRESSION]
Example
java -jar CLWorkstation.jar get List of ThreadDump filenames for the agent matching ".*HostName\|Tomcat\|Tomcat_Agent.*"
Output
.*HostName\|Tomcat\|Tomcat_Agent.*emConnection=available
TD enable on EM = true
TD enable onTomcat_Agent = true
HostName_Tomcat_Tomcat_Agent_TD_xxxxxxxxxxxxx
HostName_Tomcat_Tomcat_Agent_TD_yyyyyyyyyyyyy
APM Status Console Commands
This section provides CLW commands related to the APM Status console.
You must have apm_status_console_control permission to run APM Status console CLW commands.
Get Cluster Configuration
This command displays the following information:
  • Host name and ports of the MOM and all the CDVs and Collectors in the cluster.
  • Host and port of a standalone Enterprise Manager.
Syntax
get cluster configuration
Example
get cluster configuration
This command lists the host name and ports of the MOM and all the Collectors in the cluster.
Output
Lists the host name and ports of the MOM and all the Collectors in the cluster. The MOM is listed first followed by the Collectors.
MOM: USERID04-W7@5001 Collectors: localhost@3001 USERID04-@xyz_company.com@6001
For a standalone Enterprise Manager, lists the host and port of the Enterprise Manager.
StandAlone: USERID05-W8@5001
List Active Clamps
This command lists the clamps properties in apm-events-thresholds-config.xml that currently meet or exceed their threshold values. These are called
active
clamps. This command provides a list of these active clamps:
  • On a MOM and across all Collectors in a cluster.
  • On a CDV and all Collectors connected to the CDV.
  • On a standalone Enterprise Manager.
When an apm-events-thresholds-config.xml clamp value meets or exceeds its threshold value, the Enterprise Manager notifies the APM Status console.
Syntax
list active clamps
Example
list active clamps
This command lists all the active clamps on these CA APM components depending on your environment:
  • MOM and all Collectors in a cluster.
  • CDV and its attached Collectors and standalone Enterprise Managers.
  • Standalone Enterprise Manager.
Output
Lists the name of all the active clamps in these CA APM components depending on your environment:
  • MOM and Collector across the cluster.
  • CDV and connected Collectors and standalone Enterprise Managers.
  • Standalone Enterprise Manager.
For each clamp, lists the following information:
Enterprise Manager Name, Clamp Name, Clamp Description, Clamp Threshold Value, Clamp Value, Clamped Time
For example:
USERID04-w7@6001, introscope.enterprisemanager.metrics.live.limit, Per EM limit. Takes into account only live metrics (i.e. currently reporting from Agents), 0, 40, 22:10:00 10/07/11 USERID04-w7@3001, introscope.enterprisemanager.agent.error.limit, Limits # of Error Events Per Interval, 1, 1, 22:09:30 10/07/11 USERID04-w7@3001, introscope.enterprisemanager.metrics.live.limit, Per EM limit. Takes into account only live metrics (i.e. currently reporting from Agents), 0, 219, 22:09:30 10/07/11
Command options
This section describes
list active clamps
command options.
List active clamps for specific and multiple Collectors
You can add these two arguments to the
list active clamps
command:
  • of EM -- Use this argument to return a list of the active clamps on a specific MOM, Collector, CDV, or standalone Enterprise Manager.
    • Syntax
      list active clamps of EM <enterprise-manager-host@port>
    • Example
      list active clamps of EM localhost@3001
    • Output
      Enterprise Manager Name, Clamp Name, Clamp Description, Clamp Threshold Value, Clamp Value, Clamped Time
      localhost@3001, introscope.enterprisemanager.agent.error.limit, Limits # of Error Events Per Interval, 1, 1, 22:09:30 10/07/11 localhost@3001, introscope.enterprisemanager.metrics.live.limit, Per EM limit. Takes into account only live metrics (i.e. currently reporting from Agents), 0, 219, 22:09:30 10/07/11
If you input an incorrect Enterprise Manager name, the console displays an error message that lists the Collectors that have active clamps. To get the list of active clamps for the correct Enterprise Manager, retry the command using Enterprise Manager name provided in the error message.
  • of EM EnterpriseManagerName1@port,EnterpriseManagerName2,@port EnterpriseManagerNameX@port -- Use this argument to return a list of the active clamps on multiple specific Enterprise Managers.
    • Syntax
      list active clamps of EM <EnterpriseManagerName1@port>, <EnterpriseManagerName2@port>
    • Example
      list active clamps of EM localhost@3001,USERID04-w7@5001
    • Output
      For all Enterprise Managers specified: Enterprise Manager Name, Clamp Name, Clamp Description, Clamp Threshold Value, Clamp Value, Clamped Time
      localhost@3001, introscope.enterprisemanager.agent.error.limit, Limits # of Error Events Per Interval, 1, 1, 22:09:30 10/07/11 localhost@3001, introscope.enterprisemanager.metrics.live.limit, Per EM limit. Takes into account only live metrics (i.e. currently reporting from Agents), 0, 219, 22:09:30 10/07/11 USERID04-w7@3001, introscope.enterprisemanager.agent.error.limit, Limits # of Error Events Per Interval, 1, 1, 22:09:30 10/07/11 USERID04-w7@3001, introscope.enterprisemanager.metrics.live.limit, Per EM limit. Takes into account only live metrics (i.e. currently reporting from Agents), 0, 219, 22:09:30 10/07/11 USERID04-w7@5001, introscope.enterprisemanager.metrics.live.limit, Per EM limit. Takes into account only live metrics (i.e. currently reporting from Agents), 200, 390, 22:22:55 10/07/11
If you input an incorrect Enterprise Manager name, the console displays an error message that lists the Collectors that have active clamps. To get the list of active clamps for the correct Enterprise Manager, retry the command using Enterprise Manager name provided in the error message.
List Important Events
This command lists the Important Event properties in apm-events-thresholds-config.xml that currently meet or exceed their threshold values. This command provides a list across all CDVs and Collectors in a cluster or for a standalone Enterprise Manager.
When an apm-events-thresholds-config.xml property value meets or exceeds its threshold value, the Enterprise Manager notifies the APM Status console.
Syntax
list important events
Example
list important events
This command list all the important events in the cluster or on the standalone Enterprise Manager.
Output
Lists the data about all the important events in your cluster or standalone Enterprise Manager.
For each event the following information displays:
Enterprise Manager Name, Event Severity, Event Description, Event Time
For example:
USERID04-w7@6001, Warning Event, The Smartstor duration on EM USERID04-w7@6001 is more than configured threshold [Actual Value : 1,780/ Threshold : 5]. The most likely cause would be slow disk., 22:10:02 10/07/11 USERID04-w7@3001, Warning Event, The harvest duration of EM USERID04-w7@3001 is more than configured threshold [Actual Value : 169/ Threshold : 5], 22:09:30 10/07/11 USERID04-w7@3001, Warning Event, The Smartstor duration on EM USERID04-w7@3001 is more than configured threshold [Actual Value : 1,255/ Threshold : 5]. The most likely cause would be slow disk., 22:09:31 10/07/11 USERID04-w7@5001, Warning Event, The Smartstor duration on EM USERID04-w7@5001 is more than configured threshold [Actual Value : 95/ Threshold : 50]. The most likely cause would be slow disk., 22:32:40 10/07/11
Management Module Commands
Management Modules organize Elements in the Workstation, making them easier to find and manipulate. CLW commands for Management Modules simplify the process of moving a Management Module and the Elements it contains from one Enterprise Manager to another.
List Management Modules
The List Management Module command lists one or more Management Modules. You supply a regular expression that specifies the Management Modules.
Syntax
list management modules matching <REGULAR EXPRESSION>
Example
list management modules matching (.*)
This command lists all Management Modules.
For Linux OS, use single quotes.
Example:
'(.*)'
Output
The name of each Management Module is listed:
Sample Sample13 Sample11
Query Management Modules
The Query Management Module command lists Management Modules and their current state: active or inactive. You supply a regular expression that specifies the target Management Modules.
Syntax
query state of management modules matching <REGULAR EXPRESSION>
Example
query state of management modules matching (.*)
This command returns the name and state of all Management Modules.
Output
The name and state of each Management Module is listed:
Sample1:Active Sample2:Active
Activate Management Modules
The Activate Management Module command activates one or more Management Modules. You supply a regular expression that specifies the target Management Modules.
Deactivate Management Modules
The Deactivate Management Module command deactivates one or more Management Modules. You supply a regular expression that specifies the target Management Modules.
Copy Management Module
The Copy Management Module command creates a copy of a Management Module in the
<EM_Home>/config/modules
directory.
This command is an efficient way to create one or more new Management Modules that are based on existing Management Modules. For example, to create a new Management Module that is identical to an existing one, except for its Metric Group, you copy it using the CLW, and then modify the new Management Module’s Metric Group in the GUI Workstation.
In the Copy Management Module command, you identify the Management Module you want to copy, a name for new Management Module, and a name, excluding the file extension, for the
.jar
file for the new Management Module.
Delete Management Module
The Delete Management Module command deletes a Management Module. You supply the exact name of the Management Module you want to delete.
Read-only Management Modules
This command sets Management Modules that match a specified regular expression to read-only.
Warning!
CA Technologies recommends that you save a version of your editable Management Module to a safe location for future use. Once a Management Module is set to read-only, you cannot return it to an editable state.
Follow these steps:
  1. Set readonly management modules matching <regular expression>.
  2. Log into the Workstation, open the Management Module Editor, and note that management modules matching the regular expression have a lock icon next to them.
  3. Deselect the Editable checkbox next to the Management Modules no longer allowed.
This feature is intended for use by CA Technologies partners. Please contact
CA Support
before using this feature in your environment.
Action Commands
An Action is a behavior, such as a notification, that can be triggered by an Alert.
List Actions
The List Actions command lists one or more Actions in one or more Management Modules. You supply two regular expressions -- one that specifies the Actions, and one that specifies the Management Modules.
Syntax
list actions matching <REGULAR EXPRESSION> in management modules matching <REGULAR EXPRESSION>
Example
list actions matching (.*) in management modules matching (.*)
This command lists all Actions in all Management Modules.
Output
Each Action is listed, prefixed by the Management Module that contains it:
Sample.SMTP Email Action
Sample10.Workstation Notification
Sample2.Workstation Notification
Activate Actions
The Activate Actions command activates one or more Actions in one or more Management Modules. You supply two regular expressions -- one that specifies the Actions to activate, and one that specifies the Management Modules in which to activate them.
Syntax
activate actions matching <REGULAR EXPRESSION> in management modules matching <REGULAR EXPRESSION>
Example
activate actions matching (SMTP.*) in management modules matching (.*)
This command activates Actions that begin with the string
SMTP
in all Management Modules.
Output
Each Action activated by the command is listed, prefixed by the Management Module that contains it, suffixed by its activation state:
Sample.SMTP Email Action:Active Sample10.Workstation Notification:Active Sample2.Workstation Notification:Active
Deactivate Actions
The Deactivate Actions command deactivates one or more Actions in one or more Management Modules. You supply two regular expressions -- one that specifies the Actions to deactivate, and one that specifies the Management Modules in which to deactivate the Actions.
Query Actions
The Query Actions command lists the state -- active or inactive -- of one or more Actions in one or more Management Modules. You supply two regular expressions -- one that specifies the Actions, and one that specifies the Management Modules.
Rename Action
The Rename Action command renames an Action. You specify the name of the Action and the Management Module that contains it, and a new name for the Action.
Delete Action
The Delete Action command deletes one or more Actions from one or more Management Modules. You supply two regular expressions -- one that specifies the Actions, and one that specifies the Management Modules from which to delete them.
Note:
You cannot delete an Action that is used or referenced by another Element -- for example, one that is linked to an Alert.
Alert Commands
An Alert indicates potential problems in your managed Java Application by comparing Metric values to user-defined threshold values.
List Alerts
The List Alerts command lists one or more Alerts in one or more Management Modules. You supply two regular expressions -- one that specifies the Alerts, and one that specifies the Management Modules.
Syntax
list alerts matching <REGULAR EXPRESSION> in management modules matching <REGULAR EXPRESSION>
Example
list alerts matching (.*) in management modules matching Sample
This command lists the Alerts in the Management Module named
Sample
.
Output
Each Alert is listed, prefixed by the Management Module that contains it:
Sample.Console Summary Alert Sample.All Servlet Response Time Sample.All EJB Response Times
Activate Alerts
The Activate Alerts command activates one or more Alerts in one or more Management Modules. You supply two regular expressions -- one that specifies the Alerts to activate, and one that specifies the Management Modules in which to activate those Alerts.
Syntax
activate alerts matching <REGULAR EXPRESSION> in management modules matching <REGULAR EXPRESSION>
Example
activate alerts matching (.*) in management modules matching Same2
This command activates all of the Alerts in the Management Module named
Sample2
.
Output
Each Alert activated by the command is listed, prefixed by the Management Module that contains it, and suffixed by its state:
Sample2.Application Summary Alert:Active Sample2.SQL Average Processing Time #2 (ms):Active Sample2.CPUApp1:Active
Deactivate Alerts
The Deactivate Alerts command deactivates one or more Alerts in one or more Management Modules. You supply two regular expressions -- one that specifies the Alerts to deactivate, and one that specifies the Management Modules in which to deactivate those Alerts.
Query Alerts
The Query Alerts command lists the state -- active or inactive -- of one or more Alerts in one or more Management Modules. You supply two regular expressions -- one that specifies the Alerts, and one that specifies the Management Modules.
Syntax
query state of alerts matching [REGULAR EXPRESSION] in management modules matching [REGULAR EXPRESSION]
Example
query state of alerts matching (.*) in management modules matching (Alerts.*)
This command lists all alerts and their state in the Management Module whose name begins with 
Alerts
.
Rename Alert
The Rename Alert command renames an Alert. You specify the name of the Alert and the Management Module that contains it, and a new name for the Alert.
Delete Alert
The Delete Alerts command deletes one or more Alerts from one or more Management Modules. You supply two regular expressions -- one that specifies the Alerts, and one that specifies the Management Modules from which to delete them.
Note:
You cannot delete an Alert that is used or referenced by another element -- for example, one that is used on a dashboard.
Alert Downtime Schedule Commands
Alert Downtime Schedules let you manage downtime periods from the Introscope Workstation Management Module Editor.
List Alert Downtime Schedules
The List Alert Downtime Schedules command lists one or more alert downtime schedules in one or more Management Modules. You supply two regular expressions -- one that specifies the alert downtime schedule, and one that specifies the Management Modules.
Syntax
list alert downtime schedules matching [REGULAR EXPRESSION] in management modules matching [REGULAR EXPRESSION]
Example
List alert downtime schedules matching (.*) in management modules matching Sample
Output
Sample.Example Alert Downtime Schedule
Sample.Another Alert Downtime Schedule
Activate Alert Downtime Schedules
The Activate Alert Downtime Schedules command activates one or more alert downtime schedules in one or more Management Modules. You supply two regular expressions -- one that specifies the alert downtime schedules to activate, and one that specifies the Management Modules in which to activate those alert downtime schedules.
Syntax
activate alert downtime schedules matching [REGULAR EXPRESSION] in management modules matching [REGULAR EXPRESSION]
Example
activate alert downtime schedules matching (.*) in management modules matching Sample
Output
Sample.Example Alert Downtime Schedule:Active
Sample.Another Alert Downtime Schedule:Active
Deactivate Alert Downtime Schedules
The Deactivate Alert Downtime Schedules command deactivates one or more alert downtime schedules in one or more Management Modules. You supply two regular expressions -- one that specifies the alert downtime schedules to deactivate, and one that specifies the Management Modules in which to deactivate those alert downtime schedules.
Query Alert Downtime Schedules
The Query Alert Downtime Schedules command lists the state -- active or inactive -- of one or more alert downtime schedules in one or more Management Modules. You supply two regular expressions -- one that specifies the alert downtime schedules, and one that specifies the Management Modules.
Rename Alert Downtime Schedules
The Rename Alert Downtime Schedules command renames an alert downtime schedule. You specify the name of the alert downtime schedule and the Management Module that contains it, and a new name for the alert downtime schedule.
Delete Alert Downtime Schedules
The Delete Alert Downtime Schedules command deletes one or more alert downtime schedules from one or more Management Modules. You supply two regular expressions -- one that specifies the alert downtime schedule, and one that specifies the Management Modules from which to delete them.
Calculator Commands
Calculators create custom Metrics by summing or averaging Metric data.
List Calculators
The List Calculators command lists one or more calculators in one or more Management Modules. You supply two regular expressions -- one that specifies the calculators, and one that specifies the Management Modules.
Syntax
list calculators matching <REGULAR EXPRESSION> in management modules matching <REGULAR EXPRESSION>
Example
list calculators matching (.*) in management modules matching (.*)
This command lists all calculators in all Management Modules.
Output
Each calculator is listed, prefixed by the Management Module that contains it:
Sample.Average Servlet Response Time
Activate Calculators
The Activate Calculators command activates one or more calculators in one or more Management Modules. You supply two regular expressions -- one that specifies the calculators to activate, and one that specifies the Management Modules in which to activate those calculators.
Syntax
activate calculators matching <REGULAR EXPRESSION> in management modules matching <REGULAR EXPRESSION>
Example
activate calculators matching (.*) in management modules matching Sample2
This command activates all calculators in the Management Module named
Sample2
.
Output
Each calculator activated by the command is listed, prefixed by the Management Module that contains it, and suffixed by its state:
Sample2.Average Servlet Response Time:Active
Deactivate Calculators
The Deactivate Calculators command deactivates one or more calculators in one or more Management Modules. You supply two regular expressions -- one that specifies the calculators to deactivate, and one that specifies the Management Modules in which to deactivate those calculators.
Query Calculators
The Query Calculators command lists the state -- active or inactive -- of one or more calculators in one or more Management Modules. You supply two regular expressions -- one that specifies the calculators, and one that specifies the Management Modules.
Rename Calculator
The Rename Calculator command renames a calculator. You specify the name of the calculator and the Management Module that contains it, and a new name for the calculator.
Delete Calculators
The Delete Calculators command deletes one or more calculators from one or more Management Modules. You supply two regular expressions -- one that specifies the calculators, and one that specifies the Management Modules from which to delete them.
You cannot delete a calculator that is used or referenced by another Element, for instance, one that is used in a Dashboard.
Dashboard Commands
A dashboard is a page in the Workstation that contains Data Viewer objects such as Graphs, Bar Charts, and alert status indicators, along with graphic and text objects.
List Dashboards
The List Dashboards command lists one or more Dashboards in one or more Management Modules. You supply two regular expressions -- one that specifies the Dashboards, and one that specifies the Management Modules.
Syntax
list dashboards matching <REGULAR EXPRESSION> in management modules matching <REGULAR EXPRESSION>
Example
list dashboards matching (.*Triage) in management modules matching (.*)
This command lists the Dashboards, in all Management Modules, whose name ends in the string
Triage.
Output
Each dashboard is listed, prefixed by the Management Module that contains it:
Sample10.3. Triage
Sample2.3. Triage
Sample.3. Triage
Activate Dashboards
The Activate Dashboards command activates one or more dashboards in one or more Management Modules. You supply two regular expressions -- one that specifies the Dashboards to activate, and one that specifies the Management Modules in which to activate those Dashboards.
Syntax
activate dashboards matching <REGULAR EXPRESSION> in management modules matching <REGULAR EXPRESSION>
Example
activate dashboards matching (.*) in management modules matching Sample2
This command activates all dashboards in the Management Module named
Sample2
.
Output
Each dashboard activated by the command is listed, prefixed by the Management Module that contains it, and suffixed by its state:
Sample2.4b. Database Detail:Active
Sample2.1. Introscope Console:Active
Sample2.2. Detection:Active
Deactivate Dashboards
The Deactivate Dashboards command deactivates one or more dashboards in one or more Management Modules. You supply two regular expressions -- one that specifies the Dashboards to deactivate, and one that specifies the Management Modules in which to deactivate those Dashboards.
Query Dashboards
The Query Dashboards command lists the state -- active or inactive -- of one or more dashboards in one or more Management Modules. You supply two regular expressions -- one that specifies the dashboards, and one that specifies the Management Modules.
Rename Dashboard
The Rename Dashboard command renames a dashboard. Specify the name of the dashboard and the Management Module that contains it, and a new name for the dashboard.
Delete Dashboards
The Delete Dashboards command deletes one or more dashboards from one or more Management Modules. You supply two regular expressions -- one that specifies the dashboards, and one that specifies the Management Modules from which to delete them.
Note:
You cannot delete a dashboard that is used or referenced by another element. For example, you cannot delete a dashboard that is has a hyperlink to a data viewer on another dashboard.
Metric and Metric Grouping Commands
A metric grouping specifies which metrics to act upon; it is used as a building block for elements such as alerts and calculators.
List Metric Groups
The List Metric Groups command lists one or more Metric Groups in one or more Management Modules. You supply two regular expressions -- one that specifies the Metric Groups, and one that specifies the Management Modules.
Syntax
list metric groups matching <REGULAR EXPRESSION> in management modules matching <REGULAR EXPRESSION>
Example
list metric groups matching (.*Response.*) in management modules matching Sample
This command lists the Metric Groups in the Management Module named
Sample
, whose name includes the string
Response
.
Output
Metric Groups are listed in this format:
<Management Module>.<Metric Group>[Agent: "<Agent Expression>" Attribute: "<Metric Expression>"]
For example:
Sample.Servlet Average Response Time (ms) [Agent: "(.*)\|(.*)\|(.*)" Attribute:\"Servlets:Average Response Time \(ms\)"]
The sample above provides this information for the Metric Grouping:
Management Module --
Sample
Metric Grouping Name --
Servlet Average Response Time (ms)
Agent Expression --
(.*)\|(.*)\|(.*)
Metric Expression --
Servlets:Average Response Time \(ms\)
Turn On Exact Metric
This command requests that an agent turn on a specific metric.
Syntax
turn on exact metric <metric name>
Example
turn on exact metric
SuperDomain|jdoe-dt|Weblogic|WebLogicAgent|Servlets|Servlet21|Servlet21_1u2oj1_Impl:Average Response Time (ms)
The agent turns on the 
SuperDomain|
jdoe-dt|Weblogic|WebLogicAgent|Servlets|Servlet21|Servlet21_1u2oj1_Impl:Average Response Time (ms) metric and starts sending data.
Output
None
Turn Off Exact Metric
This command requests that an agent turn off a specific metric.
Syntax
turn off exact metric <metric name>
Example
turn off exact metric 
SuperDomain|
jdoe-dt|Weblogic|WebLogicAgent|Servlets|Servlet21|Servlet21_1u2oj1_Impl:Average Response Time (ms)
The agent turns off the
SuperDomain|
jdoe-dt|Weblogic|WebLogicAgent|Servlets|Servlet21|Servlet21_1u2oj1_Impl:Average Response Time (ms) metric and stops sending data.
Output
None
Report Templates Commands
This section defines CLW commands for managing and generating reports. For more information about Introscope’s reporting capabilities, see the Introscope Reporting chapter in the APM Workstation section.
List Report Templates
The List Report Templates command lists one or more report templates in one or more Management Modules. You supply two regular expressions -- one that specifies the report templates, and one that specifies the Management Modules.
Syntax
list report templates matching <REGULAR EXPRESSION> in management modules matching <REGULAR EXPRESSION>
Example
list report templates matching (.*) in management modules matching Sample
This command lists all report templates in the Management Module named
Sample
.
Output
Each report template is prefixed by the Management Module that contains it.
Sample.QA/Test Application Performance
Sample.System Availability
Sample.Application Capacity Planning
Activate Report Templates
The Activate Report Templates command activates one or more report templates in one or more Management Modules. You supply two regular expressions -- one that specifies the report templates to activate, and one that specifies the Management Modules in which to activate the report templates.
Syntax
activate report templates matching <REGULAR EXPRESSION> in management modules matching <REGULAR EXPRESSION>
Example
activate report templates matching (.*) in management modules matching Sample2
This command activates all Report Templates in the Management Module named Sample2.
Output
Each report template activated by the command is listed, prefixed by the Management Module that contains it, and suffixed by its state:
Sample2.Application Capacity Planning:Active
Sample2.Production Application Health:Active
Sample2.System Availability:Active
Deactivate Report Templates
The Deactivate Report Templates command deactivates one or more report templates in one or more Management Modules. You supply two regular expressions -- one that specifies the report templates to deactivate, and one that specifies the Management Modules in which to deactivate those report templates.
Query Report Templates
The Query Report Templates command lists the state -- active or inactive -- of one or more report templates in one or more Management Modules. You supply two regular expressions -- one that specifies the report templates, and one that specifies the Management Modules.
Rename Report Template
The Rename Report Template command renames a report template. You specify the name of the report template and the Management Module that contains it, and a new name for the report template.
Delete Report Templates
The Delete Report Templates command deletes one or more report templates from one or more Management Modules. You supply two regular expressions -- one that specifies the report templates, and one that specifies the Management Modules from which to delete them.
Generate Report
Use the Generate Report command to generate a report. You supply these arguments:
  • report name
  • start time
  • end time
  • management module name
  • filename -- This file is written to the current working directory, unless a path is specified. The file is written in the format associated with the file extension, which must be one of these: HTML, PDF, XLS, TEXT, XML, or CSV..
Commands
There are three Generate Report commands, basic, expanded, and an agent override command:
Basic command:
generate report named [EXACT MATCH] in management module named [EXACT MATCH] to [EXACT MATCH]
Expanded command:
generate report named [EXACT MATCH] in management module named [EXACT MATCH] starting at [EXACT MATCH] ending at [EXACT MATCH] to [EXACT MATCH]
Optional parameters
The optional parameters can be used with both the basic and expanded commands above:
{in agents matching [REGEX PATTERN]} {starting at [EXACT MATCH] ending at [EXACT MATCH]}
The syntax for the optional parameters is:
generate report named [EXACT MATCH] in management module named [EXACT MATCH] {in agents matching [REGEX PATTERN]} {starting at [EXACT MATCH] ending at [EXACT MATCH]} to [EXACT MATCH]
Report timestamp format
The report timestamp is presented in a variety of formats. The table below identifies the various possibilities.
Timestamp Format
Example
M/d/yy h:mm a
11/17/08 3:00 PM
M/d/yy h:mm:ss a
11/17/08 3:00:06 PM
M/d/yy h:mm:ss a z
11/17/08 3:00:06 PM PST
M/d/yy
11/17/08
MMM d, yyyy h:mm a
Nov 17, 2008 3:00 PM
MMM d, yyyy h:mm:ss a
Nov 17, 2008 3:00:06 PM
MMM d, yyyy h:mm:ss a z
Nov 17, 2008 3:00:06 PM PST
MMM d, yyyy
Nov 17, 2008
MMMM d, yyyy h:mm a
November 17, 2008 3:00 PM
MMMM d, yyyy h:mm:ss a
November 17, 2008 3:00:06 PM
MMMM d, yyyy h:mm:ss a z
November 17, 2008 3:00:06 PM PST
MMMM d, yyyy
November 17, 2008
EEE MMM dd HH:mm:ss zzz yyyy
Mon Nov 17 15:00:06 PST 2008
MM/dd/yy HH:mm:ss
11/17/08 15:00:06
yyyy-MM-dd HH:mm:ss
2008-11-17 15:00:06
yyyy-MM-dd HH:mm:ss.SSSS
2008-11-17 15:00:06.0840
yyyy-MM-dd HH:mm
2008-11-17 15:00
yyyy-MM-dd hh:mm:ss a
2008-11-17 03:00:06 PM
yyyy-MM-dd hh:mm a
2008-11-17 03:00 PM
yyyy/MM/dd hh:mm:ss a
2008/11/17 03:00:06 PM
yyyy/MM/dd hh:mm a
2008/11/17 03:00 PM
yyyy/MM/dd HH:mm:ss
2008/11/17 15:00:06
yyyy/MM/dd HH:mm
2008/11/17 15:00
SNMP Collections Commands
These commands define which collected Metrics are to be included in a published MIB.
List SNMP Collections
The List SNMP Collections command lists one or more SNMP collections in one or more Management Modules. You supply two regular expressions -- one that specifies the SNMP Collections, and one that specifies the Management Modules.
Syntax
list snmp collections matching <REGULAR EXPRESSION> in management modules matching <REGULAR EXPRESSION>
Example
list snmp collections matching (.*) in management modules matching (.*)
This command lists all SNMP Collections in all Management Modules.
Output
Each SNMP Collection is prefixed by the Management Module that contains it. For example:
Sample2.JDBC QueryUpdate
Activate SNMP Collections
The Activate SNMP Collections command activates one or more SNMP collections in one or more Management Modules. You supply two regular expressions -- one that specifies the SNMP collections to activate, and one that specifies the Management Modules in which to activate those SNMP collections.
Syntax
activate snmp collections matching <REGULAR EXPRESSION> in management modules matching <REGULAR EXPRESSION>
Example
activate snmp collections matching (.*) in management modules matching Sample2
This command activates all SNMP collections in the Management Module named
Sample2
.
Output
Each SNMP collection activated by the command is listed, prefixed by the Management Module that contains it, suffixed by its state.
Sample2.JDBC QueryUpdate:Active
Deactivate SNMP Collections
The Deactivate SNMP Collections command deactivates one or more SNMP collections in one or more Management Modules. You supply two regular expressions -- one that specifies the SNMP collections to deactivate, and one that specifies the Management Modules in which to deactivate those SNMP collections.
Query SNMP Collections
The Query SNMP collections command lists the state -- active or inactive -- of one or more SNMP collections in one or more Management Modules. You supply two regular expressions -- one that specifies the SNMP collections, and one that specifies the Management Modules.
Rename SNMP Collection
The Rename SNMP collection command renames a SNMP collection. You specify the name of the SNMP collection and the Management Module that contains it, and a new name for the SNMP collection.
Delete SNMP Collections
The Delete SNMP Collections command deletes one or more SNMP collections from one or more Management Modules. You supply two regular expressions -- one that specifies the SNMP collection, and one that specifies the Management Modules from which to delete them.
Transaction Trace Configuration Options
The CLW gives you the option of configuring a variety of Transaction Trace options using these system properties:
  • -Dintroscope.clw.tt.console -- If set to "true", the transaction traces will be printed to a console.
  • -Dintroscope.clw.tt.dirname -- The local directory where transaction trace XML files are stored.
  • -Dintroscope.clw.tt.filename -- The file name used to store the transaction trace. This must not include the directory name.
  • -Dintroscope.clw.tt.encoding -- The encoding used when writing XML files to disk. Settings for this property include the default option
    ISO-8859-1
    and
    UTF-8
    ,
    UTF-16
    , and
    Windows-1252
Start a Transaction Trace Session
The Transaction Tracer traces the activity of individual transactions as they flow through the boundaries of a single JVM.
Transaction Traces are automatically saved to the Transaction Events database, and by default are also captured in one or more XML files, which you can open and analyze in the Transaction Trace Viewer in the Introscope Workstation. See APM Workstation
 
for information about the Introscope Transaction Tracer.
Command syntax
There are many aspects of a Transaction Trace Session that a CLW command can specify. Some of these include:
  • Execution threshold value -- The minimum execution time for transactions to be traced. Tracing is performed for transactions that take longer than the threshold to execute. The threshold can be specified in seconds.
  • Agent to trace -- A Perl regular expression that specifies the agent or agents for which transactions are traced.
  • Session duration -- The duration of the Transaction Trace Session, in seconds.
    The syntax for starting a Transaction Trace Session, specifying the threshold in seconds, is:
    trace transactions exceeding <EXACT MATCH> (second|seconds|sec|secs|s) in agents matching <REGULAR EXPRESSION> for <EXACT MATCH> <second|seconds|sec|secs|s>
Other CLW command options are detailed in Command options, below. For Transaction Trace CLW command examples, see Transaction Trace command examples.
Specify Transaction Trace output file
You can specify the name of the Transaction Trace output file.
Syntax
Dintroscope.clw.tt.filename=<file name>
Example
Specifies the file name (but not the full path) of the transaction trace output file. Use in conjunction with a property to specify the output directory.
Output
Sends transaction trace output to the specified file.
Command options
This section describes Transaction Trace command options.
Trace mode
The CLW supports two modes of capturing Transaction Trace Session results:
  • Synchronous Mode -- By default, the CLW writes the trace at the end of the session to the Transaction Events Database, and to a single XML file named
    TransactionTraceData-yyyyMMddhhmmss.xml
    , where the date-time string reflects the start of the session.
  • Asynchronous Mode -- In this mode, the CLW writes the trace for each transaction as soon as it is reported to the Transaction Events Database, and to its own XML file named
    nnnn(sec)-TransactionTraceDatayyyyMMddhhmmss-<sequence number>.xml
    , where
    nnnn
    is the transaction duration in seconds, and the date-time string reflects the start of the transaction. If you provide your own file name, it will append the sequence number before the last "
    .
    ". If file name provided does not have "
    .
    ", it will append the sequence number at the end of the file name.
Results recorded in Synchronous Mode are easier to view -- all the data is in a single file. However, you cannot view the data until the end of the session, and for high-volume or complex transactions, synchronous capture can consume significant memory.
Recording transaction data asynchronously consumes less memory, and enables you to view transactions data before the end of the Transaction Trace Session.
-Dintroscope.clw.tt.mode=(Synch|Asynch)
Output to Transaction Events Database only
Use this option to run a transaction trace and save the output only to the Transaction Events Database (no XML file output). This command is useful when triggered by an Introscope Alert to automatically start tracing transactions when the Alert is triggered.
Precede the command with the word
quietly
as in:
quietly trace transactions exceeding 2 seconds in agents matching "(.*)" for 60 seconds
Return only header data
In some cases, when retrieving a large amount of transaction trace data via CLW, the
traces.db
file may grow without bound, causing CLW to take a long time to return. Setting this property to false solves the problem by reducing the amount of data returned by the Enterprise Manager.
CLW will then return only header trace data. By default or when this property is set to true, getting transaction trace data via the CLW will return both the header and body.
-Dwily.ps.workstation.clws.gettracebody
Transaction Tracer Clamp
The size of an individual Transaction Trace is now clamped when it reaches 5000 trace components by default. Any Transaction Trace exceeding the clamp will be discarded at the agent and a warning message like the following will be logged in the agent log file:
2/23/07 05:33:18 PM PST [WARN] [IntroscopeAgent] Transaction trace component limit of 5000 reached, recording will cease for this transaction.
To change the maximum number of components allowed in a transaction trace, change the following agent property:
introscope.agent.transactiontrace.componentCountClamp=max_TT_components (default is 5000)
For example, the following line in the agent profile:
introscope.agent.transactiontrace.componentCountClamp=30000
will change the maximum components allowed in a Transaction Trace to 30,000.
Warning!
If this clamp size is increased, the memory required for transaction traces may be higher and as such, it may be necessary for you to adjust the max heap size for the JVM accordingly or else the Enterprise Manager may run out of memory.
Transaction Trace command examples
This section provides examples of CLW commands to start a Transaction Trace Session. Each example command initiates a session 600 seconds long. Transactions that take longer than 5 seconds, from all agents, are traced.
Note:
All example commands use default login settings to connect to the Enterprise Manager.
For examples of scripts that run Transaction Trace Sessions, see Sample Scripts.
Transaction Trace using default option values
This CLW command starts a Transaction Trace Session using default settings for:
  • Trace Mode -- Transaction Trace data is captured synchronously -- all results are written to a single XML file.
  • Directory Location -- When
    -Dintroscope.clw.tt.dirname
    is not specified, trace results are written to the current working directory.
java -jar CLWorkstation.jar trace transactions exceeding 5 seconds in agents matching "(.*)" for 600 seconds
Transaction Trace using asynchronous capture
This CLW command starts a Transaction Trace Session using the default directory location for session output:
java - Dintroscope.clw.tt.mode=Asynch -jar CLWorkstation.jar trace transactions exceeding 5 seconds in agents matching "(.*)" for 600 seconds
Data is captured asynchronously -- a separate XML file is created for each transaction.
Transaction Trace results written to a user-defined directory
This CLW command starts a Transaction Trace Session using the default setting for Trace Mode -- Transaction Trace data is captured synchronously. All results are written to a single XML file:
java - Dintroscope.clw.tt.dirname=C:\mytraces -jar CLWorkstation.jar trace transactions exceeding 5 seconds in agents matching "(.*)" for 600 seconds
This command specifies a non-default location for the XML file -- the
C:\mytraces
directory.
Transaction Trace using parameter and error filters
You can initiate a Transaction Trace session that specifies the number of seconds to run and uses the same filters that are available in the Workstation -- user ID, URL, URL query, session ID, request header, request parameter, session attribute, and error:
Filtering on User ID, URL, URL query, or session ID
trace transactions where (userid|url|url query|sessionid) (equals|not equals|contains|not contains|starts with|ends with) [EXACT MATCH] in agents matching [REGULAR EXPRESSION] for [EXACT MATCH] (second|seconds|sec|secs|s) trace transactions where (userid|url|url query|sessionid) (exists|not exists) in agents matching [REGULAR EXPRESSION] for [EXACT MATCH] (second|seconds|sec|secs|s) quietly trace transactions where (userid|url|url query|sessionid) (equals|not equals|contains|not contains|starts with|ends with) [EXACT MATCH] in agents matching [REGULAR EXPRESSION] for [EXACT MATCH] (second|seconds|sec|secs|s) quietly trace transactions where (userid|url|url query|sessionid) (exists|not exists) in agents matching [REGULAR EXPRESSION] for [EXACT MATCH] (second|seconds|sec|secs|s)
Filtering on request header, request parameter, or session attribute
trace transactions where (request header|request parameter|session attribute) [EXACT MATCH] (equals|not equals|contains|not contains|starts with|ends with) [EXACT MATCH] in agents matching [REGULAR EXPRESSION] for [EXACT MATCH] (second|seconds|sec|secs|s) trace transactions where (request header|request parameter|session attribute) [EXACT MATCH] (exists|not exists) in agents matching [REGULAR EXPRESSION] for [EXACT MATCH] (second|seconds|sec|secs|s) quietly trace transactions where (request header|request parameter|session attribute) [EXACT MATCH] (equals|not equals|contains|not contains|starts with|ends with) [EXACT MATCH] in agents matching [REGULAR EXPRESSION] for [EXACT MATCH] (second|seconds|sec|secs|s) quietly trace transactions where (request header|request parameter|session attribute) [EXACT MATCH] (exists|not exists) in agents matching [REGULAR EXPRESSION] for [EXACT MATCH] (second|seconds|sec|secs|s)
Filtering on errors
trace transactions with errors containing [EXACT MATCH] in agents matching [REGEX] for [EXACT MATCH] (second|seconds|sec|secs|s) quietly trace transactions with errors containing [EXACT MATCH] in agents matching [REGEX] for [EXACT MATCH] (second|seconds|sec|secs|s)
Transaction Trace Queries from Transaction Events Database
Transaction Trace results are automatically stored in the Transaction Events Database. Use the CLW commands described here to retrieve that data.
Get Historical Events Matching <VALUE>
This command retrieves a full event XML output file from the Transaction Events Database. A full event (as opposed to a summary event, below) is the full data available in the lower section of the Transaction Event Viewer.
java - Dintroscope.clw.tt.mode=Asynch -jar CLWorkstation.jar get historical events matching "localhost"
Here is an example of the output:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <TransactionTracerSession Duration="78" Version="0.1" EndDate="2005-06-20T17:40:24.146-08:00" StartDate="2005-06-20T17:40:24.068-08:00" User="Admin"> <TransactionTrace Domain="SuperDomain" Duration="78" Process="UnknownProcess" Host="maddleman-dt2" AgentName="Tomcat" StartDate="2005-06-20T17:40:24.068-08:00" EndDate="2005-06-20T17:40:24.146-08:00"> <CalledComponent RelativeTimestamp="0" Duration="78" ComponentType="Browser" ComponentName="Browser" MetricPath="Browser"> <CalledComponents> <CalledComponent RelativeTimestamp="0" Duration="0" ComponentType="JNDI" ComponentName="ProxyDirContext" MetricPath="JNDI|Context|ProxyDirContext"> <Parameters> <Parameter Value="lookup" Name="Method"/> </Parameters> </CalledComponent> <CalledComponent RelativeTimestamp="0" Duration="0" ComponentType="JNDI" ComponentName="ProxyDirContext" MetricPath="JNDI|Context|ProxyDirContext"> <Parameters> <Parameter Value="lookup" Name="Method"/> </Parameters> </CalledComponent> <CalledComponent RelativeTimestamp="0" Duration="62" ComponentType="Servlets" ComponentName="HelloWorldExample" MetricPath="Servlets|HelloWorldExample"> <CalledComponents> <CalledComponent RelativeTimestamp="0" Duration="0" ComponentType="JNDI" ComponentName="ProxyDirContext" MetricPath="JNDI|Context|ProxyDirContext"> <Parameters> <Parameter Value="lookup" Name="Method"/> </Parameters> </CalledComponent> <CalledComponent RelativeTimestamp="0" Duration="0" ComponentType="JNDI" ComponentName="ProxyDirContext" MetricPath="JNDI|Context|ProxyDirContext"> <Parameters> <Parameter Value="lookup" Name="Method"/> </Parameters> </CalledComponent> </CalledComponents> </TransactionTrace> </TransactionTracerSession>
Get summaries matching <VALUE>
This command retrieves only the event summary XML from the Transaction Events database and outputs an XML file. An event summary is information available in the top pane of the Transaction Event Viewer. This command is useful to export data from the Transaction Events database for generating reports on the number of errors the system experiences by day, for example.
get historical event summaries matching [REGULAR EXPRESSION]
Here is an example of the output:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <TransactionTracerSession Duration="78" Version="0.1" EndDate="2005-06-20T17:40:24.146-08:00" StartDate="2005-06-20T17:40:24.068-08:00" User="Admin"> <TransactionTrace Domain="SuperDomain" Duration="78" Process="UnknownProcess" Host="maddleman-dt2" AgentName="Tomcat" StartDate="2005-06-20T17:40:24.068-08:00" EndDate="2005-06-20T17:40:24.146-08:00"> <CalledComponent RelativeTimestamp="0" Duration="78" ComponentType="Browser" ComponentName="Browser" MetricPath="Browser"> <Parameters> <Parameter Value="" Name="URL"/> <Parameter Value="Normal" Name="Trace Type"/> <Parameter Value="\20050620\17\1119314425302" Name="Trace ID"/> <Parameter Value="" Name="User ID"/> </Parameters> </CalledComponent> </TransactionTrace> </TransactionTracerSession>
Loadbalancing.xml Commands
The MOM uses the loadbalancing.xml file to load balance agents across a cluster and to allow agents to connect to specific Collectors. These commands update the loadbalancing.xml file.
Autoprepare Loadbalancing.xml
This command can be run on the MOM during upgrade. Use this command when agents have agent to Collector connections defined in the IntroscopeAgent.profile.
The MOM collects the runtime information about all the agents that are connected directly to the Collectors. The MOM populates the connection information at the bottom of loadbalancing.xml.
Run this command after the MOM and all the Collectors are upgraded to 9.1.2 or later and
before
the agents are upgraded. If you run the command after the agents are upgraded, the MOM cannot gather the former agent to Collector connection information.
For more information, see Installing and Upgrading.
Syntax
autoprepare loadbalancing.xml
Example
autoprepare loadbalancing.xml
Agent Name
Collector Name
AgentA
Collector01
AgentB
Collector01
AgentC
Collector02
AgentD
Collector02
AgentE
Collector03
AgentF
Collector03
The organization uses loadbalancing.xml to load balance an agent named EPAgent2.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <loadbalancing xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="loadbalancing0.1.xsd"> <agent-collector name="Example 1"> <agent-specifier>.*\|.*\|EPAgent2</agent-specifier> <exclude> <collector latched="false" port="5001" host="Collector02"/> </exclude> </agent-collector> <agent-collector name="Collector01@5001 auto-generated configuration"> <agent-specifier>HostName|ProcessName|AgentA</agent-specifier> <agent-specifier>HostName|ProcessName|AgentB</agent-specifier> <include> <collector latched="false" port="5001" host="Collector01"/> </include> </agent-collector> <agent-collector name="Collector02@5001 auto-generated configuration"> <agent-specifier>HostName|ProcessName|AgentC</agent-specifier> <agent-specifier>HostName|ProcessName|AgentD</agent-specifier> <include> <collector latched="false" port="5001" host="Collector02"/> </include> </agent-collector> <agent-collector name="Collector03@5001 auto-generated configuration"> <agent-specifier>HostName|ProcessName|AgentE</agent-specifier> <agent-specifier>HostName|ProcessName|AgentF</agent-specifier> <include> <collector latched="false" port="5001" host="Collector03"/> </include> </agent-collector> </loadbalancing>
Example 1 was a loadbalancing.xml entry before the Administrator ran the command. The MOM added the auto-generated entries after Example 1.
Output
Loadbalancing.xml is updated with the agent to Collector connection entries.