> User Documentation Home

User Handbook
Tutorials
Resources

The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

Benchmark Plugin

View this plugin on the Plugins site

benchmark: Benchmark results

The Benchmark Plugin collect and display boolean and numeral results. The results may come from one or multiple files. The result may be either in XML or JSON format. The content of the file may follow either a standard or a custom schema. The schema type may be selected using the drop-down menu and the custom schema entered in the associated text area.

In addition, the Benchmark Plugin provides the capability to associate different types of thresholds on numerical values to one or multiple results. If crossed, the thresholds will identify results as failures and ultimately trigger the build failure.

The Benchmark Plugin, if successful, provides access to two pages where results are displayed. One with tables compiling information on all results and one with the details for a specific result.

  • inputLocation
    Location of the result files relative to the workspace.
    The locations may include wildcards using the character "*".
    JSON and XML formats supported. Must match the selected schema format.
    Create a list of locations in a file with the "*.list" extension.
    • Type: String
  • schemaSelection
    The schema defines the content of the result files.
    JSON and XML formats supported.
    Note: xUnit is an XML format.
    • Type: String
  • truncateStrings
    Truncate strings to 512 characters. Strongly suggested. Affects storage processing and loading time.
    • Type: boolean
  • altInputSchema
    Custom schema. JSON and XML formats supported.
    • Type: String
  • altInputSchemaLocation
    Location of custom schema relative to the workspace.
    JSON and XML formats supported.
    • Type: String
  • thresholds (optional)
    This field is meant to define additional result thresholds, not located inside the result file.
    • Type: ? extends org.jenkinsci.plugins.benchmark.thresholds.Threshold

Was this page helpful?

Please submit your feedback about this page through this quick form.

Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?

    


See existing feedback here.