Skip to content

Commit

Permalink
Add example for raw-request (#1274)
Browse files Browse the repository at this point in the history
With this commit we add an example Rally track that demonstrates how to
use the `raw-request` operation. As the description in the reference
docs is quite abstract this example should clarify usage.
  • Loading branch information
danielmitterdorfer committed Jun 1, 2021
1 parent 0acd50e commit 89320aa
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions docs/track.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2035,6 +2035,29 @@ Properties
* ``request-params`` (optional): A structure containing HTTP request parameters.
* ``ignore`` (optional): An array of HTTP response status codes to ignore (i.e. consider as successful).

In the following example we show how Rally can be used to benchmark a hypothetical self-diagnostics API that is provided by custom plugin::

{
"schedule": [
{
"name": "self-diagnostics",
"operation": {
"operation-type": "raw",
"path": "/_my_custom_system_diag",
"method": "GET",
"body": {
"include-metrics": ["system", "jvm"],
"exclude-metrics": ["hardware"]
},
"warmup-iterations": 100,
"iterations": 100,
"target-throughput": 10
}
}
]
}


Meta-data
"""""""""

Expand Down

0 comments on commit 89320aa

Please sign in to comment.