Skip to content

Reference

Jump to bottom
smicyk edited this page Mar 2, 2024 · 4 revisions

after

Defines tear down group ('TearDown Group') element

after (
        name: string
        comments: string
        enabled: boolean (true)
        users: integer (1)                                [1..9223372036854775807]
        rampUp: integer (1)                               [1..9223372036854775807]
        keepUser: boolean (true)
        scheduler: boolean
        delay: integer                                    [0..9223372036854775807]
        duration: integer                                 [0..9223372036854775807]
        loops: integer (1)                                [1..9223372036854775807]
        forever: boolean
        onError: string ('continue')                      [continue, start_next, stop_user, stop_test, stop_now]
) {
}

aggregate

Defines 'Aggregate Report' element

aggregate (
        name: string
        comments: string
        enabled: boolean
        file: string
        errorsOnly: boolean
        successesOnly: boolean
        assertions: boolean
        bytes: boolean
        code: boolean
        connectTime: boolean
        dataType: boolean
        encoding: boolean
        fieldNames: boolean
        fileName: boolean
        hostname: boolean
        idleTime: boolean
        label: boolean
        latency: boolean
        message: boolean
        requestHeaders: boolean
        responseData: boolean
        responseHeaders: boolean
        sampleCount: boolean
        samplerData: boolean
        sentBytes: boolean
        subresults: boolean
        success: boolean
        threadCounts: boolean
        threadName: boolean
        time: boolean
        timestamp: boolean
        url: boolean
        xml: boolean
) {
}

ajp

Defines 'AJP Request' sampler

ajp (
        name: string
        comments: string
        enabled: boolean (true)
        method: string
        protocol: string
        domain: string
        port: integer                                     [1..65535]
        path: string
        encoding: string
        autoRedirects: boolean
        followRedirects: boolean (true)
        keepAlive: boolean (true)
        multipart: boolean
        browserCompatibleMultipart: boolean
        saveAsMD5: boolean
) {
}

body

Defines body for 'AJP Request' sampler

body (
        file: string
        inline: string
        encoding: string ('UTF-8')
) {
}

file

Defines single file upload for 'AJP Request' sampler

file (
        file: string
        name: object
        type: boolean
) {
}

files

Defines files upload for 'AJP Request' sampler

files (
) {
}

param

Defines single parameter for 'AJP Request' sampler

param (
        name: string
        value: object
        encoded: boolean
        encoding: string ('UTF-8')
) {
}

params

Defines parameters for 'AJP Request' sampler

params (
        values: map
) {
}

resources

Defines 'AJP Request' resources configuration

resources (
        parallel: integer (6)
        urlInclude: string
        urlExclude: string
) {
}

assert_duration

Defines 'Duration Assertion' element

assert_duration (
        name: string
        comments: string
        enabled: boolean (true)
        applyTo: string ('all')                           [all, parent, children, variable]
        duration: long                                    [0..9223372036854775807]
) {
}

assert_jmes

Defines 'JSON JMES Assertion' element

assert_jmes (
        name: string
        comments: string
        enabled: boolean (true)
        expression: string ('$.')
        assertValue: boolean
        assertAsRegex: boolean (true)
        value: string
        expectNull: boolean
        invert: boolean
) {
}

assert_json

Defines 'JSON Assertion' element

assert_json (
        name: string
        comments: string
        enabled: boolean (true)
        expression: string ('$.')
        assertValue: boolean
        assertAsRegex: boolean (true)
        value: string
        expectNull: boolean
        invert: boolean
) {
}

assert_md5hex

Defines 'MD5Hex Assertion' element

assert_md5hex (
        name: string
        comments: string
        enabled: boolean (true)
        value: string
) {
}

assert_response

Defines 'Response Assertion' element

assert_response (
        name: string
        comments: string
        enabled: boolean (true)
        applyTo: string ('all')                           [all, parent, children, variable]
        variable: string
        field: string ('response_data')                   [response_data, response_document, response_code, response_message, response_headers, request_data, request_headers, url]
        message: string
        rule: string ('contains')                         [contains, matches, equals, substring]
        ignoreStatus: boolean
        any: boolean
        negate: boolean
) {
}

assert_size

Defines 'Size Assertion' element

assert_size (
        name: string
        comments: string
        enabled: boolean (true)
        applyTo: string ('all')                           [all, parent, children, variable]
        variable: string
        field: string ('response_data')                   [response_data, response_body, response_code, response_message, response_headers]
        rule: string ('eq')                               [contains, matches, equals, substring]
        size: long                                        [0..9223372036854775807]
) {
}

assert_xpath

Defines 'XPath Assertion' element

assert_xpath (
        name: string
        comments: string
        enabled: boolean (true)
        applyTo: string ('all')                           [all, parent, children, variable]
        variable: string
        expression: string ('/')
        ignoreWhitespace: boolean
        validate: boolean
        useNamespace: boolean
        fetchDtd: boolean
        failOnNoMatch: boolean
        useTolerant: boolean
        reportErrors: boolean
        showWarnings: boolean
        quiet: boolean (true)
) {
}

authorization

Defines single authorization entry

authorization (
        url: string
        username: string
        password: string
        domain: string
        realm: string
        mechanism: string ('BASIC')                       [BASIC, DIGEST, KERBEROS, BASIC_DIGEST]
) {
}

authorizations

Defines 'Authorization' config element

authorizations (
        name: string
        comments: string
        enabled: boolean (true)
        clearEachIteration: boolean
        useUserConfig: boolean
) {
}

backend

Defines 'Backend Listener' element

backend (
        name: string
        comments: string
        enabled: boolean (true)
        classname: string ('org.apache.jmeter.visualizers.backend.influxdb.InfluxdbBackendListenerClient')
        queueSize: integer (5000)                         [1..9223372036854775807]
) {
}

argument

Defines single user variable in arguments

argument (
        name: string
        value: string
) {
}

arguments

Defines user variables element inside a backend listener

arguments (
        values: map
) {
}

before

Defines setup group ('SetUp Group') element

before (
        name: string
        comments: string
        enabled: boolean (true)
        users: integer (1)                                [1..9223372036854775807]
        rampUp: integer (1)                               [1..9223372036854775807]
        keepUser: boolean (true)
        scheduler: boolean
        delay: integer                                    [0..9223372036854775807]
        duration: integer                                 [0..9223372036854775807]
        loops: integer (1)                                [1..9223372036854775807]
        forever: boolean
        onError: string ('continue')                      [continue, start_next, stop_user, stop_test, stop_now]
) {
}

cache

Defines 'HTTP Cache Manager' config element

cache (
        name: string
        comments: string
        enabled: boolean (true)
        clearEachIteration: boolean
        useExpires: boolean (true)
        maxSize: integer (5000)                           [0..9223372036854775807]
        useUserConfig: boolean
) {
}

check_request

Defines simplified version of request assertions

check_request (
        enabled: boolean (true)
        applyTo: string ('all')                           [all, parent, children, variable]
) {
}

check_response

Defines simplified version of response assertions

check_response (
        enabled: boolean (true)
        applyTo: string ('all')                           [all, parent, children, variable]
) {
}

check_size

Defines simplified version of 'Size Assertion' element

check_size (
        enabled: boolean (true)
        applyTo: string ('all')                           [all, parent, children, variable]
) {
}

constant_throughput

Defines 'Constant Throughput Timer' element

constant_throughput (
        name: string
        comments: string
        enabled: boolean (true)
        target: double                                    [0..9223372036854775807]
        basedOn: string ('user')                          [user, all_users, all_users_shared, all_users_in_group, all_users_in_group_shared]
) {
}

constant_timer

Defines 'Constant Timer' element

constant_timer (
        name: string
        comments: string
        enabled: boolean (true)
        delay: long (300)                                 [0..9223372036854775807]
) {
}

cookie

Defines single cookie element

cookie (
        secure: boolean
        path: string
        domain: string
        name: string
        value: string
        expires: integer                                  [0..9223372036854775807]
) {
}

cookies

Defines 'HTTP Cookie Manager' config element

cookies (
        name: string
        comments: string
        enabled: boolean (true)
        clearEachIteration: boolean
        policy: string ('standard')                       [standard, compatibility, netscape, standard-strict, best-match, rfc2109, rfc2965, default, ignoreCookies]
useUserConfig: boolean
) {
}

counter

Defines 'Counter' config element

counter (
        name: string
        comments: string
        enabled: boolean (true)
        perUser: boolean
        reset: boolean
        start: integer
        end: integer (2147483647)
        increment: integer (1)
        variable: string ('c')
        format: string
) {
}

extract_css

Defines 'CSS Selector Extractor' element

extract_css (
        name: string
        comments: string
        enabled: boolean (true)
        applyTo: string ('parent')                        [parent, all, children, variable]
        useEmptyValue: boolean
        defaultValue: string
        match: integer                                    [0..9223372036854775807]
        variable: string
        expression: string
        attribute: string
        engine: string ('JSOUP')                          [JSOUP, JODD]
) {
}

csv

Defines 'CSV Data Set Config' config element

csv (
        name: string
        comments: string
        enabled: boolean (true)
        ignoreFirstLine: boolean
        allowQuotedData: boolean
        recycle: boolean (true)
        stopUser: boolean
        variables: string
        file: string
        encoding: string ('UTF-8')
        delimiter: string (',')
        shareMode: string ('all')                         [all, group, thread]
) {
}

debug

Defines 'Debug' sampler

debug (
        name: string
        comments: string
        enabled: boolean (true)
        displayJMeterProperties: boolean
        displayJMeterVariables: boolean (true)
        displaySystemProperties: boolean
) {
}

debug_postprocessor

Defines 'Debug PostProcessor' element

debug_postprocessor (
        name: string
        comments: string
        enabled: boolean (true)
        displayJMeterProperties: boolean
        displayJMeterVariables: boolean (true)
        displaySystemProperties: boolean
        displaySamplerProperties: boolean (true)
) {
}

defaults

Defines 'HTTP Request Defaults' config element

defaults (
        name: string
        comments: string
        enabled: boolean (true)
        protocol: string ('http')
        domain: string
        port: integer (80)
        method: string ('GET')
        path: string
        encoding: string
        impl: string
        saveAsMD5: boolean
) {
}

body

Defines body for 'HTTP Request Defaults' config

body (
        file: string
        inline: string
        encoding: string ('UTF-8')
) {
}

param

Defines single parameter for 'HTTP Request Defaults' config

param (
        name: string
        value: object
        encoded: boolean
        encoding: string ('UTF-8')
) {
}

params

Defines parameters for 'HTTP Request Defaults' config

params (
        values: map
) {
}

proxy

Defines 'HTTP Request Defaults' Proxy configuration

proxy (
        scheme: string
        host: string
        port: string
        username: string
        password: string
) {
}

resources

Defines 'HTTP Request Defaults' resources configuration

resources (
        parallel: integer (6)
        urlInclude: string
        urlExclude: string
) {
}

source

Defines 'HTTP Request Defaults' source configuration

source (
        type: string
        address: string
) {
}

timeout

Defines 'HTTP Request Defaults' timeout configuration

timeout (
        connect: integer                                  [1..9223372036854775807]
        response: integer                                 [1..9223372036854775807]
) {
}

dns

Defines 'DNS Cache Manager' element

dns (
        name: string
        comments: string
        enabled: boolean (true)
        clearEachIteration: boolean
        useSystem: boolean (true)
        servers: string
        values: map
) {
}

host

Defines static table host

host (
        name: string
        address: string
) {
}

execute

Defines generic execution controller (includes 'If', 'While', 'Once Only' and others)

execute (
        name: string
        comments: string
        enabled: boolean (true)
        type: string                                      [if, while, once, interleave, random, order, percent, total, runtime, switch]
) {
}

execute_if

Defines 'If' controller

execute_if (
        name: string
        comments: string
        enabled: boolean (true)
        condition: string
        useExpression: boolean (true)
        evaluateAll: boolean
) {
}

execute_interleave

Defines 'Interleave' controller

execute_interleave (
        name: string
        comments: string
        enabled: boolean (true)
        ignore: boolean
        acrossUsers: boolean
) {
}

execute_once

Defines 'Once Only' controller

execute_once (
        name: string
        comments: string
        enabled: boolean (true)
) {
}

execute_order

Defines 'Random Order' controller

execute_order (
        name: string
        comments: string
        enabled: boolean (true)
) {
}

execute_percent

Defines 'Throughput (Percent)' controller

execute_percent (
        name: string
        comments: string
        enabled: boolean (true)
        percent: integer (100)                            [0..100]
        perUser: boolean
) {
}

execute_random

Defines 'Random' controller

execute_random (
        name: string
        comments: string
        enabled: boolean (true)
        ignore: boolean
) {
}

execute_runtime

Defines 'Runtime' controller

execute_runtime (
        name: string
        comments: string
        enabled: boolean (true)
        runtime: integer (1)                              [0..9223372036854775807]
) {
}

execute_switch

Defines 'Switch' controller

execute_switch (
        name: string
        comments: string
        enabled: boolean (true)
        value: string ('0')
) {
}

execute_total

Defines 'Throughput (Total)' controller

execute_total (
        name: string
        comments: string
        enabled: boolean (true)
        total: integer (1)                                [0..9223372036854775807]
        perUser: boolean
) {
}

execute_while

Defines 'While' controller

execute_while (
        name: string
        comments: string
        enabled: boolean (true)
        condition: string
) {
}

flow

Defines 'Flow Control Action' sampler

flow (
        name: string
        comments: string
        enabled: boolean (true)
        action: string ('pause')                          [pause, stop, stop_now, restart_next_loop, start_next, break]
target: string ('current')                        [current, all]
duration: integer ('0')                           [0..9223372036854775807]
) {
}

for_each

Defines 'ForEach' controller

for_each (
        name: string
        comments: string
        enabled: boolean (true)
                in: string
        out: string
        separator: boolean (true)
        start: integer
        end: integer (1)
) {
}

gaussian_timer

Defines 'Gaussian Random Timer' element

gaussian_timer (
        name: string
        comments: string
        enabled: boolean (true)
        delay: long (100)                                 [0..9223372036854775807]
        range: double (300.0)                             [0..9223372036854775807]
) {
}

graphql

Defines 'GraphQL HTTP Request' sampler

graphql (
        name: string
        comments: string
        enabled: boolean (true)
        method: string ('POST')                           [POST, GET]
        protocol: string
        domain: string
        port: integer                                     [1..65535]
        path: string
        encoding: string
        autoRedirects: boolean
        followRedirects: boolean
        keepAlive: boolean (true)
        impl: string                                      [java, http]
        saveAsMD5: boolean
) {
}

execute

Defines 'GraphQL HTTP Request' execute configuration

execute (
        inline: string
        file: string
) {
}

operation

Defines 'GraphQL HTTP Request' operation configuration

operation (
        name: string
) {
}

proxy

Defines 'GraphQL HTTP Request' proxy configuration

proxy (
        scheme: string
        host: string
        port: string
        username: string
        password: string
) {
}

source

Defines 'GraphQL HTTP Request' source configuration

source (
        type: string
        address: string
) {
}

timeout

Defines 'GraphQL HTTP Request' timeout configuration

timeout (
        connect: integer                                  [1..9223372036854775807]
        response: integer                                 [1..9223372036854775807]
) {
}

variables

Defines 'GraphQL HTTP Request' variables configuration

variables (
        inline: string
        file: string
) {
}

group

Defines users group ('Thread Group') element

group (
        name: string
        comments: string
        enabled: boolean (true)
        users: integer (1)                                [1..9223372036854775807]
        rampUp: integer (1)                               [1..9223372036854775807]
        delayedStart: boolean
        keepUser: boolean (true)
        scheduler: boolean
        delay: integer                                    [0..9223372036854775807]
        duration: integer                                 [0..9223372036854775807]
        loops: integer (1)                                [-1..9223372036854775807]
        forever: boolean
        onError: string ('continue')                      [continue, start_next, stop_user, stop_test, stop_now]
) {
}

header

Defines single header

header (
    name: string
    value: string
) {
}

headers

Defines 'HTTP Header Manager' config element

headers (
    name: string
    comments: string
    enabled: boolean (true)
    values: map
) {
}

http

Defines 'HTTP Request' sampler

http (
    name: string
    comments: string
    enabled: boolean (true)
    method: string
    protocol: string
    domain: string
    port: integer                                     [1..65535]
    path: string
    encoding: string
    autoRedirects: boolean
    followRedirects: boolean (true)
    keepAlive: boolean (true)
    multipart: boolean
    browserCompatibleMultipart: boolean
    impl: string                                      [java, http]
    saveAsMD5: boolean
) {
}

body

Defines body for 'HTTP Request' sampler

body (
    file: string
    inline: string
    encoding: string ('UTF-8')
) {
}

file

Defines single file upload for 'HTTP Request' sampler

file (
    file: string
    name: object
    type: boolean
) {
}

files

Defines files upload for 'HTTP Request' sampler

files (
) {
}

param

Defines single parameter for 'HTTP Request' sampler

param (
    name: string
    value: object
    encoded: boolean
    encoding: string ('UTF-8')
) {
}

params

Defines parameters for 'HTTP Request' sampler

params (
    values: map
) {
}

proxy

Defines 'HTTP Request' proxy configuration

proxy (
    scheme: string
    host: string
    port: string
    username: string
    password: string
) {
}

resources

Defines 'HTTP Request' resources configuration

resources (
    parallel: integer (6)
    urlInclude: string
    urlExclude: string
) {
}

source

Defines 'HTTP Request' source configuration

source (
    type: string
    address: string
) {
}

timeout

Defines 'HTTP Request' timeout configuration

timeout (
    connect: integer                                  [1..9223372036854775807]
    response: integer                                 [1..9223372036854775807]
) {
}

include

Defines 'Include' controller

include (
    name: string
    comments: string
    enabled: boolean (true)
    file: string
) {
}

include_raw

Defines 'Include' controller with raw JMX content

include_raw (
    inline: string
    file: string
) {
}

insert

Defines insert element for external groovy script

insert (
    file: string
    variables: map
) {
}

java_request

Defines 'Java Request' element

java_request (
    name: string
    comments: string
    enabled: boolean (true)
    classname: string
) {
}

argument

Defines single user variable in arguments

argument (
    name: string
    value: string
) {
}

arguments

Defines user variables element inside a java_request listener

arguments (
    values: map
) {
}

jdbc

Defines 'JDBC Config' or 'JDBC Request' element

jdbc (
    name: string
    comments: string
    enabled: boolean (true)
    datasource: string
    use: string
) {
}

autocommit

Defines autocommit 'JDBC Request' sampler

autocommit (
    value: boolean (true)
) {
}

callable

Defines query properties part of 'JDBC Request' sampler (callable type)

callable (
    limit: long                                       [0..9223372036854775807]
    timeout: long                                     [0..9223372036854775807]
    result: string
    variables: list
    file: string
    inline: string
) {
}

commit

Defines commit 'JDBC Request' sampler

commit (
) {
}

jdbc_config

Defines 'JDBC Connection Configuration' element

jdbc_config (
    name: string
    comments: string
    enabled: boolean (true)
    datasource: string
) {
}

connection

Defines 'JDBC Connection' element

connection (
    url: string
    driver: string
    username: string
    password: string
    properties: map
) {
}

execute

Defines query properties part of 'JDBC Request' sampler (update and prepared update type)

execute (
    prepared: boolean (true)
    limit: long                                       [0..9223372036854775807]
    timeout: long                                     [0..9223372036854775807]
    result: string
    variables: list
    file: string
    inline: string
) {
}

init

Defines 'JDBC Init' element

init (
    inline: list
    file: string
) {
}

param

Defines JDBC Query paratemter

param (
    value: object
    type: string
) {
}

params

Defines JDBC Query parameters

params (
) {
}

pool

Defines 'JDBC Pool' element

pool (
    connections: long
    wait: long (10000)
    eviction: long (60000)
    autocommit: boolean (true)
    isolation: string ('DEFAULT')                     [DEFAULT, TRANSACTION_NONE, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_SERIALIZABLE, TRANSACTION_REPEATABLE_READ]
    preinit: boolean
) {
}

jdbc_postprocessor

Defines 'JDBC PostProcessor' element

jdbc_postprocessor (
    name: string
    comments: string
    enabled: boolean (true)
    use: string
) {
}

jdbc_preprocessor

Defines 'JDBC PreProcessor' element

jdbc_preprocessor (
    name: string
    comments: string
    enabled: boolean (true)
    use: string
) {
}

query

Defines query properties part of 'JDBC Request' sampler (select and prepared update

query (
    prepared: boolean (true)
    limit: long                                       [0..9223372036854775807]
    timeout: long                                     [0..9223372036854775807]
    result: string
    variables: list
    file: string
    inline: string
) {
}

jdbc_request

Defines 'JDBC Request' sampler

jdbc_request (
    name: string
    comments: string
    enabled: boolean (true)
    use: string
) {
}

rollback

Defines rollback 'JDBC Request' sampler

rollback (
) {
}

validation

Defines 'JDBC Validation' element

validation (
    idle: boolean (true)
    timeout: long (5000)
    query: string
) {
}

extract_jmes

Defines 'JSON JMES Extractor' element

extract_jmes (
    name: string
    comments: string
    enabled: boolean (true)
    applyTo: string ('parent')                        [parent, all, children, variable]
    defaultValue: string
    match: integer (1)                                [1..9223372036854775807]
    variable: string
    expression: string
) {
}

extract_json

Defines 'JSON Extractor' element

extract_json (
    name: string
    comments: string
    enabled: boolean (true)
    applyTo: string ('parent')                        [parent, all, children, variable]
    defaultValues: string
    matches: integer ([1])                            [1..9223372036854775807]
    variables: string
    expressions: string
    concatenation: boolean
) {
}

jsrassertion

Defines 'JSR223 Assertion' element

jsrassertion (
    name: string
    comments: string
    enabled: boolean (true)
    inline: string
    cacheKey: boolean (true)
    file: string
    parameters: string
    language: string ('groovy')                       [groovy]
) {
}

jsrlistener

Defines 'JSR223 Listener' element

jsrlistener (
    name: string
    comments: string
    enabled: boolean (true)
    inline: string
    cacheKey: boolean (true)
    file: string
    parameters: string
    language: string ('groovy')                       [groovy]
) {
}

jsrpostprocessor

Defines 'JSR223 PostProcessor' element

jsrpostprocessor (
    name: string
    comments: string
    enabled: boolean (true)
    inline: string
    cacheKey: boolean (true)
    file: string
    parameters: string
    language: string ('groovy')                       [groovy]
) {
}

jsrpreprocessor

Defines 'JSR223 PreProcessor' element

jsrpreprocessor (
    name: string
    comments: string
    enabled: boolean (true)
    inline: string
    cacheKey: boolean (true)
    file: string
    parameters: string
    language: string ('groovy')                       [groovy]
) {
}

jsrsampler

Defines 'JSR223' sampler

jsrsampler (
    name: string
    comments: string
    enabled: boolean (true)
    inline: string
    cacheKey: boolean (true)
    file: string
    parameters: string
    language: string ('groovy')                       [groovy]
) {
}

jsrtimer

Defines 'JSR223 Timer' element

jsrtimer (
    name: string
    comments: string
    enabled: boolean (true)
    inline: string
    cacheKey: boolean (true)
    file: string
    parameters: string
    language: string ('groovy')                       [groovy]
) {
}

login

Defines 'Login Config Element' config element

login (
    name: string
    comments: string
    enabled: boolean (true)
    username: string
    password: string
) {
}

loop

Defines 'Loop' controller

loop (
    name: string
    comments: string
    enabled: boolean (true)
    count: integer (1)                                [-1..9223372036854775807]
    forever: boolean
) {
}

schedule

Defines users group ('Open Model Thread Group') element

schedule (
        name: string
        comments: string
        enabled: boolean (true)
        inline: string
        file: string
        seed: integer                                     [0..9223372036854775807]
        onError: string ('continue')                      [continue, start_next, stop_user, stop_test, stop_now]
) {
}

plan

Defines 'Test Plan' element

plan (
        name: string
        comments: string
        enabled: boolean (true)
        serialized: boolean
        functionalMode: boolean
        tearDownOnShutdown: boolean (true)
        classpath: string
) {
}

argument

Defines single user variable in arguments

argument (
        name: string
        value: string
) {
}

arguments

Defines user variables element inside a test plan

arguments (
        values: map
) {
}

poisson_timer

Defines 'Poisson Random Timer' element

poisson_timer (
        name: string
        comments: string
        enabled: boolean (true)
        delay: long (300)                                 [0..9223372036854775807]
        range: double (100.0)                             [0..9223372036854775807]
) {
}

precise_throughput

Defines 'Precise Throughput Timer' element

precise_throughput (
        name: string
        comments: string
        enabled: boolean (true)
        target: double (100.0)                            [0..9223372036854775807]
        period: integer (3600)                            [0..9223372036854775807]
        duration: long (3600)                             [0..9223372036854775807]
        batchUsers: integer (1)                           [0..9223372036854775807]
        batchDelay: integer                               [0..9223372036854775807]
        samples: integer (10000)                          [0..9223372036854775807]
        percents: double (1.0)                            [0..9223372036854775807]
        seed: long                                        [0..9223372036854775807]
) {
}

random

Defines 'Random Variable' config element

random (
        name: string
        comments: string
        enabled: boolean (true)
        perUser: boolean (true)
        minimum: integer
        maximum: integer (2147483647)
        format: string
        variable: string ('r')
        seed: long
) {
}

extract_regex

Defines 'Regular Expression Extractor' element

extract_regex (
        name: string
        comments: string
        enabled: boolean (true)
        applyTo: string ('parent')                        [parent, all, children, variable]
        field: string ('response_body')                   [response_body, response_unescaped, response_document, response_headers, response_code, response_message, request_headers, url]
        useEmptyValue: boolean
        defaultValue: string
        match: integer (1)                                [1..9223372036854775807]
        variable: string
        expression: string
        template: string ('$1$')
) {
}

section

Defines 'Critical Section' controller

section (
        name: string
        comments: string
        enabled: boolean (true)
        lock: string ('global_lock')
) {
}

simple

Defines 'Simple' controller

simple (
        name: string
        comments: string
        enabled: boolean (true)
) {
}

summary

Defines 'Summary Report' element

summary (
        name: string
        comments: string
        enabled: boolean
        file: string
        errorsOnly: boolean
        successesOnly: boolean
        assertions: boolean
        bytes: boolean
        code: boolean
        connectTime: boolean
        dataType: boolean
        encoding: boolean
        fieldNames: boolean
        fileName: boolean
        hostname: boolean
        idleTime: boolean
        label: boolean
        latency: boolean
        message: boolean
        requestHeaders: boolean
        responseData: boolean
        responseHeaders: boolean
        sampleCount: boolean
        samplerData: boolean
        sentBytes: boolean
        subresults: boolean
        success: boolean
        threadCounts: boolean
        threadName: boolean
        time: boolean
        timestamp: boolean
        url: boolean
        xml: boolean
) {
}

synchronizing_timer

Defines 'Synchronizing Timer' element

synchronizing_timer (
        name: string
        comments: string
        enabled: boolean (true)
        users: integer                                    [0..9223372036854775807]
        timeout: long                                     [0..9223372036854775807]
) {
}

throughput

Defines 'Throughput' element

throughput (
        name: string
        comments: string
        enabled: boolean (true)
        type: string                                      [constant, precise]
) {
}

timer

Defines 'Timer' element

timer (
        name: string
        comments: string
        enabled: boolean (true)
        type: string                                      [constant, uniform, gaussian, poisson, synchronizing]
) {
}

transaction

Defines 'Transaction' controller

transaction (
        name: string
        comments: string
        enabled: boolean (true)
        timers: boolean
        generate: boolean
) {
}

uniform_timer

Defines 'Uniform Random Timer' element

uniform_timer (
        name: string
        comments: string
        enabled: boolean (true)
        delay: long (1000)                                [0..9223372036854775807]
        range: double (100.0)                             [0..9223372036854775807]
) {
}

variable

Defines single user variable

variable (
        name: string
        value: string
        description: string
) {
}

variables

Defines 'User Defined Variables' config element

variables (
        name: string
        comments: string
        enabled: boolean (true)
        values: map
) {
}

view

Defines 'View Results Tree' element

view (
        name: string
        comments: string
        enabled: boolean
        file: string
        errorsOnly: boolean
        successesOnly: boolean
        assertions: boolean
        bytes: boolean
        code: boolean
        connectTime: boolean
        dataType: boolean
        encoding: boolean
        fieldNames: boolean
        fileName: boolean
        hostname: boolean
        idleTime: boolean
        label: boolean
        latency: boolean
        message: boolean
        requestHeaders: boolean
        responseData: boolean
        responseHeaders: boolean
        sampleCount: boolean
        samplerData: boolean
        sentBytes: boolean
        subresults: boolean
        success: boolean
        threadCounts: boolean
        threadName: boolean
        time: boolean
        timestamp: boolean
        url: boolean
        xml: boolean
) {
}

extract_xpath

Defines 'XPath2 Extractor' element

extract_xpath (
        name: string
        comments: string
        enabled: boolean (true)
        applyTo: string ('parent')                        [parent, all, children, variable]
        defaultValue: string
        match: integer                                    [0..9223372036854775807]
        variable: string
        expression: string
        namespaces: string
        fragment: boolean
) {
}
Clone this wiki locally