Skip to content

Plugins

Jump to bottom
mpinardi edited this page Aug 21, 2020 · 2 revisions

Plugin Basics

Cucumber Performance supports a number of output and processing plugins. This functions similar to Cucumber plugins with a few notable differences.

  • Multiple Options: Each plugin can take up to two arguments. The first can be any number of class types. While the second is a array of string options. This is declared by adding a second colon following the plugins argument.

    • Example: myplugin:argument1:option1,option2,.. or myplugin:argument1:{option1,option2,..}

  • Post Fixes: Certain formatter plugins support adding dynamic post fix's to the name of a output file. See the formatter plugins section for details.

  • Statistics plugins: Certain plugins can be added to your execution that provide new statistics at the end of your test.

Add plugins with -f, --perf-format <TYPE[:PATH:OPTIONS]> to specify a way to format result data. Formats accept a path which will be used for output. If no path is provided then StdOut is used.

Statistics

  1. Statistics

    This internal plugin processes the all the non chart related statistics. It is enabled by default.

    You can specify extra statistics to add to your output. These can be manually specified or passed to the statistics formatter by other plugins.

    To manually specify statistics you can add a statistics creator via the plugin options.

    Example: -f statistics

  2. Standard Deviation Calculates the standard deviation for each group, scenario and step in your test run.

    Example: -f statistics:stdev

  3. Percentile Calculates the the percentile for each group, scenario and step in your test run. This plugin supports one option which is the percentage to use.

    Example: -f statistics:prctl:70,prctl:95.5

Display Formatters

  1. Progress This plugin will write out a single line summary of execution.

    Type: progress

    Example: -f progress

Output Formatter Plugins

These support postfix's for file names. The | char separates the path from the postfix.

A auto incremented number with padding is supported:

format: #[PADDING_ZEROS][START_NUM] example: #0001

Time stamps are also supported:

format: @[JAVA_DATE_FORMAT] example: @HHmmss

  1. Summary Formatter Creates a file with the text from the default summary.

    Type: summary

    Example: -f summary:C:/test/summary

  2. Chartpoints Formatter Creates a csv file with points for creating charts.

    Type: chartpoints

    Example: -f chartpoints:C:/test/chartpoints

    You can also specify the number of points for the chart.

    Example: -f chartpoints:C:/test/chartpoints:10

Logger

This plugin outputs a run time log to a output file.

Type: logger

Example: -f logger:C:/test/log.txt

This plugin can also import an existing log file. Run any additional formatters to process the imported results.

Example: -f logger::\test\log.txt -f summary:\test\summary.txt

Clone this wiki locally