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
这是什么？codecentric 出品的一个开源管理界面：一个用于监控和管理 Spring Boot 应用的网页仪表盘——健康状态、指标、日志、线程和配置都在一个地方。
它是需要嵌入到我每个应用里的库，还是一个单独运行的服务器？是一个单独的服务器：你把 Spring Boot Admin 本身作为一个 Spring Boot 应用来运行，而每个被监控的应用只需暴露自己的 Spring Boot Actuator 端点，供服务器读取。
我怎么把它跑起来？把 Spring Boot Admin server 依赖添加到一个 Spring Boot 应用并启动它——按照 README 的说法，依赖一加进去，监控就立即开始。
我想监控的应用需要什么特殊配置吗？只需要 Spring Boot Actuator 端点——这是唯一的要求，应用这边不需要额外的 agent 或自定义监控代码。
它和我的 Spring Boot 版本兼容吗？它的版本跟随 Spring Boot(4.1.y 的 admin server 对应 Spring Boot 4.1),但它可以监控任何 Spring Boot 版本的应用——比如用 4.1.x 的服务器通过 2.7.y 的客户端监控一个 2.7 的应用。
这是开发阶段的工具，还是用于生产环境的？两者都是：开发团队在开发过程中排查问题，运维团队监控生产环境，DevOps/SRE 团队则把它纳入自己的可观测性体系。
仪表盘在哪里打开——我能从任意一台电脑访问吗？它是一个带网页界面的服务端 Java 应用，所以用浏览器就能访问；服务器本身只要能跑 JVM 的地方都能运行。
使用它是免费的吗？是的——它基于 Apache License 2.0 开源，任何用途都可以免费使用，包括商业用途。
在仪表盘里，每个应用我具体能看到什么、能做什么？每个应用都有健康状态和指标的视图，有一个日志查看器可以实时流式查看和搜索日志，还有一个环境检查器可以查看配置属性和环境变量，此外还支持线程转储、HTTP 请求追踪和 JMX bean 管理。
一个 admin 服务器能管多少个应用？它从单个应用可以扩展到数百个微服务，开销很小，而且这个界面支持用一个服务器同时监控多个应用。
仪表盘可以加访问控制吗？可以——它内置了身份认证和授权支持，你可以要求先登录才能打开界面。
界面可以自定义吗？可以——这个界面是完全可扩展的：你可以自定义它并添加自定义视图，README 特别指出这在多应用部署场景下很有用。
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.9 MB
Stars
12.9K
Updated
CommitOct 16Release4.1.4Oct 07
Age
12y
Commits · 90 Days