pikopod chaos <sandbox> [flags]
pikopod up.
| Flag | Meaning |
|---|---|
--kind <kind> | error (default), latency, hang, slow_body, rate_limit, connection_reset, empty_response, random_data_then_close, malformed_response, wrong_content_length, duplicate_webhook, drop_webhook, reorder_webhook, delay_webhook. |
--method <METHOD> | HTTP method of the target operation. Required for non-webhook kinds. |
--path <template> | Path template of the target operation, as in the spec. Required for non-webhook kinds. |
--status <int> | Status for error. Default 500. rate_limit forces 429. |
--body <json | @file> | JSON body an error fault answers with, inline or from a file. Must be an object or array. Default: the spec’s declared example for that status, else none. |
--delay-ms <int> | Delay for latency, hang, slow_body and delay_webhook. Default 30000 for latency. |
--probability <0..1> | Chance each request trips the fault. Default 1. |
--event <name> | The event a webhook-kind fault matches. Default any. |
--wallclock | Delay on the real wire. hang and slow_body only act with this or up --wallclock-faults. |
--list | Show standing faults. |
--clear | Clear matching faults, or every fault when --method and --path are omitted. |
Examples
pikopod chaos examplepay --kind error --status 503 --method POST --path /charges
pikopod chaos examplepay --kind latency --delay-ms 8000 --method GET --path /charges/{id}
pikopod chaos examplepay --kind duplicate_webhook --event charge.succeeded
pikopod chaos examplepay --list
pikopod chaos examplepay --clear --method POST --path /charges
pikopod chaos examplepay --clear
armed: {"armed":{"method":"POST","path":"/charges","kind":"error","status":503,"probability":1}}
clear it with: pikopod chaos examplepay --clear --method POST --path /charges
error fault can carry the body a client switches on:
pikopod chaos examplepay --kind error --status 422 --method POST --path /charges \
--body '{"error":{"code":"card_declined","decline_code":"insufficient_funds"}}'
armed: {"armed":{"method":"POST","path":"/charges","kind":"error","status":422,"probability":1,"body":{"error":{"code":"card_declined","decline_code":"insufficient_funds"}}}}
clear it with: pikopod chaos examplepay --clear --method POST --path /charges
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json; charset=utf-8
X-Pikopod-Fault-Applied: error
X-Pikopod-Operation: createCharge
{"error":{"code":"card_declined","decline_code":"insufficient_funds"}}
--body that is not JSON, or not an object or array, is refused with exit 2. See Faults.