Skip to content

feat: document the copilot panel - #6019

Open
caalador wants to merge 2 commits into
mainfrom
feat/394-devTools-panel
Open

caalador wants to merge 2 commits into
mainfrom
feat/394-devTools-panel

Conversation

@caalador

Copy link
Copy Markdown
Contributor

Add documentation for the
copilot panel for observability
that is available in development
mode.

fixes vaadin/observability-kit#394

Add documentation for the
copilot panel for observability
that is available in development
mode.

fixes vaadin/observability-kit#394
@caalador
caalador requested a review from heruan September 15, 2026 05:07
@github-actions

Copy link
Copy Markdown
Contributor

Preview Deployment

This PR has been deployed for preview.

URL: https://docs-preview-pr-6019.fly.dev

Changed pages

Added content is highlighted in green; removed content is marked in red on each page.

Built from f994c43

@peholmst peholmst added the target/v25.3 Automatically cherry-pick to the v25.3 branch label Sep 16, 2026

@heruan heruan left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The page matches the panel closely, down to the verbatim UI strings, the refresh interval, ranking, route grouping, meter rendering and navigation order. Two sentences describe the announcement path that vaadin/observability-kit#398 replaced this week, see inline.

Heads up: #5961 adds a bullet at the same spot in the "See also" list of getting-started.adoc, so whichever merges second will need a small conflict fix.

The retained records outlive a reload, and those older findings are not announced again.

Errors are logged as errors and everything else as a warning, each prefixed with `Observability:`.
The message is a summary, and the server cuts anything longer than 300 characters.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The cut moved to the browser script together with the announcement, so the server is no longer involved.

Suggested change
The message is a summary, and the server cuts anything longer than 300 characters.
The message is a summary, cut to 300 characters when longer.


[NOTE]
Announcements are best-effort.
Copilot's plugin API has no notification of its own, so the line is written by asking the server to send Copilot's own log command; a Copilot that drops it costs you a notification, never the panel.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since vaadin/observability-kit#398 the script writes the line itself, as a log event on Copilot's event bus. There is no server round trip. Relaying through the server made the log panel show each line twice.

Suggested change
Copilot's plugin API has no notification of its own, so the line is written by asking the server to send Copilot's own log command; a Copilot that drops it costs you a notification, never the panel.
Copilot's plugin API has no notification of its own, so the line is written as a log event on Copilot's event bus; a Copilot that drops it costs you a notification, never the panel.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

target/v25.3 Automatically cherry-pick to the v25.3 branch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document the dev tools panel

3 participants