docs: add README#334
Merged
Merged
Conversation
caalador
reviewed
Jun 10, 2026
Co-authored-by: caalador <mikael.grankvist@vaadin.com>
The standalone example showed a bare ObservabilityKit.install(...) with no indication of where it must run. It has to complete before the VaadinService initializes, so show it in a @weblistener ServletContextListener — matching the kit's own standalone setup (caalador review).
caalador
approved these changes
Jun 10, 2026
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.
Adds a project
README.mddocumenting Observability Kit.Structure:
MeterRegistry; tracing via the Observation API.MeterRegistry, Spring Boot 4 (starter only).observability-kit-starterand you're done; separate step for exposing metrics via Actuator + a registry backend (Prometheus example).MeterRegistryinto a view, reading a built-in meter and recording a custom timer.@Import(ObservabilityConfiguration.class)) and standalone (ObservabilityKit.install(...)).vaadin.observability.*table with defaults + theObservabilitySettings.builder()equivalent.Docs only — no code changes.