Benchmark Factory for Database 8.4 - User Guide

Welcome to Benchmark Factory

Benchmark Factory® is a database performance testing tool that allows you to conduct database workload replay, industry-standard benchmark testing, and scalability testing.

For additional instructional information on Benchmark Factory, please visit the Benchmark Factory Toad World Community at https://www.toadworld.com/products/benchmark-factory-for-databases.

Review the following topics for a quick overview of Benchmark Factory.

• About Benchmark Factory
• Understanding Benchmark Factory Testing
• Understanding Benchmark Factory Terminology
• How Benchmark Factory Works
• The Benchmark Factory Environment
• Getting Started - the Benchmark Factory Workflow

What's New in Benchmark Factory

New Features in 8.4

Benchmark Factory 8.4 is a minor release and includes the following new features and enhancements. For a list of resolved issues in this release, see the Benchmark Factory 8.4 Release Notes at the Quest Support Portal.

Database Support

This release of Benchmark Factory includes support for the following database versions:

• SQL Server 2019

Secure the REST API

• Only support HTTPS

• Add Authentication for External host to Access REST API

Benchmark Factory server supports TLS1.2 and later version, it will generate self signed certificate. The default setting for REST API is just for Local access. Start with Local Access to REST API.

If the external host wants to access Benchmark Factory server through REST API, the request header need to add Authentication. How to Allow external host access REST API

New Features in 8.3

Benchmark Factory 8.3 is a minor release and includes the following new features and enhancements. For a list of resolved issues in this release, see the Benchmark Factory 8.3 Release Notes at the Quest Support Portal.

Microsoft SQL Server Support

The Benchmark Factory Agent for Linux can now be used when testing against the following database types (in addition to PostgreSQL, Oracle and MySQL):

• Microsoft SQL Server
• Microsoft SQL Server. If using the Benchmark Factory Agent for Linux to test against a Microsoft SQL Server database, ensure the unixODBC and msodbcsql Client are installed on the same Linux machine as the Agent. Installing the Microsoft SQL Server ODBC Driver, see Installing the Microsoft ODBC Driver for SQL Server on Linux and macOS.

Database Support

This release of Benchmark Factory includes support for the following database versions:

• Oracle 19c

Enhancements to the Benchmark Factory

• Benchmark Factory Agent for Linux. You can now gather CPU and Memory from the Benchmark Factory Agent for Linux. This display in Benchmark Factory Main window Bottom Agent panel.
• REST API. You can now use URL(api/jobs/tests/testindex/currentresult) to get current results of the test results are same as they display in UI.

New in Benchmark Factory 8.2.1

Benchmark Factory 8.2.1 is a minor release and includes resolved issues. For a complete list, see the Benchmark Factory 8.2.1 Release Notes at the Quest Support Portal.

New Features in 8.2

Connections

MySQL Native Connection. Beginning with this release, Benchmark Factory now provides the ability to create a MySQL connection using Native database connectivity.

1. To create a MySQL Native connection, click the New Connection button in the main toolbar. Then select MySQL from the Database Type drop-down list.
2. Select the Native tab in the New Connection dialog and enter the connection information.

Note: The following Benchmark tests are supported: TPC-C, TPC-E, and TPC-H.

Database Support

This release of Benchmark Factory includes support for the following database versions:

• Oracle 18c
• MySQL 8.0

Enhancements to the Benchmark Factory Agent for Linux

In release 8.1, Benchmark Factory introduced an agent which you can deploy in your Linux environment. Benchmark Factory 8.2 includes several significant enhancements to the Agent for Linux.

Automatically Install Remote Agent on Linux

You can now install an agent on a remote Linux machine through the Benchmark Factory Console. This provides an easy, UI-based method for installing a remote agent on a Linux platform.

1. To install an agent on Linux through the console, select Edit | Settings | Agent. Then click Setup New User Agent.
2. Select Linux and click OK. Enter the name or IP address and the connection information for the remote Linux machine on which you want to install the agent. If no agent is found, you are prompted to install one. Click Yes to automatically install an agent for Linux.
3. After the agent is successfully installed, you can select it from the list of available agents.

Installation Package

The Benchmark Factory Agent for Linux is now distributed as an RPM package. This provides a number of advantages over the previous archive file (.tar) format. This format allows BMF to provide automatic installation through the Benchmark Factory Console. You can also use YUM to install the Benchmark Factory Agent RPM package on Linux manually.

To download the RPM package for manual installation, go to https://bintray.com/quest/bmfrepo. For additional information, see "Install Remote Agent on Linux" in the Benchmark Factory Help. For best results, install the Agent for Linux automatically through the Benchmark Factory Console.

Oracle and MySQL Support

The Benchmark Factory Agent for Linux can now be used when testing against the following database types (in addition to PostgreSQL):

• Oracle
• MySQL

Oracle. If using the Benchmark Factory Agent for Linux to test against an Oracle database, ensure an Oracle Client is installed on the same Linux machine as the Agent. Review the following details:

• The Oracle Client and Oracle Instant Client, versions 10g R2 and later, are supported.
• If you use a version of the Oracle Instant Client later than 10g R2, you must create a symbolic link to the shared library for the Oracle Instant Client you intend to use.
• Additional Information—For additional prerequisites and more-detailed information, see "Install Remote Agent on Linux" in the Benchmark Factory Help.

Note: The features described in the New in This Release section apply to the commercial version of Benchmark Factory and may not be available in the freeware edition.

Thursday, August 6, 2020

Additional Resources

Learn More and Connect with the Community

Use the following links to videos, blogs, and community resources to learn more about Benchmark Factory, to find answers to questions, and to advance your knowledge through Benchmark Factory tips and tricks.

• Benchmark Factory Community—Ask questions, join the discussion, find useful resources, and join the Beta program (when available).
• Product Documentation (Support Portal) —Find documents for current and past releases, as well as documents for other Toad products, on the Quest Support Portal.
• Benchmark Factory blogs—Find How To's, useful articles, and tips and tricks for using Benchmark Factory.
  • How to use the REST API (part 1)—Learn how to use the Benchmark Factory REST API.
  • How to use the REST API (part 2)—Learn how to modify an existing job or connection using the REST API.
  • REST API—This page lists the Benchmark Factory REST API resources and includes example request and response content.
  • Sample Powershell script usingREST API—This sample PowerShell script demonstrates some basic functionality of the Benchmark Factory REST API.
  • Benchmarking Best Practices—10 best practices to help you get started with database benchmarking.
  • Project Converter—Use this tool to convert an Oracle capture project file created in an earlier version of Benchmark Factory to .xml format.
• Toad World—Visit other Toad Communities, including Toad for Oracle. Find DBMS and SQL knowledge, find software downloads, and find answers to your database questions.
• Benchmark Factory Product Information—Find white papers, product demos, and purchasing information.

Overview of Benchmark Factory