changes to tq-describe-command descriptions #668
Conversation
temporalcli/commandsmd/commands.md
Outdated
| - `ApproximateBacklogAge`: How far "behind" the task queue is running. This is | ||
| the difference in age between the oldest and newest tasks in the backlog, | ||
| measured in seconds. | ||
| - `ApproximateBacklogAge`: Approximate age of the oldest task in the backlog, based on its creation time, measured in seconds. |
There was a problem hiding this comment.
thought quite a bit on this and I think I quite like this - I know @josh-berry, you mentioned you didn't like the presence of head of queue, creation time and oldest task coming together all at once. However, after also accounting @ShahabT 's comments, I believe this captures the essence of what we are trying to describe well without confusing the reader.
let me know what you think!
There was a problem hiding this comment.
👍 Sounds good. Please wrap to 80 columns though (otherwise the user-facing output will look wrong). :)
temporalcli/commandsmd/commands.md
Outdated
| - `TasksAddRate`: Approximate rate at which tasks are being added to the task | ||
| queue, measured in tasks per second, averaged over the last 30 seconds. | ||
| Includes tasks dispatched immediately without going to the backlog | ||
| (sync-matched tasks), as well as tasks added to the backlog. | ||
| (sync-matched tasks), as well as tasks added to the backlog. However, not all tasks dispatched to the workers are counted in this metric. For more information please see [docs](https://github.com/temporalio/api/blob/b4bdd8035cd1883aa96cbad5bb0e582850feea5f/temporal/api/taskqueue/v1/message.proto#L116). |
There was a problem hiding this comment.
plan is to replace the hyper link with temporal docs link - haven't done so yet since docs changes have not been published :( (yet)
There was a problem hiding this comment.
If the docs page isn't available yet, we'll have to write this without the link and then update it later (after the release). See what you think about the wording in my PR (sorry ours crossed each other in flight!): https://github.com/temporalio/cli/pull/669/files#diff-b4c85d71e771b938a0779d1e4113e068c19dd896aac86c04fe1828dd5a15c63f
- requested changes to adhere to the principles set by the docs team Co-authored-by: Josh Berry <josh.berry@temporal.io>
What was changed
temporal task-queue describeWhy?
Checklist
Closes
How was this tested: