These are the commands and options available for tracing ADSM clients.
Purpose
Use the QUERY TRACESTATUS command to display a list of available trace flags and their current settings.
Format
>>-Query Tracestatus--+-----------+----------------------------><
'- options--'
Parameters
Query Tracestatus -ALl
Query Tracestatus -OFf
Query Tracestatus -ON
Query Tracestatus -PASsword=secret
Query Tracestatus -NOTrace
Query Tracestatus -TRACEFIle=/u/user/traceout
Query Tracestatus -TRACEFLags=general,session
Examples
Use the NOTRACE option to turn tracing off if tracing is enabled on the client.
You can use NOTRACE on the command line as an option in an ADSM command, but you cannot use it in the client options file.
Syntax
>>-NOTrace-----------------------------------------------------><
Examples
Use the TRACEMAX option to specify the maximum size, in kilobytes, that the tracefile can grow to.
Syntax
>>-TRACEMAX size-----------------------------------------------><
Parameters
The default is 0, which disables trace file wrapping and allows the trace file to grow indefinitely.
Examples
Use the TRACEFILE option to place the trace output into a specified file. If the file does not already exist, then it is created. If the file exists, then the TRACE output is appended to the file.
If your trace file reaches the maximum size that you set with the TRACEMAX option, subsequent trace entries could wrap over previous entries in the file. In other words, wrapping would overwrite existing entries at the beginning of the current file.
There are message indicators showing where new entries begin and where the oldest entry appears. The first trace entries follow the starting trace texts such as "Tracing is active..." or "Tracefile maximum ...". The last entry of the trace is followed by an eyecatcher text "end of data - close". Shown below is an extract of a typical file as an example.
Figure 1. Example of a trace file
+--------------------------------------------------------------------------------+ |ADSM trace 3969 10240 | |04/22/1995 12:11:44.0449 : trace.c (1140): Tracing is active to file 't.out'. | |04/22/1995 12:11:44.0452 : trace.c (1141): Tracefile maximum length set to 10k| |04/22/1995 12:11:44.0453 : trace.c (1150): -----------------------------------| |04/22/1995 12:11:44 - Trace begun. | | . | | . (trace entries here) | | . | |04/22/1995 12:11:44.0548 : procopts.c(5907): | |04/22/1995 12:11:44.0771 : anspsqry.c( 610): psqSendQuery: Using 'STANDARD' as t| | . | | . | | . | |end of data - close | +--------------------------------------------------------------------------------+
You can set TRACEFILE in your client options file or specify it as an option on an ADSM command.
Syntax
>>-TRACEFIle--- filespec---------------------------------------><
Parameters
If TRACEFILE is not specified and tracing is active, trace statements are sent to standard output by default.
Examples
Numerous components in the system have informational tracing imbedded. Tracing is activated by specifying trace flags for the desired component or area.
You can use TRACEFLAGS in your client options file or as an option in an ADSMcommand.
Syntax
.----------------.
V |
>>-TRACEFlags-------+- flag---+--+-----------------------------><
'- -flag--'
Parameters
To leave particular flags off, preface the flags with a dash (for example, -txn).
When using TRACEFLAGS on a command, use commas to separate the individual trace flag values.
The default value is no tracing.
| Trace flags are not case-sensitive. | |
| Flag | Description |
|---|---|
| ALL | Enables: All traceflags except INSTR, INSTR_CLIENT, INSTR_CLIENT_DETAIL, INSTR_VERBOSE |
| ADMIN | Administrative component |
| ALLCOMM | Enables: COMM, 3270COMM, EHLLAPI, 3270ERROR |
| ALLSESS | Enables: SESSION, VERBINFO, SESSVERB, VERBADMIN |
| ALLFILE | Enables: DIROPS, FILEOPS, FIOATTRIBS |
| ALLBACK | Enables: INCR, TXN, POLICY |
| ALLPROC | Enables: ALLBACK, ALLFILE, ALLSESS |
| API | API tracing |
| AUDIT | List files backed up or restored (Macintosh and Windows) |
| COMM | Communications interface |
| COMMFULL | Communications driver data
This trace flag produces large amounts of trace data. |
| COMMDETAIL | Detailed communications
When the communications buffer is larger than 192 bytes, this trace flag displays only the first and last 96 bytes of data. |
| COMPRESS | Compression, expansion processing |
| CONFIG | Configuration file processing |
| CONFIRM | Confirm tracing |
| DIRDETAIL | Detailed directory operations |
| DIROPS | Directory operations |
| EHLLAPI | PC3270W V3.0 EHLLAPI tracing |
| ENTER | Entering or exiting a major function |
| ERROR | Severe errors tracing |
| ERRPROG | X'800' turns on a bit to indicate special error program
processing.
This is used for daemon-initiated errors (from Space Management, for example) that need special error handling |
| EVENT | Event logging tracing |
| EXIT | Function exits |
| FILELISTS | User interface file list processing |
| FILEOPS | File I/O operations |
| FIOATTRIBS | File and directory attributes during backup and archive |
| FS | File space processing |
| FSPS | Platform-specific filesystem tracing |
| GENERAL | General process flow operations |
| INCR | Incremental process operations |
| INSTR | Instrumentation tracing |
| INSTR_API | API instrumentation |
| INSTR_CLIENT | Client entry or exit and network times |
| INSTR_CLIENT_DETAIL | Print detailed process information |
| INSTR_VERBOSE | Print all and final time statistics |
| LINK | Hard link processing (UNIX) |
| MEMDETAIL | Detailed memory tracing |
| MEMORY | Memory allocation, buffer pool |
| MESSAGES | User interface event messages |
| NETWARE | Enables SMSDEBUG |
| NLS | National Language Support processing
This trace flag produces large amounts of trace data. |
| NTREGISTRY | Windows NT Registry tracing |
| OPTIONS | Enables CONFIG |
| PERFORM | Enables: CONFIG, STATS, INSTR_CLIENT_DETAIL |
| PID | Enables process or thread identification information |
| POLICY | Policy management tracing |
| PREFIX | Adds module(line number) tracing suffixes to messages
Enabled by default. May be disabled by using -PREFIX in the TRACEFLAGS lists |
| SERVICE | Enables: ALL, -NLS, -COMMDETAIL, -COMMFULL, -DIRDETAIL, -MEMORY, -MEMDETAIL |
| SESSION | Session layer tracing |
| SESSVERB | Enables raw verb tracing |
| SM | Space Management tracing (UNIX) |
| SMSDEBUG | Storage Management Services (NetWare) |
| SMVERBOSE | Space Management detailed tracing (UNIX) |
| STATS | Backup and archive statistics |
| TEST | Development test flag |
| TIMESTAMP | Timestamps on trace records
Enabled by default. May be disabled by using -TIMESTAMP in the TRACEFLAGS lists |
| TRUSTED | Trusted Communications Agent specific tracing (UNIX) |
| TXN | Backup and Archive Transaction list processing. |
| VERBADMIN | Administrator Datastream tracing |
| VERBINFO | Client-server Verb fields contents tracing |
| WINUAETRAP | Catches Windows unauthorized access errors |
| 3270COMM | Low-level 3270 for Windows tracing |
| 3270ERROR | Low-level 3270 error tracing (Windows) |
Examples
dsmc -TRACEFLags=ALL,-commdetail,-nls
You can monitor the performance of the ADSM Lotus Notes Backup Agent (ADSM Notes) operations by setting up tracing. First, turn tracing on by setting the environment variable DSMNOTES_TRACE in the NOTES.INI file. For example:
DSMNOTES_TRACE=ON
The name of the trace file is TRACE.DSM. Its location is determined by the environment variable DSMNOTES_TRACEDIR in NOTES.INI. For example:
DSMNOTES_TRACEDIR=c:\mydir
TRACE.DSM does not wrap. Its contents are overwritten each time a new ADSM Notes operation, like an incremental backup or a single restore, is invoked.