This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
storperf:api [2015/11/30 21:28] Mark Beierl [ReST API] |
storperf:api [2015/12/02 18:22] (current) Mark Beierl [Common Options] |
||
---|---|---|---|
Line 13: | Line 13: | ||
} | } | ||
| | ||
- | Query Job Results: ''http://hostname/api/v1.0/results/[job_id]'' | + | Query Job Results: ''http://hostname/api/v1.0/report/[job_id]&workload=[workload pattern match]'' |
+ | |||
+ | * See Common Responses below for the response format for queries | ||
+ | ===== CLI ===== | ||
+ | |||
+ | ''python storperf/main.py'' | ||
+ | |||
+ | Command line options: | ||
+ | |||
+ | * -t or --target | ||
+ | * -w or --workload | ||
+ | * -s or --nossd | ||
+ | * -c or --nowarm | ||
+ | * verbose //optional// Emit periodic output describing the current read and write latency, and measured IOPS. | ||
+ | |||
+ | ====== Common Options ====== | ||
+ | |||
+ | If specified from command line, the option is in the format ''--option=''. For ReST, it is embedded in the URL as ''&option='' | ||
+ | |||
+ | * ''target=''[device or path] //Optional// The path to either an attached storage device (/dev/vdb, etc) or a directory path (/opt/storperf) that will be used to execute the performance test. In the case of a device, the entire device will be used. If not specified, the current directory will be used. | ||
+ | * ''workload=''[workload module] //Optional// If not specified, the default is to run all workloads. The workload types are: | ||
+ | * ''rs'': 100% Read, sequential data | ||
+ | * ''ws'': 100% Write, sequential data | ||
+ | * ''rr'': 100% Read, random access | ||
+ | * ''wr'': 100% Write, random access | ||
+ | * ''rw'': 70% Read / 30% write, random access | ||
+ | * ''nossd'' //optional// Do not perform SSD style preconditioning. | ||
+ | * ''nowarm'' //optional// Do not perform a warmup prior to measurements. | ||
+ | * ''report='' [job_id] //optional// Query the status of the supplied job_id and report on metrics. If a workload is supplied, will report on only that subset. | ||
+ | |||
+ | ====== Common Responses ====== | ||
+ | |||
+ | === Report Responses === | ||
+ | |||
+ | The report command returns a JSON string with the job status (''running'' or ''completed''). If still running: | ||
- | Returns a JSON string with the job status (''running'' or ''completed''). If still running: | ||
{ | { | ||
"version": 1.0 | "version": 1.0 | ||
Line 43: | Line 76: | ||
"mean": 413.87, | "mean": 413.87, | ||
"max": 1638 | "max": 1638 | ||
+ | } | ||
}, | }, | ||
"write": { | "write": { | ||
Line 60: | Line 94: | ||
] | ] | ||
} | } | ||
- | ===== CLI ===== | ||
- | |||
- | ''python storperf/main.py'' | ||
- | |||
- | Command line options: | ||
- | |||
- | * -t or --target | ||
- | * -w or --workload | ||
- | * -s or --nossd | ||
- | * -c or --nowarm | ||
- | * verbose //optional// Emit periodic output describing the current read and write latency, and measured IOPS. | ||
- | |||
- | ====== Common Options ====== | ||
- | |||
- | If specified from command line, the option is in the format ''--option=''. For ReST, it is embedded in the URL as ''&option='' | ||
- | |||
- | * ''target=''[device or path] //Optional// The path to either an attached storage device (/dev/vdb, etc) or a directory path (/opt/storperf) that will be used to execute the performance test. In the case of a device, the entire device will be used. If not specified, the current directory will be used. | ||
- | * ''workload=''[workload module] //Optional// If not specified, the default is to run all workloads. The workload types are: | ||
- | * ''rs'': 100% Read, sequential data | ||
- | * ''ws'': 100% Write, sequential data | ||
- | * ''rr'': 100% Read, random access | ||
- | * ''wr'': 100% Write, random access | ||
- | * ''rw'': 70% Read / 30% write, random access | ||
- | * ''nossd'' //optional// Do not perform SSD style preconditioning. | ||
- | * ''nowarm'' //optional// Do not perform a warmup prior to measurements. | ||
- | | ||