making the describe task queue command more descriptive #672
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
ShahabT
reviewed
Sep 16, 2024
temporalcli/commandsmd/commands.md
Outdated
| increasing (if positive) or decreasing (if negative), measured in tasks per | ||
| second, averaged over the last 30 seconds. This is equivalent to: | ||
| `TasksAddRate` - `TasksDispatchRate`. | ||
|
|
||
| NOTE: The `TasksAddRate` and `TasksDispatchRate` metrics may differ from the | ||
| actual rate of add/dispatch, because tasks may be dispatched eagerly to an | ||
| available worker, or may apply only to specific workers (they are "sticky"). | ||
| Such tasks are not counted by these metrics. | ||
| Such tasks are not counted by these metrics. Despite the inaccuracy of | ||
| these two metrics, the derived metric of BacklogIncreaseRate is accurate |
There was a problem hiding this comment.
to be consistent.
Suggested change
| these two metrics, the derived metric of BacklogIncreaseRate is accurate | |
| these two metrics, the derived metric of `BacklogIncreaseRate` is accurate |
ShahabT
approved these changes
Sep 16, 2024
cretz
approved these changes
Sep 16, 2024
josh-berry
approved these changes
Sep 16, 2024
temporalcli/commandsmd/commands.md
Outdated
| Such tasks are not counted by these metrics. | ||
| Such tasks are not counted by these metrics. Despite the inaccuracy of | ||
| these two metrics, the derived metric of BacklogIncreaseRate is accurate | ||
| for backlogs older than few seconds. |
There was a problem hiding this comment.
Idiomatic/native English:
Suggested change
| for backlogs older than few seconds. | |
| for backlogs older than a few seconds. |
Shivs11
added a commit
that referenced
this pull request
Oct 2, 2024
<!--- Note to EXTERNAL Contributors --> <!-- Thanks for opening a PR! If it is a significant code change, please **make sure there is an open issue** for this. We work best with you when we have accepted the idea first before you code. --> <!--- For ALL Contributors 👇 --> ## What was changed <!-- Describe what has changed in this PR --> - addressed minor comments which were requested in #672 ## Why? <!-- Tell your future self why have you made these changes --> - opened a new PR since the repo went through some changes with respect to generating code (now uses a .yml file) - attempted at resolving conflicts on the previous open PR but was faced with unknown issues - thought it was best, in the interest of time and given the relatively small size of the PR, to open a new branch and close the issue. ## Checklist <!--- add/delete as needed ---> 1. Closes <!-- add issue number here --> 2. How was this tested: <!--- Please describe how you tested your changes/how we can test them --> 3. Any docs updates needed? <!--- update README if applicable or point out where to update docs.temporal.io -->
|
closing this as an updated PR was merged to main. |
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.
What was changed
task-queue describecommandWhy?
Checklist
Closes
How was this tested: