Chat now with support
Chat with Support

Benchmark Factory for Database 8.0 - User Guide

Getting Started Overview of Benchmark Factory Benchmark Factory Components Agents Connections Create and Edit Tests and Jobs Test Results and Run Reports Troubleshooting Licensing The Benchmark Factory REST API

Licensing

The Benchmark Factory Licensing dialog allows you to enter a new license key, modify a license, or modify the virtual user pack.

The active license or licenses in Benchmark Factory determine the available features, including the ability to connect to certain types of databases. Benchmark Factory supports multiple licenses. This can enable multiple license-dependent features.

Note: If you delete an active Trial key from the Licensing dialog, any features enabled by the Trial key and not included in one of the remaining active licenses will be disabled.

To access the licensing dialog

  1. Click Help | Licensing.

From this dialog you can:

Enter a New License Key

To enter a new license key

  1. In the Licensing dialog, click the blank tab.
  2. Enter your Authorization key and the site message you received with your key.

Modify the Benchmark Factory License

If required, you can modify your Benchmark Factory license key.

To modify the license key

  1. Click the tab for the product license key you want to modify.
  2. Click Modify.
  3. Update the Authorization Key and Site Message.

Modify the  Benchmark Factory Virtual User Pack

Benchmark Factory comes with 100 virtual users. Benchmark Factory Freeware comes with 20 virtual users.  To add up to an unlimited number of virtual users, enter a virtual user key.

To modify the Virtual User Pack

  1. Click the Virtual User Pack tab.
    1. To send an email to Quest Software to extend a trial, click Extend Trial.
    2. To visit the Quest Software Web site and purchase a license, click Purchase License.
    3. To modify the current license, click Modify.
    4. Enter the authorization key and site message.

Upgrade Earlier-Version License Key

License keys compatible with Benchmark Factory 5.8.1 (or earlier) are no longer supported.

To upgrade your license key

  1. Go to Help | Licensing to find your license number in your current version of Benchmark Factory. If not explicitly listed, it may be included as part of the Site Message associated with your key.

    Example: ACCOUNTNAME-nnn-nnn-nnn

  2. Then go to the License Key Upgrade page: http://license.quest.com/upgrade.
  3. Enter your e-mail address and your existing license number, and then follow the prompts.

If you need help finding your license number or an upgrade key, please contact the License Administration team: https://support.quest.com/licensing-assistance.

Licensing and Keys

The Benchmark Factory Licensing dialog allows you to enter a new license key, modify a license, or modify the virtual user pack.

The active license or licenses in Benchmark Factory determine the available features, including the ability to connect to certain types of databases. Benchmark Factory supports multiple licenses. This can enable multiple license-dependent features.

Note: If you delete an active Trial key from the Licensing dialog, any features enabled by the Trial key and not included in one of the remaining active licenses will be disabled.

To access the licensing dialog

  1. Click Help | Licensing.

From this dialog you can:

Enter a New License Key

To enter a new license key

  1. In the Licensing dialog, click the blank tab.
  2. Enter your Authorization key and the site message you received with your key.

Modify the Benchmark Factory License

If required, you can modify your Benchmark Factory license key.

To modify the license key

  1. Click the tab for the product license key you want to modify.
  2. Click Modify.
  3. Update the Authorization Key and Site Message.

Modify the  Benchmark Factory Virtual User Pack

Benchmark Factory comes with 100 virtual users. Benchmark Factory Freeware comes with 20 virtual users.  To add up to an unlimited number of virtual users, enter a virtual user key.

To modify the Virtual User Pack

  1. Click the Virtual User Pack tab.
    1. To send an email to Quest Software to extend a trial, click Extend Trial.
    2. To visit the Quest Software Web site and purchase a license, click Purchase License.
    3. To modify the current license, click Modify.
    4. Enter the authorization key and site message.

Upgrade Earlier-Version License Key

License keys compatible with Benchmark Factory 5.8.1 (or earlier) are no longer supported.

To upgrade your license key

  1. Go to Help | Licensing to find your license number in your current version of Benchmark Factory. If not explicitly listed, it may be included as part of the Site Message associated with your key.

    Example: ACCOUNTNAME-nnn-nnn-nnn

  2. Then go to the License Key Upgrade page: http://license.quest.com/upgrade.
  3. Enter your e-mail address and your existing license number, and then follow the prompts.

If you need help finding your license number or an upgrade key, please contact the License Administration team: https://support.quest.com/licensing-assistance.

Adding Virtual Users

Benchmark Factory comes with 100 virtual users by default.  Benchmark Factory Freeware comes with 20 virtual users. Virtual users simulate the load against the system-under-test. Each virtual user is a separate thread, acting independently of the other virtual users, with its own connection to the system-under-test. Each virtual user tracks its own statistics that includes transaction times and the number of times a transaction executes.

Benchmark Factory can scale up to an unlimited number of concurrent load users. Additional virtual users allow you to:

  • Accurately determine system throughput and capacity for database systems
  • Simulate thousands of concurrent users with a minimal amount of hardware
  • Find applications that do not scale well with an increase in the number of users
  • Find breaking points, weak links, or bottlenecks of a system
  • Quantify application or server performance with realistic workloads

To request additional concurrent load users, please contact your Quest Software representative, or visit the Benchmark Factory Web site.

The Benchmark Factory REST API

Benchmark Factory provides a REST API that allows you to access the functionality of Benchmark Factory, but without the need to interact with the Benchmark Factory graphic user interface. A REST API is an application program interface (API) that uses HTTP requests to GET, POST, PUT, and DELETE data. Through the REST API, you can use a script, command-line tool, or custom application to automate your load testing tasks using Benchmark Factory.

You can use the Benchmark Factory REST API with the Benchmark Factory console application or BMFServer.exe. BMFServer.exe is a non-UI application included in the Benchmark Factory installation. See BMFServer.exe for more information.

Why Integrate Benchmark Factory

Integrating Benchmark Factory into your continuous testing / continuous improvement process allows you to test the scalability of changes before committing those changes to your production environment. Different Benchmark Factory tests can be used to validate scalability and performance.

  • Use Industry Standard Benchmark tests to test for scalability
  • Use Capture and Replay tests to verify application performance

Base URI Format

To interface with Benchmark Factory using the REST API, use the following URI format:

http://{server}:{port}/api/{resource}

Where {server} is the Benchmark Factory host server, {port} is the port number, and {resource} is the name of the resource.

Example: http://localhost:30100/api/jobs

Console and BMFServer.exe Port Numbers

Use the applicable REST API port number for the Benchmark Factory application you are using.

  • Benchmark Factory Console: port 30100
  • BMFServer.exe: port 30110

HTTP Request Methods

GET - Retrieves a list of resources

POST - Creates a new resource based on the data provided in the request body

PUT - Updates the resource to the value/values provided in the data supplied in the HTTP data area

DELETE - Deletes the resource

Start Benchmark Factory

Benchmark Factory must be running to use the REST API. Start the Benchmark Factory console or BMFServer.exe prior to sending requests via the REST API.

Note: You cannot run the Benchmark Factory console and BMFServer.exe on the same machine at the same time.

Request and Response Format

Both XML and JSON are supported request and response formats. Specify the response format in the Accept header of the request. Indicate the request format in the Content-Type header of the request.

New Resource Name/Index

When you create a resource, such as a job or connection, the new resource is assigned a zero-based index. This number can be used to identify the resource. However, the index number attached to the resource will change as users remove and add resources. For best results, define a name for the resource and then use the resource name in your requests.

Response Header Content

If a resource (such as a connection or a job) is created, the response header usually contains the URL for the newly-created resource.

Response Codes

These are the expected response codes returned. In addition, some other status codes may be returned if either an internal error occurs or there are other issues.

Code Description
200 Success
201 Success. Resource created.
204 Success. No content returned.
400 The request failed.
404 The specified resource was not found.
405 The method is not supported for the specified resource.

Job Status Codes

Each job state or status has a code. These are the codes returned when you get the job status. Use these codes to change a job’s status (e.g., start a job, stop a job).

Code Status Action when included in a request
1 Complete Stops a running job.
2 Running Runs a job, if possible.
3 Ready Readies a job to run on schedule. Stops a running job.
4 Hold Prevents a job from running. Stops a running job.
5 Stop Stops a running job.

 

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating