Skip to content

fix: update observability documentation - #5958

Open
caalador wants to merge 2 commits into
mainfrom
fix/update-observability-documentation
Open

caalador wants to merge 2 commits into
mainfrom
fix/update-observability-documentation

Conversation

@caalador

@caalador caalador commented Sep 7, 2026

Copy link
Copy Markdown
Contributor

Update the documentation of
observability-kit to match
changes that made statements faulty.

Update the documentation of
observability-kit to match
changes that made statements faulty.
@github-actions

github-actions Bot commented Sep 7, 2026

Copy link
Copy Markdown
Contributor

Preview Deployment

This PR has been deployed for preview.

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

Changed pages

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

Built from 9d9a981

@caalador
caalador requested a review from heruan September 7, 2026 09:41
@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 edits themselves are accurate: three collectors, tripled capacity, getRecentClientErrors(), the grouping keys, the client counter descriptions and the client property all match the kit.

Since this PR was opened, two kit changes made more of reference.adoc stale. They are outside the diff, so listing them here rather than inline:

  • Lines 498, 522 and 572 still name the span vaadin.ui.access. It was renamed to vaadin.executor.task in vaadin/observability-kit#397. The scope is now "tasks submitted to the Vaadin service executor" (signal effects, signal result notifications, application tasks), not every UI.access.
  • Line 540 lists the request types as uidl, heartbeat, push, static, other. vaadin/observability-kit#399 added bootstrap and stream.

Optional: the replay example in insights.adoc around line 168 shows the production format only. Since vaadin/observability-kit#400, development mode adds view state steps such as Set the 'Reason' Select to 'Defective' and Click the 'Process return' Button. A sentence on that difference would help, but it can also be a follow-up.

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.

3 participants