Installation
Add Tracepanel to your Spring Boot or Ktor app with Gradle or Maven, and open the panel.
Tracepanel for Java is three libraries on Maven Central, under
dev.tracepanel: tracepanel-spring-boot and tracepanel-ktor, and
tracepanel-core that both depend on. Your app adds one of the first two.
See the changelog.
Add it to your app
Add the dependency for development only, so the production build leaves it out:
// build.gradle.kts
dependencies {
developmentOnly("dev.tracepanel:tracepanel-spring-boot:0.3.0")
}Run the app as you do, such as ./gradlew bootRun. Spring Boot picks up
Tracepanel by its auto-configuration: there is no code to add.
When it turns on
In Spring Boot, Tracepanel is on whenever the dependency is there. That is why
it goes in as a development dependency. In Ktor, it is on in development mode.
In both, TRACEPANEL_ENABLED=0 turns it off and TRACEPANEL_ENABLED=1 turns
it on. When it is off, it installs nothing.
The agent
The agent is a separate program that keeps the traces, finds the issues and
serves the console. You don't install it. The first time the app starts, the
SDK downloads the agent of its version from the agent's npm package for your
platform, checks it against the checksum the SDK was built with, and keeps it
in ~/.cache/tracepanel/ for every project. Without a network, it runs
tracepanel-agent from the PATH. TRACEPANEL_AGENT_BIN names another one.
See How it works.
Open the panel
Open a page of your app, or its Swagger UI. A badge in the corner opens the
panel. The console is at /__tracepanel__/
on your app. Every response carries Tracepanel-Id and Server-Timing, and
the SDK exposes them on CORS responses, so a single-page app on another
origin reads them too.
Add .tracepanel/ to your .gitignore: it holds the project's traces.