2014ForgeRock ASaddrate1OpenDJ${docTargetVersion}addratemeasure add & delete throughput and response timeaddrateoptionstemplate-file-pathDescription
This utility can be used to measure add and optionally delete
throughput and response time of a directory server using user-defined entries.
The template-file-path argument
identifies a template file that has the same form as a template file
for the makeldif command.
For details, see
makeldif.template.
Options
The following options are supported.
Specifies the age at which added entries will become candidates for deletion
Use asynchronous mode and do not wait for results before sending the next request
Warm up duration in seconds
Default value: 0
Number of connections
Default value: 1
The algorithm used for selecting entries to be deleted which must be one of "fifo", "random", or "off".
Default value: FIFO
Maximum duration in seconds, 0 for unlimited
Default value: 0
Calculate max response time for a percentile of operations
Keep connections open
Keep connections open and do not rebind
A constant that overrides the value set in the template file
Display results each specified number of seconds
Default value: 5
Max iterations, 0 for unlimited
Default value: 0
Target average throughput to achieve
Default value: 0
Path to look for template resources (e.g. data files)
The seed to use for initializing the random number generator
Default value: 0
Specifies the number of entries to be added before deletion begins
Default value: 10000
Use script-friendly mode
Number of worker threads per connection
Default value: 1
LDAP Connection Options
DN to use to bind to the server
If you do not specify a bind DN,
then the operations are performed as an anonymous user.
In many directories anonymous users have no right to add or delete entries.
Use the authorization identity control
Directory server hostname or IP address
Default value: localhost.localdomain
Bind password file
Certificate key store path
Nickname of the certificate that the server should use
when accepting SSL-based connections or performing StartTLS negotiation
SASL bind options
Directory server port number
Default value: 389
Certificate trust store path
Use StartTLS to secure communication with the server
Certificate trust store PIN
Certificate key store PIN file.
A PIN is required when you specify to use an existing certificate
as server certificate
Certificate trust store PIN file
Use the password policy request control
Password to use to bind to the server
Certificate key store PIN
Trust all server SSL certificates
Use SSL for secure communication with the server
Utility Input/Output Options
No properties file will be used to get default command line argument values
Path to the file containing default property values used for command line arguments
Use verbose mode
General Options
Display version information
Display usage information
Exit Codes0
The command completed successfully.
80
The command could not complete due to an input/output error.
89
An error occurred while parsing the command-line arguments.
Examples
The following examples use this template file,
addrate.template.
sn:
cn: {givenName} {sn}
initials: {givenName:1}{sn:1}
employeeNumber:
uid: user.{employeeNumber}
mail: {uid}@[maildomain]
userPassword: password
telephoneNumber:
homePhone:
pager:
mobile:
street: Street
l:
st:
postalCode:
postalAddress: {cn}${street}${l}, {st} {postalCode}
description: This is the description for {cn}.
]]>
The following example adds entries, and then randomly deletes them
when more than 10,000 entries have been added.
$ addrate -p 1389 -D "cn=Directory Manager" -w password \
-f -c 10 -C random -s 10000 addrate.template
-----------------------------------------------------------------------
Throughput Response Time
(ops/second) (milliseconds)
recent average recent average 99.9% 99.99% 99.999% err/sec Add%
-----------------------------------------------------------------------
400.0 401.3 24.304 24.304 205.497 208.726 208.726 0.0 100.00
254.9 327.9 38.836 29.970 216.574 291.131 291.131 0.0 100.00
576.8 411.0 17.176 23.977 208.726 291.131 291.131 0.0 100.00
876.0 527.3 11.119 18.633 195.236 255.678 291.131 0.0 93.93
758.0 573.5 12.959 17.133 189.765 255.678 291.131 0.0 49.97
^C
The following example also adds entries, and then deletes them
in the order they were added after they are 10 seconds old.
$ addrate -p 1389 -D "cn=Directory Manager" -w password \
-f -c 10 -C fifo -a 10 addrate.template-----------------------------------------------------------------------
Throughput Response Time
(ops/second) (milliseconds)
recent average recent average 99.9% 99.99% 99.999% err/sec Add%
-----------------------------------------------------------------------
2656.8 2665.4 3.478 3.478 66.896 170.495 185.655 2006.4 100.00
643.2 1650.1 15.342 5.799 74.356 170.495 185.655 0.0 99.41
830.2 1376.3 11.778 7.004 88.155 271.071 284.580 0.0 0.02
901.1 1257.3 10.843 7.692 81.984 271.071 284.580 0.0 49.41
597.4 1125.3 16.542 8.633 89.126 271.071 284.580 0.0 100.00
^C