docs: clarify total_escaped is just an optimization

6f7ad3ab · Michael Schurter · 46b41bc2 · 6f7ad3ab
Commit 6f7ad3ab authored 2 years ago by Michael Schurter
Hide whitespace changes
Inline Side-by-side

Showing

with 1 addition and 3 deletions
+1 -3
--- a/website/content/docs/operations/metrics-reference.mdx
+++ b/website/content/docs/operations/metrics-reference.mdx
@@ -259,7 +259,7 @@ those listed in [Key Metrics](#key-metrics) above.
 | `nomad.nomad.blocked_evals.job.cpu`                  | Amount of CPU shares requested by blocked evals of a job                       | Integer              | Gauge   | host, job, namespace                                    |
 | `nomad.nomad.blocked_evals.job.memory`               | Amount of memory requested by blocked evals of a job                           | Integer              | Gauge   | host, job, namespace                                    |
 | `nomad.nomad.blocked_evals.total_blocked`            | Count of evals in the blocked state                                            | Integer              | Gauge   | host                                                    |
-| `nomad.nomad.blocked_evals.total_escaped`            | Count of evals that have escaped computed node classes                         | Integer              | Gauge   | host                                                    |
+| `nomad.nomad.blocked_evals.total_escaped`            | Count of evals that have escaped computed node classes. This indicates a scheduler optimization was skipped and is not usually a source of concern. | Integer | Gauge | host |
 | `nomad.nomad.blocked_evals.total_quota_limit`        | Count of blocked evals due to quota limits                                     | Integer              | Gauge   | host                                                    |
 | `nomad.nomad.broker.batch_ready`                     | Count of batch evals ready to be scheduled                                     | Integer              | Gauge   | host                                                    |
 | `nomad.nomad.broker.batch_unacked`                   | Count of unacknowledged batch evals                                            | Integer              | Gauge   | host                                                    |
@@ -481,5 +481,3 @@ Raft database metrics are emitted by the `raft-boltdb` library.

 [tagged-metrics]: /docs/telemetry/metrics#tagged-metrics
 [s_port_plan_failure]: /s/port-plan-failure
-
-