org.apache.hadoop.hive.metastore.tools

Class BenchmarkSuite

java.lang.Object

org.apache.hadoop.hive.metastore.tools.BenchmarkSuite

public final class BenchmarkSuite
extends Object

Group of benchmarks that can be joined together. Every benchmark has an associated name and code to run it. It is possible to run all benchmarks or only ones matching the filter.

Results can be optionally sanitized - any result that is outside of mean +/- margin * delta is removed from the result set. This helps remove random outliers.

Example

   StringBuilder sb = new StringBuilder();
   Formatter fmt = new Formatter(sb);
   BenchmarkSuite suite = new BenchmarkSuite();
      // Arrange various benchmarks in a suite
      BenchmarkSuite result = suite
           .setScale(scale)
           .doSanitize(true)
           .add("someBenchmark", someBenchmarkFunc)
           .add("anotherBenchmark", anotherBenchmarkFunc)
           .runMatching(patterns, exclude);
      result.display(fmt);
 

Constructor Summary

Constructors

Constructor and Description
BenchmarkSuite()

Method Summary

Modifier and Type	Method and Description
BenchmarkSuite	add(@NotNull String name, @NotNull Supplier<org.apache.commons.math3.stat.descriptive.DescriptiveStatistics> b) Add new benchmark to the suite.
BenchmarkSuite	doSanitize(boolean sanitize) Enable or disable result sanitization.
Map<String,org.apache.commons.math3.stat.descriptive.DescriptiveStatistics>	getResult() Get raw benchmark results
List<String>	listMatching(@Nullable Pattern[] positive, @Nullable Pattern[] negatve) Return list of benchmark names that match positive patterns and do not match negative patterns.
BenchmarkSuite	runMatching(@Nullable Pattern[] positive, @Nullable Pattern[] negatve) Run all benchmarks (filtered by positive and negative matches.
BenchmarkSuite	setScale(TimeUnit scale) Set scaling factor for displaying results.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BenchmarkSuite

public BenchmarkSuite()

Method Detail

setScale

public BenchmarkSuite setScale(TimeUnit scale)

Set scaling factor for displaying results. When data is reported, all times are divided by scale functor. Data is always collected in nanoseconds, so this can be used to present data using different time units.

Parameters:

scale: - scaling factor

Returns:

this for chaining

doSanitize

public BenchmarkSuite doSanitize(boolean sanitize)

Enable or disable result sanitization. This should be done before benchmarks are executed.

Parameters:

sanitize - enable sanitization if true, disable if false

Returns:

this object, allowing chained calls.

getResult

public Map<String,org.apache.commons.math3.stat.descriptive.DescriptiveStatistics> getResult()

Get raw benchmark results

Returns:

map of benchmark name to the statistics describing the result

listMatching

public List<String> listMatching(@Nullable
                                 @Nullable Pattern[] positive,
                                 @Nullable
                                 @Nullable Pattern[] negatve)

Return list of benchmark names that match positive patterns and do not match negative patterns.

Parameters:

positive - regexp patterns that should match benchmark name

negatve - regexp patterns that should be excluded when matches

Returns:

list of benchmark names

runMatching

public BenchmarkSuite runMatching(@Nullable
                                  @Nullable Pattern[] positive,
                                  @Nullable
                                  @Nullable Pattern[] negatve)

Run all benchmarks (filtered by positive and negative matches. See listMatching(Pattern[], Pattern[]) for details.

Parameters:

positive - regexp patterns that should match benchmark name

negatve - regexp patterns that should be excluded when matches

Returns:

this

add

public BenchmarkSuite add(@NotNull
                          @NotNull String name,
                          @NotNull
                          @NotNull Supplier<org.apache.commons.math3.stat.descriptive.DescriptiveStatistics> b)

Add new benchmark to the suite.

Parameters:

name - benchmark name

b - benchmark corresponding to name

Returns:

this