Add historical journald and log export flags to operator debug command#26410
Merged
Add historical journald and log export flags to operator debug command#26410
Conversation
a04fe42 to
b974527
Compare
b974527 to
5596702
Compare
0f00e89 to
7769506
Compare
13171be to
3e606d4
Compare
tgross
reviewed
Aug 4, 2025
13762cc to
0c4082f
Compare
aimeeu
reviewed
Aug 4, 2025
Contributor
aimeeu
left a comment
There was a problem hiding this comment.
Thanks for updating the docs! I left a few style guide suggestions.
| - `log-file-export`: Include agents' Nomad logfiles in the debug capture. | ||
| The historical log export monitor runs concurrently with the log monitor | ||
| and ignores the `-log-level` and `-log-include-location` flags used to | ||
| configure that monitor. Nomad will return an error if the agent does not |
Contributor
There was a problem hiding this comment.
Suggested change
| configure that monitor. Nomad will return an error if the agent does not | |
| configure that monitor. Nomad returns an error if the agent does not |
| - `log-lookback`: Include historical journald logs in the debug capture. The | ||
| journald export monitor runs concurrently with the log monitor and ignores | ||
| the `-log-level` and `-log-include-location` flags passed to that monitor. | ||
| This flag is only available on Linux systems, see the `-log-file-export` |
Contributor
There was a problem hiding this comment.
Suggested change
| This flag is only available on Linux systems, see the `-log-file-export` | |
| This flag is only available on Linux systems. Refer to the `-log-file-export` |
d8128a5 to
0b52572
Compare
0b52572 to
8d3d4aa
Compare
6 tasks
tehut
added a commit
that referenced
this pull request
Aug 4, 2025
#26410) * Add -log-file-export and -log-lookback commands to add historical log to debug capture * use monitor.PrepFile() helper for other historical log tests
|
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. |
This file contains hidden or 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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Description
Support requested the ability to retrieve historical journald logs as part of the debug capture returned by
nomad operator debug. PR #26178 introduced aMonitorExport()RPC capable of streaming the contents of an agent's log file (if file logging is enabled) or its journald logs.This PR adds that functionality to
operator debugwith the inclusion of either alog-file-export=trueflag or a-log-lookback=<duration>flag. An agent's historical log capture runs alongside the capture of running logs and results in bothmonitor.logandmonitor_export.logfiles appearing in each agent's debug capture.Note to reviewers: I exported a test helper from PR #26178 for this new test case. The helper generates a golden log file for testing against stream results. And since the helper is now exported, I also refactored a few tests from that PR to use it as well since they were using the same mechanism.
Testing & Reproduction steps
To run locally:
nomad operator debug -duration=10s -interval=5s -log-file-export=truemonitor.logandmonitor_export.logfile for each agent in the cluster.
Example below
Links
Requested in: NMD-141
Contributor Checklist
changelog entry using the
make clcommand.ensure regressions will be caught.
and job configuration, please update the Nomad website documentation to reflect this. Refer to
the website README for docs guidelines. Please also consider whether the
change requires notes within the upgrade guide.
Reviewer Checklist
backporting document.
in the majority of situations. The main exceptions are long-lived feature branches or merges where
history should be preserved.
within the public repository.