Ennumerate CLI icons and meanings

[nicolevanderhoeven]

As per @yorugac 's comments during her week of testing, we should document the icons in the CLI output when using arrival rate executors. For example, the ✔️ in the output below:

running (1m01.5s), 0/1 VUs, 10 complete and 0 interrupted iterations
closed_model ✓ [======================================] 1 VUs  1m0s

I think it should go here, unless it applies to scenarios other than the arrival rate.

[atom19-i]

@nicolevanderhoeven you mentioned icons...are there other CLI icons,other than the right icon?

also, I noticed in https://k6.io/docs/using-k6/scenarios/arrival-rate/, that right cli icon was in front of open model as well. from what i have studied in documention, it tells when a model is completely run. please correct me if i'm wrong.

[yorugac]

Here's the summary on those icons :slightly_smiling_face:

• ↓ means that regular execution ended and we're in a gracefulStop stage
• ✓ means all was completed successfully, including gracefulStopstage if it's present
• ✗ shows up on interruption signal, like Ctrl-C, during execution or during gracefulStop

There can also be • which appears when scenario needs to wait before starting, e.g. with startTime.

I believe this is true for all executors.

[atom19-i]

@yorugac thank you for your insight! can i add this information in docs, as it is? please let me know if there is anything more i should mention with this.

[yorugac]

With the issues I encountered during my week of testing, this level of info about icons would have been sufficient. But overall, I'm afraid this question is not to me :sweat_smile: I was only sharing what info I learned about those icons after my misadventures.

@ppcano could you please answer here?

[atom19-i]

@yorugac @ppcano can i make a table with columns named icons and description for CLI icons(like executors and common option table) and mention this table in https://k6.io/docs/using-k6/scenarios/?