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

Properly document output (i.e. collector) options #743

Closed
na-- opened this issue Aug 16, 2018 · 2 comments
Closed

Properly document output (i.e. collector) options #743

na-- opened this issue Aug 16, 2018 · 2 comments
Labels

Comments

@na--
Copy link
Member

na-- commented Aug 16, 2018

Specifically, the different environment variables available. Also, after #587 is done, the JS/JSON options as well.

@na-- na-- added the docs label Aug 16, 2018
na-- added a commit that referenced this issue Aug 16, 2018
Now buckets with fewer HTTP samples can also be aggregated, with outlier detection using the original sorting method, but with interpolation for improved accruacy. This is a more resource-intensive process, so for larger sample sizes quickselect is still the preferred algorithm.

There's also a new AggregationSkipOutlierDetection option that disables outlier detection altogether. It is disabled by default and is intended mostly for testing purposes.

And finally, the in-code documentation about the aggregation algorithm and options is expanded, which should help with https://github.com/loadimpact/k6/issues/628 and #743
@na--
Copy link
Member Author

na-- commented May 3, 2019

We probably should split up the results output docs page into multiple pages, one summary page that has an overview and explains how metric outputs work, and for each different output. The current single page is getting huge and it's proving insufficient to properly document the end-of-test summary and all of the supported external outputs and their options.

As is evident from this issue and others, we need to better document the InfluxDB output and its options. For it, we might also document common issues that people run into, since there are a few issues people run into fairly frequently.

https://github.com/loadimpact/k6/issues/628 is another connected issue to improve the docs about the cloud collector options. And depending on when and how we implement #587, we may need to have a fairly comprehensive section with deprecation information about the environment variable options....

@na--
Copy link
Member Author

na-- commented Jan 21, 2021

Closing this, since this was mostly implemented in the new docs at https://k6.io/docs/, and the remaining things are separate issues in the new docs repo (e.g. grafana/k6-docs#179, grafana/k6-docs#180)

@na-- na-- closed this as completed Jan 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant