Skip to content

Plugin Configuration Parameters

Plugin Configuration Parameters are used to specify external dependencies and control parameters for plugins during script execution.

Main Parameter List

ParameterTypeRequiredDescription
ignoreAssertionsbooleanNoAssertion Handling Strategy
true: Ignore assertion errors (default)
false: Record assertion failures as sampling errors
updateTestResultbooleanNoTest Result Update
true: Synchronize updates to API/case/scenario records
false: Preserve existing records (default)
httpSettingobjectNoHTTP Protocol Configuration
Effective when testing HTTP interfaces
webSocketSettingobjectNoWebSocket Protocol Configuration
Effective when testing WebSocket protocols
jdbcSettingobjectNoDatabase Connection Configuration
Required for testing database protocols

Configuration Tip

Only configure the corresponding parameters when specific protocols are used in the script.

A complete configuration example:

yaml
task:  
  arguments:   
    ignoreAssertions: false  
    updateTestResult: false  
    httpSetting:  
      connectTimeout: 6s  
      readTimeout: 60s  
      retryNum: 0  
      maxRedirects: 1  
    webSocketSetting:  
      connectTimeout: 6s  
      responseTimeout: 60s  
      maxReconnections: 0  
      reconnectionInterval: 200ms  
    jdbcSetting:  
      type: MYSQL  
      driverClassName: com.mysql.cj.jdbc.Driver  
      jdbcUrl: jdbc:mysql://localhost:3306/db  
      username: root  
      password: '******'  
      pool:  
        name: hikari  
        maximumPoolSize: 32  
        minimumIdle: 10  
        maxWaitTimeoutMillis: 60000

HTTP Plugin Configuration (httpSetting)

ParameterTypeRangeDefaultDescription
connectTimeoutstring1s ~ 24h3sMaximum wait time for TCP connection establishment
readTimeoutstring1s ~ 24h60sMaximum wait time for server response
retryNuminteger0~60Number of automatic retries for failed requests
maxRedirectsinteger0~101Maximum number of 3xx redirect follow-ups

Recommended Configuration:

yaml
httpSetting:  
  connectTimeout: 5s    # 1-3 seconds recommended for production environments  
  readTimeout: 30s      # 30 seconds recommended for API services  
  retryNum: 0           # Enable retries for critical services  
  maxRedirects: 3       # Increase for web page testing

WebSocket Plugin Configuration (webSocketSetting)

ParameterTypeRangeDefaultDescription
connectTimeoutstring1s ~ 24h3sMaximum wait time for connection establishment
responseTimeoutstring1s ~ 24h60sMaximum wait time for message response
maxReconnectionsinteger0~1000Maximum number of reconnections after disconnection
reconnectionIntervalstring1ms~30m200msInterval between reconnection attempts

Scenario Optimization Suggestions:

yaml
webSocketSetting:  
  connectTimeout: 3s       # Can be reduced to 1 second for intranet environments  
  responseTimeout: 10s     # 5-10 seconds recommended for instant messaging  
  maxReconnections: 3      # Recommended to disable  
  reconnectionInterval: 1s # 1-second retry interval

JDBC Plugin Configuration (jdbcSetting)

Field NameTypeRequiredLength LimitDescription
typeenumYes/Database type. Supported types: H2, HSQLDB, SQLITE, POSTGRES, MARIADB, MYSQL, ORACLE, SQLSERVER, DB2.
driverClassNamestringNo200Database driver class name, e.g., com.mysql.cj.jdbc.Driver.
jdbcUrlstringNo2048Database connection URL, e.g., jdbc:mysql://localhost:3306/mydatabase.
usernamestringNo200Database username.
passwordstringNo1024Database password.
isolationenumNo/Transaction isolation level:
- TRANSACTION_READ_UNCOMMITTED (Read Uncommitted),
- TRANSACTION_READ_COMMITTED (Read Committed),
- TRANSACTION_REPEATABLE_READ (Repeatable Read),
- TRANSACTION_SERIALIZABLE (Serializable).
poolobjectNo/Connection pool configuration.
yaml
jdbcSetting:  
  type: MYSQL  
  driverClassName: com.mysql.cj.jdbc.Driver  
  jdbcUrl: jdbc:mysql://localhost:3306/db  
  username: root  
  password: root123  
  pool:  
    name: hikari  
    maximumPoolSize: 32  
    minimumIdle: 1  
    maxWaitTimeoutMillis: 60000

JDBC Connection Pool Configuration (pool)

ParameterRangeRequiredDescription
name-YesConnection pool type: hikari/druid, etc.
maximumPoolSize1~10000YesMaximum number of connections
minimumIdle1~10000YesMinimum idle connections
maxWaitTimeoutMillis0~210MNoConnection acquisition timeout (ms)
yaml
pool:  
  name: hikari  
  maximumPoolSize: 32  
  minimumIdle: 10  
  maxWaitTimeoutMillis: 60000

Released under the GPL-3.0 License.