spring-boot-admin README

The project's README from github.com/codecentric/spring-boot-admin. As one markdown file: README.md.

Spring Boot Admin by codecentric

Apache License 2 Build Status codecov Maven Central Version

Admin UI for Spring Boot applications

Spring Boot Admin provides a web-based dashboard for monitoring and managing Spring Boot® applications. It displays application health, metrics, logs, thread information, and configuration through an intuitive web interface.

Purpose & Goals

Why Spring Boot Admin?

Spring Boot Actuator exposes rich runtime data, but consuming it through raw REST endpoints or JMX is cumbersome. Spring Boot Admin bridges this gap with operational visibility out-of-the-box for any application that exposes actuator endpoints—no custom dashboards or monitoring tools required.

Design Philosophy

Simplicity without sacrificing power. Add a dependency and monitoring starts immediately. The interface stays readable at a glance, while remaining production-ready and extensible for security, multi-application deployments, and custom UIs.

Who Benefits from Spring Boot Admin?

Development teams diagnose issues during development, operations teams monitor production, and DevOps/SRE teams fold it into their observability stack. It scales from a single application to hundreds of microservices with minimal overhead.

✨ Features

Compatibility

Spring Boot Admin versions track Spring Boot's major and minor versions as follows:

Spring Boot Spring Boot Admin
3.Y.Z 3.X.c
4.0.Y 4.0.c
4.1.Y 4.1.c

Note: You can monitor applications running on any Spring Boot version, independently of the admin server version. For example, monitor a Spring Boot 2.7 application using the 2.7.y client with a 4.1.x admin server.

Snapshot Builds

For the latest development version, add this repository:


<repository>
    <id>sba-snapshot</id>
    <name>Spring Boot Admin Snapshots</name>
    <url>https://maven.pkg.github.com/codecentric/spring-boot-admin</url>
    <snapshots>
        <enabled>true</enabled>
    </snapshots>
    <releases>
        <enabled>false</enabled>
    </releases>
</repository>

Contributing

We welcome contributions! Please read CONTRIBUTING.md before submitting a pull request.

Resource Link
Contribution Guide CONTRIBUTING.md
Good first issues label: ideal-for-contribution
Open Issues GitHub Issues
Spring Java Format Plugin spring-io/spring-javaformat
Spring Framework Code Style Code Style Wiki
IntelliJ Formatter Plugin spring-javaformat#intellij-idea

Getting Help

License

Spring Boot Admin is open source software released under the Apache License 2.0.

Spring, Spring Boot, and Spring Cloud are trademarks of VMware, Inc.

Built by codecentric

spring-boot-admin (codecentric/spring-boot-admin)

Searching Database…

12.9K ·GitHub
Spring-boot-admin
What is this?An open-source admin UI by codecentric: a web dashboard for monitoring and managing Spring Boot applications — health, metrics, logs, threads and configuration in one place.
Is it a library I embed into each of my apps, or a separate server I run?A separate server: you run Spring Boot Admin itself as a Spring Boot application, and every monitored app just exposes its Spring Boot Actuator endpoints for the server to read.
How do I get it running?Add the Spring Boot Admin server dependency to a Spring Boot application and start it — per the README, monitoring starts immediately once the dependency is in.
Do the apps I want to monitor need anything special?Just Spring Boot Actuator endpoints — that's the one requirement, with no extra agents or custom monitoring code on the application side.
Will it work with my version of Spring Boot?Versions track Spring Boot's (a 4.1.y admin server pairs with Spring Boot 4.1), but it can monitor apps on any Spring Boot version — e.g. a 2.7 app via a 2.7.y client with a 4.1.x server.
Is this a development-time tool or something for production?Both: dev teams diagnose issues during development, ops teams monitor production, and DevOps/SRE teams fold it into their observability stack.
Where does the dashboard live — can I open it from any machine?It's a server-side Java app with a web interface, so you reach it from a browser; the server itself runs anywhere the JVM does.
Is it free to use?Yes — open source under the Apache License 2.0, so free for any use, including commercial.
What can I actually see and do for each app in the dashboard?Per-application views for health and metrics, a log viewer to stream and search logs, an environment inspector for properties and env vars, plus thread dumps, HTTP traces and JMX bean management.
How many applications can one admin server handle?It scales from a single application to hundreds of microservices with minimal overhead, and the UI supports monitoring multiple applications from a single server.
Can the dashboard be locked down?Yes — it ships with built-in authentication and authorization support, so you can require login before anyone opens the UI.
Can I customize the interface?Yes — the UI is fully extensible: you can customize it and add custom views, which the README calls out as useful for multi-application deployments.
What are similar projects?skywalking, eladmin, apollo, Sentinel, mall, SpringBoot-Labs, piggymetrics, cat
Which topics is it in?spring-cloud, spring, admin, metrics, spring-boot, logging, microservices, observability, real-time, authentication, dashboard, monitoring
Creator
codecentric
Size
105.8 MB
Stars
12.9K
Updated
CommitOct 17Release4.1.4Oct 07
Age
12y
Commits · 90 Days