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

Ennumerate CLI icons and meanings #411

Open
nicolevanderhoeven opened this issue Sep 27, 2021 · 5 comments
Open

Ennumerate CLI icons and meanings #411

nicolevanderhoeven opened this issue Sep 27, 2021 · 5 comments
Assignees

Comments

@nicolevanderhoeven
Copy link
Contributor

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
Copy link

@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
Copy link
Contributor

yorugac commented Oct 22, 2021

Here's the summary on those icons 🙂

  • 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
Copy link

@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
Copy link
Contributor

yorugac commented Oct 22, 2021

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 😅 I was only sharing what info I learned about those icons after my misadventures.

@ppcano could you please answer here?

@atom19-i
Copy link

atom19-i commented Oct 27, 2021

@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/?

@immavalls immavalls self-assigned this Jan 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants