Skip to content
The Peekaboot logo The Peekaboot logo

Peekaboot

Peekaboot lets you peek inside your Spring Boot application while it runs.

Peekaboot is beta software and may expose security-relevant settings. See Security.

A local run writes traces unmasked to ~/.peekaboot. Set peekaboot.storage.traces.enabled=false to keep them in memory only. See Security, what goes to disk.

Add the dependency

Requires Java 25 or newer, Spring Boot 4.1 and a servlet web application.

Maven

<dependency>
    <groupId>org.peekaboot</groupId>
    <artifactId>peekaboot-spring-boot-starter</artifactId>
    <version>1.3.0</version>
</dependency>

Gradle

implementation("org.peekaboot:peekaboot-spring-boot-starter:1.3.0")

Dev toolbar

A bar at the bottom of every HTML page your app renders. Click it for the trace, queries and logs of that request. Dev toolbar

The collapsed dev toolbar at the bottom of an orders page, summarising the request The collapsed dev toolbar at the bottom of an orders page, summarising the request

Error page

In place of Spring Boot's whitelabel page, errors show the exception and a stack trace with framework frames folded. Error page

Peekaboot's error page for a failed request, with the exception, its message and a stack trace with framework frames folded Peekaboot's error page for a failed request, with the exception, its message and a stack trace with framework frames folded

Dashboard

Health, build info, configuration, migrations, loggers, Lifecycle and Meters, at /peekaboot in your running app. The dashboard

The Overview tab with stat tiles, a health banner and build, Git, Spring, Java and system cards The Overview tab with stat tiles, a health banner and build, Git, Spring, Java and system cards

Traces with SQL queries

The last 1,000 requests your app served, each with its span tree, SQL queries and timings. No collector to run. On a local run they survive a restart. Traces

The Queries tab of a trace, listing its SQL statements with duration, row count and parameters The Queries tab of a trace, listing its SQL statements with duration, row count and parameters

Insights

Charts over time of the meters your app already publishes. Insights

The Insights tab with live line charts of CPU usage and system load The Insights tab with live line charts of CPU usage and system load

HTTP API for agents and scripts

Everything the dashboard shows is JSON under /peekaboot/api, which lists its endpoints and links the OpenAPI 3.1 document. See HTTP API, Agents and llms.txt.

curl -s http://localhost:8080/peekaboot/api | jq
curl -s http://localhost:8080/peekaboot/api/routes | jq
curl -s http://localhost:8080/peekaboot/api/errors | jq

Off on a deployment

Peekaboot is on when you start your app from the IDE, with spring-boot:run or with bootRun, and off for a deployment or a test unless you turn it on. Production use covers what it costs while it is on, what stays on the classpath and how to keep it out of the artifact.