Správa běžících runů

Správa runů
- informace o scénářích a runech
- spuštění nového runu
- zastavení a znovuspuštění runu
- smazání runu vč. revert

Struktura vypadá dobře, ale informace jsou zastaralé. Popsat hlavně Admin UI. Konzole může klidně zůstat kde to je relevantní. Revert vysvětlit ale je součást delete. Vysvětlit trochu i správné principy práce s runy.

This section describes the lifecycle of a Run - common operations one might do with a Run.

How to stop a run

If you want a Run to halt processing data you can stop it. This can be done in the developer console via the API Runtime.stop_run/1. The API takes Run ID as argument, you can locate the appropriate Run with Runtime.list_runs/0 or via the Admin UI.

iex(1)> runs = Runtime.list_runs()
[ ... ]
iex(2)> run = Enum.find(runs, & &1.scenario_id == "my_scenario")
%{ ... }
iex(3)> Runtime.stop_run(run.id)
:ok

You can verify the status of the Run with Runtime.list_runs() again or via the Admin UI.

How to resume stopped run

Stopped run can be resumed again, then it continues processing where it left off. Locate the Run and call Runtime.continue_run/1 with the Run ID.

iex(1)> Runtime.continue_run(run_id)
:ok

How to delete a run

Stopped Run can be deleted. This will remove it from the list of Runs permanently. You can delete the Run with Runtime.delete_run/1.

iex(1)> Runtime.delete_run(run_id)
:ok

Note this will only remove the Run itself. Generally it’s good practice not to delete a run without reverting its side effects first. This is purely practical, you might want to revert the run in the future but you need its ID to revert it. Removing the Run will make you responsible for preserving its ID somewhere. For that reason it’s recommended to not delete Runs that are not reverted.

Unlike Normalizer Pipelines, deleting a Run also deletes its state, therefore once you delete it it’s not possible to resume it without recomputing it.

How to revert run side effects

It is possible to revert some side effects the run created. At the moment, only side effects changing the Reality Network can be reverted. Of course, irreversible side effects like sending an email cannot be taken back.

You can revert run side effects from the developer console via the API Runtime.revert_run/1.

iex(1)> Runtime.revert_run(run_id)
:ok