Documentation versions (currently viewingVaadin 24)

Observability Kit Integrations

Observability Kit can be used with any vendor that natively supports the OpenTelemetry standard.

Vaadin tests and supports the following vendors:

Learn how to use Datadog together with Observability Kit.
Learn how to use Grafana together with Observability Kit.
Jaeger & Prometheus
How to integrate Jaeger and Prometheus.
New Relic
Learn how to use New Relic together with Observability Kit.

For other vendors, you can use the OpenTelemetry collector with a service-specific exporter to forward the telemetry data.

Local Development & Testing

For development-time testing locally, you should use Jaeger and Prometheus, or Grafana.

Jaeger and Prometheus can be downloaded, and run stand-alone without any further dependencies. Jaeger is used to process traces and Prometheus to process metrics. This setup has the downside that it doesn’t support logs, and data is viewed from two different tools.

The Grafana setup requires Docker and docker-compose to be installed. This setup has the benefit that it supports logs and all data is viewable from a single tool.

Other Libraries & Frameworks

Since Observability Kit is based on the OpenTelemetry Java agent, it also includes many non-Vaadin-specific instrumentation that can be helpful in monitoring an application.

For example, it can include database requests using the JPA API, or outgoing HTTP requests.

List of libraries and frameworks supported by the OpenTelemetry Java agent.