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

Improve documentation about open vs closed #1483

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

rocketraman
Copy link

@rocketraman rocketraman commented Jan 18, 2024

What?

The documentation on open vs closed models needed improvement. The introduction stated:

Different models suit different test aims

But had no discussion whatsoever of which test aims were suited for which model.

In addition, the discussion about the drawbacks of the closed model was incorrect. It stated:

This effect is not ideal when the goal is to simulate a certain
arrival rate of new VUs, or more generally throughput (e.g. requests per
second).

The second part of this sentence should be "latency", not "throughput". Its measuring latency that is affected by coordinated omission, as new requests wait for old ones to finish, and that waiting time is not included in the latency measurements. The closed model is actually useful for measuring throughput.

I've:

  1. added a new section "Open vs Closed Model" to the end of this document,

  2. moved the discussion of the drawbacks of the closed model to this new section, as it provides the necessary context and removed some duplication in the text,

  3. fixed the wording of the drawbacks of the closed model,

  4. added some notes about when one would prefer the closed model and when one would prefer the open model.

Checklist

Please fill in this template:

  • I have used a meaningful title for the PR.
  • I have described the changes I've made in the "What?" section above.
  • I have performed a self-review of my changes.
  • I have run the make docs command locally and verified that the changes look good. Unable to do so as the command does not work.

Select one of these and delete the others:

If updating the documentation for the next release of k6:

  • I have made my changes in the docs/sources/next folder of the documentation.

The documentation on open vs closed models needed improvement. The
introduction stated:

> Different models suit different test aims

But had no discussion whatsoever of which test aims were suited for
which model.

In addition, the discussion about the drawbacks of the closed model was
incorrect. It stated:

> This effect is not ideal when the goal is to simulate a certain
> arrival rate of new VUs, or more generally throughput (e.g. requests per
> second).

The second part of this sentence should be "latency", not "throughput".
Its measuring latency that is affected by coordinated omission, as new
requests wait for old ones to finish, and that waiting time is not
included in the latency measurements. The closed model is actually
*useful* for measuring throughput.

I've:

1) added a new section "Open vs Closed Model" to the end of this
   document,

2) moved the discussion of the drawbacks of the closed model to this new
   section, as it provides the necessary context and removed some
   duplication in the text,

3) fixed the wording of the drawbacks of the closed model,

4) added some notes about when one would prefer the closed model and
   when one would prefer the open model.
@CLAassistant
Copy link

CLAassistant commented Jan 18, 2024

CLA assistant check
All committers have signed the CLA.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants