cli: Add event stream capture to nomad operator debug #11865
Conversation
There was a problem hiding this comment.
This will be a really nice addition to the bundles, thanks for much @davemay99!
In addition to the review comments, it would be nice to have names against the TODO items within the code. This isn't to point blame, rather if someone without context takes a look into updating this code, they can refer to you for addition information if needed.
Probably out of scope for this PR, but it would be great to have some real world examples of using the debug command that could be quickly referenced. People using this command are usually under pressure, so anything to help I feel would be useful.
command/operator_debug.go
Outdated
| If event stream capture is enabled, the Job, Allocation, Deployment, | ||
| and Evaluation topics require 'namespace:read-job' capabilities, the Node | ||
| topic requires 'node:read'. A 'management' token is required to capture | ||
| ACLToken, ACLPolicy, or all all events. |
There was a problem hiding this comment.
I wanted to note that while giving this information in the CLI is very useful, there is a maintenance cost to pay whereby we will need to update this every time a new endpoint is added to the events stream that would be useful within the debug bundle.
There was a problem hiding this comment.
IIRC all CLI commands include a mention of ACL requirements. Do you have a recommendation on how to reduce that maintenance cost?
@jrasell Good idea -- I tagged myself on all the TODO items. |
…erator debug` command
lgfa29
force-pushed
the
f-debug-eventstream
branch
from
efb3144 to
8cc304b
Compare
|
I'm going to lock this pull request because it has been closed for 120 days ⏳. This helps our maintainers find and focus on the active contributions. |
Adds Event Stream capture to
nomad operator debug. Enable-verboseoutput for realtime feedback on events as they are captured.New CLI flags:
-event-filter-verboseExample usage:
nomad operator debug -event-filter="Evaluation:*" -verboseSee Events API documentation for more details on topic filtering.
Closes #11493