Enableinstrumentation

By default, instrumentation data is automatically collected by the backup-archive client and Tivoli® Storage Manager API to identify performance bottlenecks during backup and restore processing. To disable or later enable instrumentation, use the enableinstrumentation option.

With this option enabled, you do not have to wait for a customer service representative to direct you to collect performance data when a problem occurs. Instead, the data can be collected whenever you run a backup or restore operation. This feature can be helpful because you do not have to re-create the problem just to collect performance data. The information is already collected by the client.

This option replaces the -TESTFLAG=instrument:detail, -TESTFLAG=instrument:API, and -TESTFLAG=instrument:detail/API options that are used in previous versions of the client and API.

For each process, the following types of performance instrumentation data are collected:

The activity names for each thread (such as File I/O, Data Verb, Compression, and Transaction), the average elapsed time per activity, and the frequency of the activity.
The total activity time of each thread.
The command that was issued and the options that were used.
The summary of the backup, restore, or query command.

By default, the performance data is stored in the instrumentation log file (dsminstr.log) in the directory that is specified by the DSM_LOG environment variable (or the DSMI_LOG environment variable for API-dependent products such as Tivoli Storage Manager for Databases: Data Protection for Microsoft SQL Server and Tivoli Storage Manager for Mail: Data Protection for Microsoft Exchange Server). If you did not set the DSM_LOG environment variable, the instrumentation log file is stored in the current directory (the directory where you issued the dsmc command).

You can optionally change the name and location of the instrumentation log file by using the instrlogname option. You can also control the size of the log file by specifying the instrlogmax option.

Performance data is not collected for the backup-archive client GUI or web client GUI.

Performance data is collected for the following products when the enableinstrumentation option is specified in the client options file:

Scheduled file-level backup operations with the backup-archive client
Tivoli Storage Manager for Virtual Environments: Data Protection for VMware backups
Tivoli Storage Manager for Virtual Environments: Data Protection for Microsoft Hyper-V backups
Tivoli Storage Manager for Databases: Data Protection for Microsoft SQL Server backups
Tivoli Storage Manager for Mail: Data Protection for Microsoft Exchange Server backups

Performance data is also collected during archive and retrieve processing.

Supported Clients

This option is valid for all clients and the Tivoli Storage Manager API.

Options File

AIX operating systems HP-UX operating systems Linux operating systems Oracle Solaris operating systems Mac OS X operating systems Place this option in the client system-options file (dsm.sys) within a server stanza. The option can be set in the client option set on the Tivoli Storage Manager server.

Windows operating systems Place this option in the client options file (dsm.opt). The option can be set in the client option set on Tivoli Storage Manager server.

Tip: This option is enabled by default, so typically, you do not need to place this option in the client options file unless you need to disable the option.

Syntax


                          .-Yes-.   
>>-ENABLEINSTRUMENTATION--+-----+------------------------------><
                          '-No--'

Parameters

Yes: Specifies that you want to collect performance data during backup and restore operations. The default value is Yes, which means that performance data is collected even if you do not specify this option.
By default, the performance data is stored in the instrumentation log file (dsminstr.log) in the directory that is specified by the DSM_LOG environment variable. If you did not set the DSM_LOG environment variable, the instrumentation log file is stored in the current directory (the directory where you issued the dsmc command). If the file does not exist, the client creates the file and adds performance data to the file.
No: Specifies that you do not want to collect performance data during backup and restore operations. If the instrumentation log exists, no more data is added to the file.

Examples

Options file:

enableinstrumentation yes

Command line:

dsmc sel /home/mydir/* -subdir=yes -enableinstrumentation=yes

dsmc sel c:\mydir\* -subdir=yes -enableinstrumentation=yes

This option is valid only on the initial command line. It is not valid in interactive mode.