From 92632918e427d582235901ca0a3f4be9699c845f Mon Sep 17 00:00:00 2001 From: Michael Schurter Date: Mon, 7 Jun 2021 10:25:06 -0700 Subject: [PATCH] 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. --- website/content/docs/operations/metrics.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/website/content/docs/operations/metrics.mdx b/website/content/docs/operations/metrics.mdx index 5c0314436627..0e27aaed9ccd 100644 --- a/website/content/docs/operations/metrics.mdx +++ b/website/content/docs/operations/metrics.mdx @@ -389,7 +389,7 @@ those listed in [Key Metrics](#key-metrics) above. | `nomad.nomad.plan.evaluate` | Time elapsed to evaluate a plan | Nanoseconds | Summary | host | | `nomad.nomad.plan.queue_depth` | Count of evals in the plan queue | Integer | Gauge | host | | `nomad.nomad.plan.submit` | Time elapsed for `Plan.Submit` RPC call | Nanoseconds | Summary | host | -| `nomad.nomad.plan.wait_for_index` | Time elapsed for the planner to obtain a snapshot | Nanoseconds | Summary | host | +| `nomad.nomad.plan.wait_for_index` | Time elapsed the planner waits for plan's index | Nanoseconds | Summary | host | | `nomad.nomad.plugin.delete` | Time elapsed for `CSIPlugin.Delete` RPC call | Nanoseconds | Summary | Host | | `nomad.nomad.plugin.get` | Time elapsed for `CSIPlugin.Get` RPC call | Nanoseconds | Summary | Host | | `nomad.nomad.plugin.list` | Time elapsed for `CSIPlugin.List` RPC call | Nanoseconds | Summary | Host | @@ -416,7 +416,7 @@ those listed in [Key Metrics](#key-metrics) above. | `nomad.nomad.worker.send_ack` | Time elapsed for worker to send acknowledgement | Nanoseconds | Summary | host | | `nomad.nomad.worker.submit_plan` | Time elapsed for worker to submit plan | Nanoseconds | Summary | host | | `nomad.nomad.worker.update_eval` | Time elapsed for worker to submit updated eval | Nanoseconds | Summary | host | -| `nomad.nomad.worker.wait_for_index` | Time elapsed for worker get snapshot | Nanoseconds | Summary | host | +| `nomad.nomad.worker.wait_for_index` | Time elapsed worker waits for eval's index | Nanoseconds | Summary | host | | `nomad.raft.appliedIndex` | Current index applied to FSM | Integer | Gauge | host | | `nomad.raft.barrier` | Count of blocking raft API calls | Integer | Counter | host | | `nomad.raft.commitNumLogs` | Count of logs enqueued | Integer | Gauge | host |