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

Expand README with more configuration examples #4

Merged
merged 3 commits into from
Apr 20, 2015

Conversation

iguberman
Copy link
Contributor

Added 6 scenarios with corresponding jobs config examples -- largely based on my Jobs presentation at Chicago Erlang Factory. Please note that I'm not 100% sure about NOTE 2 in Example 6.

…tion examples

Expand documentation: add a few scenarios and corresponding configuration examples

Expand documentation: add a few scenarios and corresponding configuration examples

Expand documentation: add a few scenarios and corresponding configuration examples

Expand documentation: add a few scenarios and corresponding configuration examples

Expand documentation: add a few scenarios and corresponding configuration examples

Expand documentation: add a few scenarios and corresponding configuration examples
@uwiger
Copy link
Owner

uwiger commented Apr 19, 2015

Great, Irina! The only problem is that the README.md file is auto-generated from doc/overview.edoc. So if you could put the examples there instead, they won't be flushed the next time docs are rebuilt.

```
NOTE 1: 10 = Percent increment by which to modify the regulator limit

NOTE 2: In this example, when CPU usage increases by %27, the sampler will send 70, the percentage to be applied to the predefined limit.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"%27" should be "27%", right?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes! But I'm also not sure if this is correct statement about how increments work: I assumed feedback is 'rounded' to the nearest increment. (i.e. if CPU increases by 13% -- the limit will be reduced by 10%, but if increment = 5, the limit will be reduced by 15% -- is that right?)

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, actually, if the jobs_sampler_cpu sampler is defined with no arguments, it will use the default {levels, [{80,1},{90,2},{100,3}]}. The algorithm tries to calculate some "average" per-cpu load, so 100 would be max. But given this setting, an average per-cpu load of 85% would give a sampler feedback of 1. That is, the levels algorithm (or jobs_sampler:calc(value, Levels, History) will pick the highest level where Value >= Level - in this case 80.

@iguberman
Copy link
Contributor Author

Thanks for looking at it Ulf! I'm moving my stuff into overview.edoc...

…tion examples -- moved from generated README.md to overview.edoc
uwiger added a commit that referenced this pull request Apr 20, 2015
Expand README with more configuration examples
@uwiger uwiger merged commit 68acac0 into uwiger:master Apr 20, 2015
@uwiger
Copy link
Owner

uwiger commented Apr 20, 2015

Merged. Thanks!

@iguberman
Copy link
Contributor Author

Thanks so much Ulf!

BTW, I decided to remove NOTE 2 altogether because if I replace it with
what you said in your previous comment -- it will add redundancy to the
docs -- this info is already there I think :)

Cheers,
Irina.

On Mon, Apr 20, 2015 at 8:55 AM, Ulf Wiger notifications@github.com wrote:

Merged. Thanks!


Reply to this email directly or view it on GitHub
#4 (comment).

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.

2 participants