idsperftune

Use the idsperftune command to tune your directory server performance.

Description

Administrators can use the idsperftune command to achieve a higher directory performance by tuning caches, DB2® buffer pools, and DB2 parameters. The command can be run in basic mode, by using the -B parameter. The basic tuning can be run before you use an instance or after the instance is in use for a long time. The advanced mode, with -A parameter, can be run only after the instance is subjected to a typical workload. The advanced tuning analyzes DB2 performance metrics and makes recommendations for fine-tuning database parameters. The idsperftune command provides recommendations for DB2 parameters in the perftune_stat.log file in following format.
# DB2 parameters=Current Value:Recommendation
# Recommendation can be Not Collected|OK|Increase|Decrease			
An example with the suggested action.
PCKCACHESZ=1533:Increase
In this example, you can increase the value of PCKCACHESZ based on the recommendation.

The idsperftune command stores the directory server and DB2 database parameters values as initial parameters in the perftune_stat.log file. These parameters are stored under the section INITIAL TUNING PARAMETER VALUE ( Prior to First Update Operation ) in the log file. These values do not change later and are recorded in the format: I_<...>. The idsperftune command stores the old values of directory server and DB2 database parameters in the perftune_stat.log file. These values are stored under the section OLD DB2 PARAMETER VALUE ( Prior to last Update Operation ) in the log file. These values are recorded in the format: O_<..>.

Note:
  • The operation of idsperftune depends on a list of values from the administrator, which if not specified are set to their default values. The command accepts the property file, perftune_input.conf, and is the only mode of input from the administrator. The property file includes a list of values as attribute-value pairs. An administrator must update all the attribute values as per the requirement and run the command by providing the perftune_input.conf property file as input.
  • The idsperftune command does basic tuning where the directory cache size is calculated based on the input from administrator. The command also runs advanced tuning, where the health of DB2 parameter is computed. Administrator must consider the computed size of directory cache and DB2 parameter health values that are updated in the perftune_stat.log property file.
  • Based on the DB2 parameters changes in the log file, you can run the idsperftune command to update the DB2 parameter values. The idsperftune command logs the old value of each DB2 parameter before it updates the new value, which can be used for later reference.
  • The property files are at the following locations.
    • instance-home/idsslapd-inst-name/etc/perftune_input.conf
    • instance-home/idsslapd-inst-name/logs/perftune_stat.log
  • You can set the value of the SYS_MEM_AVL variable to false after you finish running the idsperftune command. If the value is false, it indicates that there is not sufficient memory available on the system to cache all the entries in directory server entry cache. In this case, you must consider increasing the memory to be used or consider reducing the number of entries by using the -E parameter.
  • By default, the idsperftune command uses 90 percent of the system memory and tries to cache 80 percent of the entries.
  • The idsperftune command uses the default port, for example 389. To specify a port number other than the default port number, you must use the -p parameter. The idsperftune command does not use the port number from the configuration file.

Synopsis

idsperftune -I instance_name -B | -A | [-u -B -p port][-u] 
             [-i property_file] [-s] [-m ][-o] [-b output_file] 
             [-f config_file] [-E entry_cache_pct] 
             [-F filter_cache_size][-d debug_level] [-v | -?]

Options

The idsperftune command takes the following parameters.
-A
Specifies to run advanced tuning of DB2 configuration.
-B
Specifies to run basic tuning of directory server cache and DB2 buffer pools.
-b output_file
Specifies the full path of a file in which to redirect output. If debug mode is set, the debug output is sent to this file.
-d debuglevel
Sets the debug level.
-E entrycache_size
Sets the target percentage of entries to be cached.
-F filtercache_size
Sets the size of filter cache.
-f configfile
Specifies the full path of the server configuration file.
-I instance_name
Specifies the name of the directory server instance to tune.
-i property_file
Specifies the property file, which contains tuning parameters.
-m
Sets the monitor switches for BUFFERPOOL and SORT. If used with -A, it captures database snapshot after a time interval of 5 minutes.
-o
Disables monitor switches for BUFFERPOOL and SORT.
-p port
Specifies the port number to use for the instance.
-s
Sets the default value for the total number of entries and average entry size in the file that is based on directory content.
-u
Updates DB2 and directory server cache configuration settings.
-v
Prints the version information about the command.
-?
Specifies to show the syntax format.

Examples

Example 1:
To update the file with total entries and average entry size, run the idsperftune command with the following parameters:
idsperftune –I instance_name -s
You can use the values that are generated from the idsperftune command with the -s parameter to estimate the growth in directory server.
Example 2:
To run basic tuning on the myinst directory server, run the following command:
idsperftune –I myinst –i property_file -B –u
In the -u parameter is specified, the server and database instance is updated with the suggested LDAP cache and DB2 buffer pool values. If specified without the -u parameter, then the suggested settings are updated in the perftune_stat.log file only.
Example 3:
To run advanced tuning on the myinst directory server, run the following command:
idsperftune –I myinst –i property_file -A –m
If you use the -u parameter with the command, monitor switches for BUFFERPOOL and SORT are set.
Example 4:
To get basic tuning recommendations, run the idsperftune command with the following parameters:
idsperftune –I instance_name -B
Example 5:
To update the database with the suggested parameters during the basic tuning, run the idsperftune command with the following parameters:
idsperftune –I instance_name -B –u 
Or
idsperftune –I instance_name –u 
Example 6:
To get advanced tuning recommendations without turning the monitor switches ON, run the idsperftune command with the following parameters:
idsperftune –I instance_name -A
Example 7:
To update the database with the suggested DB2 parameters during advanced tuning without turning the monitor switches ON, run the idsperftune command with the following parameters:
idsperftune –I instance_name -A –u
Example 8:
To get advanced tuning recommendations and to turn the monitor switches ON, run the idsperftune command with the following parameters:
idsperftune –I instance_name -A -m
The monitor switches are turned OFF after the command completes its operation.
Example 9:
To update the database with the suggested DB2 parameters during the advanced tuning and to turn the monitor switches ON, run the idsperftune command with the following parameters:
idsperftune –I instance_name -A –u -m
The monitor switches are turned OFF after the tool completes its operation.
Example 10:
To turn on the monitor flags for DB2 parameters, run the idsperftune command with the following parameters:
idsperftune –I instance_name -m
Example 11:
To turn off the monitor flags for DB2 parameters, run the idsperftune command with the following parameters:
idsperftune –I instance_name -o