settings

Settings section

This section of the JSON file contains timeout and logging settings for the load scenario.

• timeout: Timeout setting (seconds) for requests.
• logs: Log settings
  • traffic: Log traffic information (true / false). Defaults to false, if omitted. Note: This should only be used for debugging purposes as traffic logging is resource-demanding.
  • debug: Log debug information (true / false). Defaults to false, if omitted.
  • metrics: Log traffic metrics (true / false). Defaults to false, if omitted. Note: This should only be used for debugging purposes as traffic logging is resource-demanding.
  • regression: Log regression data (true / false). Defaults to false, if omitted. Note: Do not log regression data when testing performance. Note With regression logging enabled, the the scheduler is implicitly set to execute the scenario as one user for one iteration.
  • filename: Name of the log file (supports the use of variables).
  • format: Log format. Defaults to tsvfile, if omitted.
    • tsvfile: Log to file in TSV format and output status to console.
    • tsvconsole: Log to console in TSV format without any status output.
    • jsonfile: Log to file in JSON format and output status to console.
    • jsonconsole: Log to console in JSON format without any status output.
    • console: Log to console in color format without any status output.
    • combined: Log to file in TSV format and to console in JSON format.
    • no: Default logs and status output turned off.
    • onlystatus: Default logs turned off, but status output turned on.
  • summary: Type of summary to display after the test run. Defaults to simple for minimal performance impact.
    • 0 or undefined: Simple, single-row summary
    • 1 or none: No summary
    • 2 or simple: Simple, single-row summary
    • 3 or extended: Extended summary that includes statistics on each unique combination of action, label and app GUID
    • 4 or full: Same as extended, but with statistics on each unique combination of method and endpoint added
  • summaryFilename: Name of summary file, only used when using summary type file. Defaults to summary.json
• outputs: Used by some actions to save results to a file.
  • dir: Directory in which to save artifacts generated by the script (except log file).
• maxerrors: Break execution if max errors exceeded. 0 - Do not break. Defaults to 0.

Examples

"settings": {
	"timeout": 300,
	"logs": {
		"traffic": false,
		"debug": false,
		"filename": "logs/{{.ConfigFile}}-{{timestamp}}.log"
	}
}

"settings": {
	"timeout": 300,
	"logs": {
		"filename": "logs/scenario.log"
	},
	"outputs" : {
	    "dir" : "./outputs"
	}
}