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, а каждое отслеживаемое приложение просто отдаёт свои endpoint'ы Spring Boot Actuator, чтобы сервер их читал.
Как его запустить?Добавьте зависимость сервера Spring Boot Admin в приложение на Spring Boot и запустите его — согласно README, мониторинг начинается сразу, как только зависимость добавлена.
Нужно ли приложениям, которые я хочу мониторить, что-то особенное?Только endpoint'ы Spring Boot Actuator — это единственное требование, никаких дополнительных агентов или специального кода мониторинга на стороне приложения не нужно.
Будет ли он работать с моей версией Spring Boot?Версии следуют за Spring Boot (сервер 4.1.y работает в паре со Spring Boot 4.1), но мониторить он может приложения на любой версии Spring Boot — например, приложение 2.7 через клиент 2.7.y на сервере 4.1.x.
Это инструмент для разработки или для продакшена?И то и другое: команды разработки ищут проблемы во время разработки, ops-команды следят за продакшеном, а команды DevOps/SRE встраивают его в свой стек наблюдаемости.
Где живёт панель управления — можно ли открыть её с любого компьютера?Это серверное Java-приложение с веб-интерфейсом, так что доступ к нему открывается из браузера; сам сервер работает везде, где есть JVM.
Это бесплатно?Да — проект с открытым исходным кодом под лицензией Apache License 2.0, поэтому бесплатен для любого использования, включая коммерческое.
Что именно я могу видеть и делать для каждого приложения в панели?Для каждого приложения — просмотры состояния и метрик, просмотрщик логов с возможностью стриминга и поиска, инспектор окружения для свойств и переменных окружения, плюс дампы потоков, HTTP-трейсы и управление JMX-бинами.
Сколько приложений может обслуживать один админ-сервер?Он масштабируется от одного приложения до сотен микросервисов с минимальными накладными расходами, и интерфейс позволяет мониторить несколько приложений с одного сервера.
Можно ли закрыть панель паролем?Да — из коробки есть встроенная поддержка аутентификации и авторизации, так что можно требовать вход, прежде чем кто-либо откроет интерфейс.
Можно ли настроить интерфейс под себя?Да — интерфейс полностью расширяемый: его можно кастомизировать и добавлять собственные представления, что 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