@W-23800673 Document troubleshooting plugin on-demand operations and CLI flags - #3444
Open
marianorean wants to merge 5 commits into
Open
@W-23800673 Document troubleshooting plugin on-demand operations and CLI flags#3444marianorean wants to merge 5 commits into
marianorean wants to merge 5 commits into
Conversation
Add public documentation for the Mule Troubleshooting plugin's on-demand knownIssues operation and the command-line options, targeting the upcoming 4.12.x release: - Command-Line Options table: --output, --stdout, --extended, --logsmaxage, --logsmaxtotalsize, --debug (purpose, default, behavior). - Watch Mode: --watch, --trigger (cpu/heap/thread/conns/time/cron/script), --occurrences, --checkperiod, with trigger-condition reference. - Known Issues DIAF section (on-demand): the five fixed report sections (Memory, Linux OOM-killer, Abnormal termination, MUnit at runtime, Connector versions). - Refresh the help output block to match the current tool output. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…mits The refreshed help block already lists every option, its default, and the trigger forms. Replace the duplicated Command-Line Options and Watch Mode tables with short notes that document only the behavior the help summary doesn't convey (--output path semantics, --stdout Windows/exclusivity, --debug suspend, watch foreground/scope, the conns trigger, version notes). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
These are the two new dump sections added alongside the AI diagnostics prompt work. Both render in the default dump between System Info and Network Info (registration order), available in Mule runtime 4.12.3 and later: - Health Signals: fast host/JVM signals, reporting only the ones that fired (None on a healthy host). - Memory Detail: JVM memory-pool breakdown (Heap, Non-Heap, per-pool) and garbage-collector statistics. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
The conns>N / conns<N trigger depends on the connectionCount operation, which lands in 4.12.4, not the 4.12.3 release this doc targets. Remove it so the page only documents what ships in 4.12.3. The help block already omits conns. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Drop the "makes no outbound call / doesn't check for a newer release" clause; docs describe what the operation does, not what it avoids. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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 join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
Documents the Mule Troubleshooting plugin's new DIAF sections and CLI options in
mule-troubleshooting-plugin.adoc, targeting the upcoming 4.12.3 release. Per the usual workflow the PR is opened againstv4.12with the specific corresponding version noted for each item, so the docs team knows what to add.What's documented
./diag knownIssues) — the five fixed report sections: Memory, Linux OOM-killer, Abnormal termination, MUnit at runtime, Connector versions.helpoutput block — now matches the current tool output, including the new options and Watch Mode.helpsummary doesn't spell out (--outputpath semantics,--stdoutWindows/exclusivity,--debugsuspend).helplisting (foreground/blocking, wraps the full dump, version availability).The CLI options and trigger forms are listed once, in the
helpexample block; the prose only adds whathelpdoesn't convey, to avoid duplication.Version notes (please confirm)
Everything documented here targets Mule runtime 4.12.3:
knownIssuesoperation--logsmaxage/--logsmaxtotalsize--watchand options)The
connstrigger is intentionally omitted: it depends on theconnectionCountoperation, which lands in 4.12.4 rather than the 4.12.3 release this doc targets.🤖 Generated with Claude Code