storperf:api
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Last revision Both sides next revision | ||
|
storperf:api [2015/11/11 23:09] Mark Beierl [ReST API] |
storperf:api [2015/12/02 18:13] Mark Beierl [ReST API] |
||
|---|---|---|---|
| Line 3: | Line 3: | ||
| ===== ReST API ===== | ===== ReST API ===== | ||
| - | Details are to be finalized before API freeze early in December. | + | Start Job: ''http://hostname/api/v1.0/start&workload=[workload]&target=[target]'' |
| + | * See Common Options below for a full list | ||
| + | Returns a JSON string as follows: | ||
| + | { | ||
| + | "version": 1.0 | ||
| + | "job_id": "b88509c0-a297-454a-bb84-6e5ebd59cc22" | ||
| + | } | ||
| + | | ||
| + | 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 ===== | ===== CLI ===== | ||
| Line 13: | Line 22: | ||
| Command line options: | Command line options: | ||
| - | * 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. | + | * -t or --target |
| - | * workload=[SW, RW, RR, RW, RS] //Optional// If not specified, the default is to run all workloads. The workload types are: | + | * -w or --workload |
| - | * RS: 100% Read, sequential data | + | * -s or --nossd |
| - | * WS: 100% Write, sequential data | + | * -c or --nowarm |
| - | * RR: 100% Read, random access | + | |
| - | * WR: 100% Write, random access | + | |
| - | * MR: 70% Read / 30% write, random access | + | |
| - | * nossd //optional// Do not perform SSD style preconditioning. | + | |
| - | * nowarm //optional// Do not perform a warmup prior to measurements. | + | |
| * verbose //optional// Emit periodic output describing the current read and write latency, and measured IOPS. | * 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. | ||
| + | | ||
storperf/api.txt · Last modified: 2015/12/02 18:22 by Mark Beierl
Page Tools
Except where otherwise noted, content on this wiki is licensed under the following license: Creative Commons Attribution 4.0 International License
