Command line options

Documentation / Enterprise Edition / User Guide / Appendix / Command line options
 

Standard options

The following set of options are supported by all MyARM commands line tools:

-cf conf_file , --conf-file conf_file
specifies the configuration file to use instead of the default one.
-h, -?, --help
prints a help page.
--version
prints the current version number of the program.
--build
prints the current build number of the program.
--edition
prints the current edition name the program belongs to.

The following options allow to override the configured datasink or datasource.

-so source-url , --source-url source-url
The source-url is a database location expressed in the common URL notation. A detailed description of supported database URLs is in section "Database URL notation".

For example, an exported XML file can be analysed if all relevant data are exported into that file. The command:

myarmquery --source-url xml:///export_data.xml Apache2

will print any transactions of the ARM application Apache2 found in the export_data.xml XML file.

-si sink-url , --sink-url sink-url
The sink-url is a database location where ARM data should be written to. It uses the common URL notation as described in the "Database URL notation". section. This option can be used to override the configured datasink with MyARM tools which write ARM data to a database such as myarmexport.

Constraints options

The following set of options can be used by any MyARM command line tool which operates on transaction data such as myarmquery or myarmexport:

-ai <op><value>, --app-instance <op><value>
specifies the application instance <value> to match application or transactions instances. Supported <op> operators can be found in section "Constraint value operators".
-ag <op><value>, --app-group <op><value>
specifies the application group <value> to match application or transactions instances. Supported <op> operators can be found in section "Constraint value operators".
--context <name><op><value>
with the --context option, a context property filter can be specified in the form of a <key><op><value> tuple. Supported <op> operators can be found in section "Constraint value operators".
-u user, --user user
specifies the user name for each matching transaction.
--uri <op><value>
specifies the URI <value> for matching transactions. Supported <op> operators can be found in section "Constraint value operators".
-ts tran-status, --tran-status tran-status
specifies the ARM transaction status to be matched.
-sn system-name, --system-name system-name
specifies the system name to match application or transaction instances.
--rt-min min
specifies the minimum response time to match a transaction.
--rt-max max
specifies the maximum response time to match a transaction.
-sf time, --start-from time
specifies the start time from which to select transactions.
-su time, --start-until time
specifies the start time until transactions should match.
--utc time
specifies that the from and/or until start time is expressed in UTC.
-oc, --only-children
specifies that only transaction with children should match.
-or, --only-root
specifies that only transactions which are root transactions of a transaction tree should match.

Formatting options

To interpret time and response time arguments correctly, you can set the appropriate format specifications with the following options:

-tmf string, --time-fmt string
Use string for formatting and scanning times. See appendix "Configuring time formats".
-dtf string, --date-fmt string
Use string for formatting and scanning dates. See appendix "Configuring date formats".
-rf string, --rt-fmt string
Specifies how the response time is displayed or parsed. See appendix "Configuring response time formats".

Sorting options

If the underlying database supports sorting of data you can use the following options to specify sort criteria and order.

-sb criteria, --sort-by criteria
specify by which criteria the output of transaction or application data should be sorted. Currently valid sorting criteria are:
None
no sorting at all
Start
sorting by start time of the transactions
Stop
sorting by stop time of the transactions
Duration
sorting by response time of the transactions
Arrival
sorting by arrival time of the transactions
Blocked
sorting by blocked time of the transactions
-sd, --sort-descending
specify descending sort order. By default it is ascending.

Constraint value operators

Operator Description
~= the string is interpreted as a pattern as supported by the underlying (SQL) database. The value can include a single '%' character matching any number of characters or '_'matching exactly one character. To use the '%'or '_'characters inside the value string use '\ 'to escape it, e.g. '\%'
= matches any string which equals to this string
!= matches any string which is not equal to this string
> matches any string which is greater than this string
< matches any string which is less than this string

Application and transaction names

Application and/or transaction names are supported by various MyARM commands and are specified in the form <appName>:<tranName>. The application and transaction name is separated by a colon (':'). If you want to select only a specific transaction name for any application, just provide an empty application name :<tranName>.

If the application or transaction name contains a colon (':') it must be escaped with a second colon. For example the application name WebSphere:APPLICATION_SERVER must be escaped and specified as follows:

myarmquery WebSphere::APPLICATION_SERVER

And to select a specific transaction a single colon delimits the application name from the transaction name:

myarmquery WebSphere::APPLICATION_SERVER:URI