From 000621fccd32e2d53f0b5bc00bfbbe8d07fc4311 Mon Sep 17 00:00:00 2001 From: Edmund Huber Date: Tue, 14 Mar 2023 16:24:24 -0700 Subject: [PATCH 1/2] add notes about what the job states mean --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index eda1034f..4ec86445 100644 --- a/README.md +++ b/README.md @@ -239,6 +239,11 @@ Buildkite > (Org, Queue) > TotalAgentsCount When a queue is specified, only that queue's metrics are published. +Jobs can be in one of the following states: +* **Scheduled**, the job hasn't been assigned to an agent yet. If you have agent capacity, this value should be close to 0. +* **Waiting**, the job is known to exist but isn't schedulable yet due to dependencies, `wait` statements, etc. This information is mostly useful to an autoscaler, since it represents work that will start soon. +* **Running**, an agent is actively executing this job. + ## License See [LICENSE.md](LICENSE.md) (MIT) From c43eb799d3a092dd02111a3448d65b4192b98b12 Mon Sep 17 00:00:00 2001 From: Narthana Epa Date: Mon, 10 Apr 2023 17:47:51 +1000 Subject: [PATCH 2/2] Update README.md Co-authored-by: Patrick Robinson --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4ec86445..919b0696 100644 --- a/README.md +++ b/README.md @@ -239,7 +239,7 @@ Buildkite > (Org, Queue) > TotalAgentsCount When a queue is specified, only that queue's metrics are published. -Jobs can be in one of the following states: +We send metrics for Jobs in the following states: * **Scheduled**, the job hasn't been assigned to an agent yet. If you have agent capacity, this value should be close to 0. * **Waiting**, the job is known to exist but isn't schedulable yet due to dependencies, `wait` statements, etc. This information is mostly useful to an autoscaler, since it represents work that will start soon. * **Running**, an agent is actively executing this job.