Added detailed explanations about some metrics #364
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Hi @DrJosh9000 Can you please review my changes? Thanks! |
DrJosh9000
reviewed
Jan 21, 2025
README.md
Outdated
| @@ -313,8 +313,6 @@ Buildkite > (Org, Queue) > BusyAgentPercentage | |||
| Buildkite > (Org, Queue) > TotalAgentsCount | |||
| ``` | |||
|
|
|||
| When a queue is specified, only that queue's metrics are published. | |||
There was a problem hiding this comment.
Why is this removed? Is it incorrect?
README.md
Outdated
|
|
||
| **RunningJobsCount**: This metric counts the number of jobs that are currently in the “running” state. These jobs have been picked up by agents and are actively being executed. | ||
|
|
||
| **UnfinishedJobsCount**: This metric includes all jobs that have been scheduled but have not yet finished. This count would include the jobs that are in the “running,” “scheduled”. |
There was a problem hiding this comment.
Suggested change
| **UnfinishedJobsCount**: This metric includes all jobs that have been scheduled but have not yet finished. This count would include the jobs that are in the “running,” “scheduled”. | |
| **UnfinishedJobsCount**: This metric includes all jobs that have been scheduled but have not yet finished. This includes jobs in the “running” and “scheduled” states. |
README.md
Outdated
|
|
||
| **ScheduledJobsCount**: This metric refers to jobs that have been scheduled but not yet started by any agent. These jobs are in the queue, waiting for an available agent to start executing them. | ||
|
|
||
| **WaitingJobsCount**: This metric counts jobs that are in a “waiting” state, which could mean they are waiting on dependencies to resolve, on other jobs to finish, or on any other condition that needs to be met before they can be scheduled. When a queue is specified, only that queue's metrics are published. |
There was a problem hiding this comment.
Ah, the sentence above wasn't deleted, it somehow ended up here. Move it back? where it was?
Suggested change
| **WaitingJobsCount**: This metric counts jobs that are in a “waiting” state, which could mean they are waiting on dependencies to resolve, on other jobs to finish, or on any other condition that needs to be met before they can be scheduled. When a queue is specified, only that queue's metrics are published. | |
| **WaitingJobsCount**: This metric counts jobs that are in a “waiting” state, which could mean they are waiting on dependencies to resolve, on other jobs to finish, or on any other condition that needs to be met before they can be scheduled. |
README.md
Outdated
|
|
||
| **UnfinishedJobsCount**: This metric includes all jobs that have been scheduled but have not yet finished. This count would include the jobs that are in the “running,” “scheduled”. | ||
|
|
||
| **ScheduledJobsCount**: This metric refers to jobs that have been scheduled but not yet started by any agent. These jobs are in the queue, waiting for an available agent to start executing them. |
There was a problem hiding this comment.
Suggested change
| **ScheduledJobsCount**: This metric refers to jobs that have been scheduled but not yet started by any agent. These jobs are in the queue, waiting for an available agent to start executing them. | |
| **ScheduledJobsCount**: This metric counts jobs that have been scheduled but are not yet started by any agent. These jobs are in the queue, waiting for an available agent to start executing them. |
Just fixed a couple errors and changed a few words based on the suggestions!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
added a few lines in the README file explaining what some of the metrics do.