Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Include k6-api status PATCH with info on how to stop test. Resolve #162. #371

Merged
merged 9 commits into from
Aug 11, 2021
40 changes: 39 additions & 1 deletion src/data/markdown/translated-guides/en/07 Misc/04 k6 REST API.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: 'k6 REST API'
excerpt: ''
excerpt: 'With this API you can see and control different execution aspects like
number of VUs, Max VUs, pause or resume the test, list groups, set and get the
setup data and more.'
hideFromSidebar: true
---

Expand Down Expand Up @@ -582,3 +584,39 @@ curl -X PUT \
This endpoint parses the JSON request body and sets the result as Setup data.

For more detail about the setup stage please go to [Test life cycle](/using-k6/test-life-cycle).

## Stop Test

**PATCH** `http://localhost:6565/v1/status`

<CodeGroup labels={["cURL Request", "Response"]}>

```bash
curl -X PATCH \
http://localhost:6565/v1/status \
-H 'Content-Type: application/json' \
-d '{
"data": {
"type": "status",
"id": "default",
"attributes": {
"stopped": true
}
}
}'
```

```json
{
"data": {
"type": "status",
"id": "default",
"attributes": {
"stopped": true
}
}
}
```
</CodeGroup>

This call parses the JSON request body to update the status and stop a running test.
Original file line number Diff line number Diff line change
Expand Up @@ -413,7 +413,7 @@ k6 run --execution-segment "3/4:1" --execution-segment-sequence "0,1/4,2/4,3

Sin embargo -en este momento el modo de ejecución distribuido de k6 no es del todo funcional. Las limitaciones actuales son:

- k6 no proporciona un coordinador de pruebas o instancia maestra para coordinar la ejecución distribuida de la prueba. Como alternativa, se puede utilizar la API REST de k6 y --paused para sincronizar la ejecución de las múltiples instancias de k6.
- k6 no proporciona un coordinador de pruebas o instancia maestra para coordinar la ejecución distribuida de la prueba. Como alternativa, se puede utilizar la [API REST de k6](/misc/k6-rest-api) y --paused para sincronizar la ejecución de las múltiples instancias de k6.
- Cada instancia de k6 evalúa los umbrales de forma independiente, excluyendo los resultados de las otras instancias de k6. Si desea desactivar la ejecución de umbrales, utilice --no-thresholds.
- k6 informa de las métricas individualmente para cada instancia. Dependiendo de cómo almacene los resultados de las pruebas de carga, tendrá que agregar algunas métricas para calcularlas correctamente.

Expand Down
Loading