Configuring PBench

NOTE:
This page will contain an explanation of stages and how to define stages by creating JSON files, what directory to put them in, and how to tell PBench to use the custom stages. Delete this note before publishing.

Creating a Stage File

Create a JSON file for each stage of a benchmark.

See Parameters for the format of stage JSON files.

Always begin with a description.

A child stage inherits some parameters such as catalog and schema from its parent if those parameters are not explicitly set in the child file. If a child stage has multiple parents, the child stage inherits those parameters from the first of the parent stages that finishes, which starts the child stage.

Defining the Order of Stages

Use the next parameter in a stage file to define the order of stage files in a benchmark run.

For example, consider the four files stage1.json, stage2.json, stage3.json, and stage4.json:

.. image:: stage-flow.png :width: 400 :alt: a simple stage flow diagram

• stage1.json has the following entry for next:

"next": [
  "stage_2.json",
  "stage_3.json"
]

• stage2.json and stage3.json have the following entry:

"next": [
  "stage_2.json",
  "stage_3.json"
]

• stage4.json is the last stage of the benchmark run and has no next parameter entry.

For more information see next.

Creating a Query File

A query file is an SQL query that called by the QueryFiles parameter of a stage file. For an example, see query_01.sql.

Configuring InfluxDB and MySQL Connections

Save connection information for InfluxDB and MySQL connections in configuration files, then use those configuration files with pbench run with the --influx and --mysql command options.

InfluxDB

NOTE:
An example configuration template for InfluxDB named influxdb.template.json can be found in the PBench repository. Copy influxdb.template.json to the directory local to PBench and edit it as appropriate.

Create a file named influxdb.json similar to the following example and edited as appropriate in the directory local to PBench.

Use --influx influxdb.json with pbench run to call the new file.

{
  "url": "https://example.com)",
  "org": "myorg",
  "bucket": "benchmark",
  "token": "*******=="
}

MySQL

NOTE:
An example configuration template for MySQL named mysql.template.json can be found in the PBench repository. Copy mysql.template.json to the directory local to PBench and edit it as appropriate.

Create a file named mysql.json similar to the following example and edited as appropriate in the directory local to PBench.

Use --mysql mysql.json with pbench run to call the new file.

{
  "username": "presto",
  "password": "*******",
  "server": "localhost",
  "database": "test"
}