Trace options
Trace has several options that you can employ.
DSMTRACEListen
- DSMTRACEListen No | Yes
- No
- The client does not start the trace listener thread and dynamic tracing is not available. The default is No.
- Yes
- The client starts the trace listener thread and dynamic tracing is available.
The DSMTRACEListen option
is specified in the client options file (usually dsm.opt).
dsmtrace
- dsmtrace enable <pid> <options>
- Use this command to start or modify tracing for a process.
- pid
- The process ID (PID) for the client. Use dsmtrace query pids or your operating system facilities to identify the correct PID.
- options
- The client trace options.
- dsmtrace disable <pid>[<options>]
- Use this command to stop tracing for a process. The trace file
closes and the trace flags, maximum trace size, maximum trace segment
size, and trace file name are all cleared.
- <pid>
- The PID for the client. Use dsmtrace query pids or your operating system facilities to identify the correct PID.
- <options>
- The client trace options.
- dsmtrace help
- This command displays basic syntax for dsmtrace.
- dsmtrace query pids [-Filter=<spec>]
- <spec>
- The client process name filter specification, which can include
the wildcard characters
?
(match exactly one character) or*
(match zero or more characters).If no filter is specified, then the default behavior is to display process information for any running instances of the program names listed in the table in the Background section above.Thus, instead of -filter=dsmc or -filter=domdsmc, use -filter=*dsmc* or -filter=*domdsmc*.
Important: When using the FILTER, put the
* symbol before and after the search text. This adjustment is necessary because the executable file
name often includes the path in front of it, and in some cases, the executable file name might have
additional characters at the end of it. For example:- /opt/tivoli/tsm/client/ba/bin/dsmc
- domdsmc_DominoUserID
- dsmtrace query trace <pid> [<options>] [<displayType>] [-ALl | -ON | -OFf | -BASic]
- <pid>
- The process ID (PID) for the client. Use dsmtrace query pids or your operating system facilities to identify the correct PID.
- <options>
- The client trace options.
- <displayType>
- The display type can be one of the following entries:
- ALl
- Displays all trace flags and, for each flag, indicates whether it is turned on or off. The information shown with the -BASIC display type is also included.
- ON
- Displays the names of the trace flags that are turned on. The information shown with the -BASIC display type is also included.
- OFf
- Displays the names of the trace flags that are turned off. The information shown with the -BASIC display type is also included.
- BASic
- Displays the name of the trace file and the maximum trace and trace segment sizes. This display type also indicates whether tracing is enabled or disabled.
-PIPENameprefix
- -PIPENameprefix=<pipeNamePrefix>
- The -PIPENameprefix option must be used when
tracing application programming interface (API) applications:
- Use prefix /tmp/TsmTraceTargetAPI
- Use prefix \\.\pipe\TsmTraceTargetAPI
-TRACEFIle
- -TRACEFIle=<traceFileName>
- The -TRACEFIle option must specify a valid file name to which the trace is written. If tracing is already running, then this option has no effect.
-TRACEFLags
- -TRACEFLags=<traceFlags>
- Specify one or more trace flags. Typically, the trace flag SERVICE is used. Separate multiple trace flags with a comma. Trace flags can also be turned off by prefixing the flag name with a minus sign. When combining trace flags that you want to turn on, with trace flags that you want to turn off, put the flags that you want to turn off at the end of the list. For example, if you want to turn on SERVICE tracing except for VERBDETAIL, specify -TRACEFLAGS=SERVICE,-VERBDETAIL. If tracing is already running, then this option can be used to turn on additional trace flags or turn off trace flags.
-TRACEMax
- -TRACEMax=<maximumTraceSize>
- This option limits the maximum trace file length to the specified value (by default the trace file grows indefinitely). When the maximum length is reached, then the trace wraps back to the beginning of the file. Specify a value in MB between 1 and 4095. If tracing is already running, this option has no affect.
-TRACESegsize
- -TRACESegsize=<maximumTraceSegmentSize>
- This option is used when you anticipate a large trace file and
you want the trace file to be written in smaller, more easily-managed
segments. Each segment is no larger than the specified size. When
this option is used, a segment number is appended to the trace file
name for each segment. Specify a value in MB between 1 and 1000. If
tracing is already running, this option has no affect.Note:
- To turn tracing on for a process, you must use the -TRACEFLAGS and -TRACEFILE options (and -PIPENAMEPREFIX when tracing an API application).
- To modify trace flags for an existing process, use -TRACEFLAGS (and -PIPENAMEPREFIX when tracing an API application).
- If you need to modify the trace file name, maximum trace size, or maximum trace segment size, then you need to first disable tracing altogether (see the dsmtrace disable command).