docs(panel): document the uncontrollable log stream and its batch keys (v6.3.0) - #93
Merged
Merged
Conversation
Doc-sync for framework pull request UltiKits/UltiTools-Reborn#467, which merged into the framework's alpha without a companion documentation change. Panel integration page, English and Chinese mirror: - The logs capability comment no longer says the log stream can be controlled. As of v6.3.0 the log_stream start/stop/pause/resume actions receive a not-supported error response and delivery continues (framework issues 434 and 468, COMPATIBILITY.md LogStreamManager entry). - New "Live log stream" section: what the refused actions mean, the redefined status response (connected, logTransmitterEnabled, queueSize; subscriberCount and streaming removed), and the seven removed public LogStreamManager methods. - New "Batch settings" subsection: ultipanel.logging.batch.enabled/size/ interval as shipped in the framework's config.yml, their defaults and minimums, the 1,000-entry queue cap, that an existing config.yml is not migrated, that the keys are read when the panel connection opens (so a file edit needs a restart; ul reload does not reopen the connection), and the live batchConfig path that lasts until the next connection. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
A soft line break between two CJK characters renders as a visible space in Chromium-based browsers. The paragraphs added in the previous commit broke mid-word in several places; each is now a single source line, matching guide/essentials/data-storage.md and guide/advanced/ioc-container.md. Wording is unchanged. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Deploying ultitools-dev-doc with
|
| Latest commit: |
dab0341
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://3400c9cd.ultitools-dev-doc.pages.dev |
| Branch Preview URL: | https://docs-467-log-stream-control.ultitools-dev-doc.pages.dev |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: aa7b7dd190
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Codex review finding on pull request 93 (P2, thread 4027661648): the opening paragraph still listed four v6.3.0 connection changes after the log stream section was added. It now lists five, in section order, in both locales. Swept the same class (a page-level summary contradicted by the new section) and corrected the second instance: the unreleased-version notice said none of the page's config keys or classes exist on v6.2.5, but LogStreamManager and the batch keys it reads already did. It now says most do not exist yet and that a section names what changed where one already exists. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This was referenced Sep 16, 2026
Closed
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
1 participant
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
Doc-sync for framework pull request UltiKits/UltiTools-Reborn#467, which merged into the framework's
alphawithout a companion documentation pull request.This pull request targets
alphadeliberately, notmaster: it documents unreleased v6.3.0 behaviour, andmasteris the published site. Companion framework PR: UltiKits/UltiTools-Reborn#467.Only
guide/advanced/panel-integration.mdand its Chinese mirror change. No new:::containers, no<<<example references, no version bumps.Changes
logs: true # live console log stream + controlbecomes# live console log stream(Chinese:实时控制台日志流 + 控制becomes实时控制台日志流). As of v6.3.0 the panel cannot control the stream.logson, the log handler is attached each time the panel connection opens and delivers for as long as the connection is up.log_stream/log_stream_controlactionsstart,stop,pause,resumereceive a not-supported error response; delivery continues. None of them changed delivery on any released version, and the framework has no per-viewer identity to act on.statusresponse now carriesconnected,logTransmitterEnabled,queueSize;subscriberCountandstreamingare gone.LogStreamManagermethods are listed.ultipanel.logging.batch.{enabled,size,interval}: defaultstrue/10/5000, minimums (size 1, interval 1000 ms), the 1,000-entry queue cap, the fact that an existingconfig.ymlis not migrated, reload behaviour, and the livebatchConfigpath.LogStreamManagerand the batch keys already did.Source trace (framework
origin/alphaatcd1ac1d3)LogStreamManager.java:247-255,:598-604;COMPATIBILITY.md:173-191LogStreamManager.java:566-573logsis onCloudSession.java:1003-1012;PluginInitiationUtils.java:279,358;LogStreamManager.java:127-142statusfieldsLogStreamManager.java:676-688;COMPATIBILITY.md:188-191log_streamandlog_stream_controlshare the handlerPluginInitiationUtils.java:579-582src/main/resources/config.yml:86-110;UltiPanelLogTransmitter.java:104-109sizeis per-send cap and early-send threshold; minimum 1UltiPanelLogTransmitter.java:247-256,326-331,416;ServerMonitorManager.java:791,888-906,927intervalhonoured with and withoutmonitoring; minimum 1000UltiPanelLogTransmitter.java:44,265-271,296-308;ServerMonitorManager.java:774-797,846-863UltiPanelLogTransmitter.java:32,240-242LogStreamManager.java:164-194initialize(), i.e. on connection openLogStreamManager.java:98,124,152-203config.ymlnot migrated forbatch.*UltiTools.java:400-415ul reloadre-reads config but does not reopen the connectionUltiToolsCommands.java:30-39;UltiTools.java:586-591;PluginManager.java:532-542batchConfig: validate all, then apply; interval reschedules; replaced at next connection openLogStreamManager.java:293-311,351-372,452-534;UltiPanelLogTransmitter.java:296-308config.yml;UltiPanelLogTransmitter.java:118-122Checks run locally
npm run build(dead-link checking): passscripts/check-bilingual-parity.sh: pass; both pages have 12 headingsscripts/check-container-length.shon both pages: pass🤖 Generated with Claude Code