> Markdown version of [Observability Kit](https://vaadin.com/docs/next/tools/observability). Section index: [llms.txt](https://vaadin.com/docs/next/tools/llms.txt)

# Observability Kit

> **Note: Commercial Feature**
>
> A commercial Vaadin subscription is required to use Observability Kit in your project.
>
> - [Start Trial](https://vaadin.com/pro/validate-license)
>
> - [See Pricing](https://vaadin.com/pricing)

Observability Kit provides integration with industry-leading Application Performance Monitoring (APM) and observability tools to provide insight into both the frontend and backend of an application.

At its core, Observability Kit is built on [Micrometer](https://micrometer.io). It instruments the Vaadin runtime and records metrics into your application’s `MeterRegistry`, while emitting tracing spans through the Micrometer Observation API — so the data flows to whatever backend you already use. With Spring Boot, it’s a drop-in: add one dependency and you’re done.

> **Note: Migrating From Version 4?**
>
> Earlier versions of Observability Kit were a standalone OpenTelemetry Java agent. See the [Migrating to Version 5](https://vaadin.com/docs/next/tools/observability/migrating-to-v5.md) page if you’re upgrading an existing project.

## <a id="topics"></a>Topics

- [Getting Started](https://vaadin.com/docs/next/tools/observability/getting-started.md): Step-by-step guide on how to use Observability Kit in an application.
- [Migrating to Version 5](https://vaadin.com/docs/next/tools/observability/migrating-to-v5.md): How to move a Vaadin application from the version 4 OpenTelemetry agent to the Micrometer-based version 5 of Observability Kit.
- [Configuration](https://vaadin.com/docs/next/tools/observability/configuration.md): How to configure Observability Kit and what its default settings are.
- [Custom Instrumentation](https://vaadin.com/docs/next/tools/observability/customization.md): How to record your own metrics and traces alongside the kit's built-in instrumentation, using annotations, the fluent Micrometer API, or raw registry beans.
- [Interaction Insights](https://vaadin.com/docs/next/tools/observability/insights.md): How the insights endpoint turns a vague user report into a replicable interaction, with the route, component, event, and exception that caused it.
- [Client Error Insights](https://vaadin.com/docs/next/tools/observability/client-errors.md): How the insights endpoint reports the errors browsers raise, with the script and stack frame behind them and whether an outage delayed the report.
- [Copilot Panel](https://vaadin.com/docs/next/tools/observability/copilot-panel.md): The development-mode panel that shows what went wrong and the live Vaadin meters, without a monitoring backend.
- [Integrations](https://vaadin.com/docs/next/tools/observability/integrations.md): Observability Kit records into a Micrometer registry, so it exports to any backend Micrometer and Spring Boot Actuator support.
- [Reference](https://vaadin.com/docs/next/tools/observability/reference.md): The metrics and tracing spans Observability Kit records, with their types, tags, and attributes.

`058FD664-1011-4141-9D5B-3487D6935CC5`