UXTerm

Each UltraESB-X instance may expose a set of troubleshoot reporting tasks. The Management API facilitates the invocation of a subset of these tasks sequentially, as a task queue, bundling the results of all tasks into an archive on the remote system, which can be fetched manually or downloaded via the API.

Some tasks allow customization via parameters. Such parameters can be specified during invocation by prepending the task name with a comma-separated list of key=value pairs, following the syntax

task1(param1=value1,param2=value2[,…​])[,…​]

where key corresponds to a parameter name and value is its value. If any of the parameters are not specified, a default value defined by the task will be utilized. For example,

thread-dump(period=5,count=3),conf-dir,detailed-logs(period=300,logger=org.adroitlogic.x.transport.http.nio)

will invoke the tasks

Currently the following in-built tasks are provided in the UltraESB-X distribution:

Additionally, the UXTerm configuration allows one to define several task bundles for quick invocation of groups of tasks. A task bundle is basically a predefined queue of tasks, denoted by a comma-separated list of task names, referred to by a single name (bundle name); for example,

ultra.terminal.troubleshoot.bundles.info=esb-info, sys-info

in the UXTerm configuration denotes a task bundle named info, including the two tasks esb-info and sys-info. Note that the bundle name should be added to the name list under ultra.terminal.troubleshoot.bundles property for it to be identified correctly by the commmand; for example,

ultra.terminal.troubleshoot.bundles=full, dump, info

Instead of a list of tasks, one can specify a task bundle name when invoking the troubleshoot report command, in which case the associated list of tasks will be submitted to the server.

Some tasks, such as configuration archival, offer an option to run their output through a masking logic, encrypting portions of sensitive content (e.g. passwords or keys) using a user-specified password. This can be useful if you plan to submit the troubleshoot report to the original developers for further analysis, and in case the credentials need to be unmasked during a later stage, the password can be disclosed separately. The parameters -p, -m, -k and -c in the tbsrstr command govern the masking process. The same masking parameters are applied to all applicable tasks (having the maskable flag) in the submitted queue.

Tasks are picked using the -t and -b parameters of the tbsrstr command. Bundles specified in -b will be expanded into the respective task names, and merged with task names specified in -t. If -i (ignore) arguments are also specified, they would be removed from the generated task list, to derive the final list (queue) of tasks for execution. You can refer to a task or bundle name by a part of its name, as long as it is unambiguous. For example, when invoking tbsrstr with -b, instead of specifying the full name of a bundle named configuration-archival you can simply enter config, as long as no other task bundle name contains the word config.

Lists the troubleshoot reporting tasks available on the connected UltraESB-X instance.

Syntax: tbsrol [-v]

Starts a troubleshoot reporting session on the connected instance.

Syntax: tbsrstr [-a] [-b <bundle-list>] [-c <cipher>] [-f <target-file>] [-i <tasks-to-ignore>] [-k <key-factoy>] [-m <mask>] [-p <password>] [-t <task-list>]

E.g. : tbsrstr -f /tmp/threads.zip -t heap,thread(period=5,count=3) -m password=[^\s]* -p ultraesb

Checks the status of a previous asynchronous troubleshoot reporting invocation.

Syntax: tbsrstchk

The output includes the execution state of each executed task, along with the completion status (success/failure) and the time taken by each, and the overall status and elapsed time for the whole invocation.