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.

Sign up for GitHub

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

Jump to bottom

docs: improve wait_for_index metrics description #10717

Merged
merged 2 commits into from
Jun 9, 2021
Merged

docs: improve wait_for_index metrics description #10717

merged 2 commits into from
Jun 9, 2021

Commits on Jun 7, 2021

  1. docs: improve wait_for_index metrics description 

    Old description of `{plan,worker}.wait_for_index` described the metric
in terms of waiting for a snapshot which has two problems:

1. "Snapshot" is an overloaded term in Nomad and operators can't be
   expected to know which use we're referring to here.
2. The most important thing about the metric is what we're waiting *on*
   before taking a snapshot: the raft index of the object to be
   processed (plan or eval).

The new description tries to cram all of that context into the tiny
space provided.

See #5791 for details about the `wait_for_index` mechanism in general.
    @schmichael
    schmichael committed Jun 7, 2021
    Configuration menu
    Copy the full SHA
    870fc4a View commit details
    Browse the repository at this point in the history

  2. docs: Host -> host 

    Label is "host" not "Host"
    @schmichael
    schmichael committed Jun 7, 2021
    Configuration menu
    Copy the full SHA
    98b63a8 View commit details
    Browse the repository at this point in the history