codecentric / spring-boot-admin

Admin UI for administration of spring boot applications
Apache License 2.0
12.39k stars 3.08k forks source link
java spring spring-boot spring-boot-admin spring-cloud

Spring Boot Admin by codecentric

Apache License 2 Build Status codecov Maven Central Gitter

This community project provides an admin interface for Spring Boot ® web applications that expose actuator endpoints.

Monitoring Python applications is available using Pyctuator.

Compatibility Matrix

In the Spring Boot Admin Server App, the Spring Boot Admin's version matches the major and minor versions of Spring Boot.

Spring Boot Version Spring Boot Admin
2.7 2.7.Y
3.0 3.0.Y
... ...
3.3 3.3.Y

Nevertheless, it is possible to monitor any version of a Spring Boot service independently of the underlying Spring Boot version in the service. Hence, it is possible to run Spring Boot Admin Server version 2.6 and monitor a service that is running on Spring Boot 2.3 using Spring Boot Admin Client version 2.3.

Getting Started

A quick guide to get started can be found in our docs.

There are introductory talks available on YouTube:

<img src="https://i.ytimg.com/vi/Ql1Gnz4L_-c/maxresdefault.jpg" alt="Cloud Native Spring Boot® Admin by Johannes Edmeier @ Spring I/O 2019" width="240" height="135" border="10" />
Cloud Native Spring Boot® Admin by Johannes Edmeier @ Spring I/O 2019

<img src="https://i.ytimg.com/vi/__zkypwjSMs/maxresdefault.jpg" alt="Monitoring Spring Boot® Applications with Spring Boot Admin @ Spring I/O 2018" width="240" height="135" border="10" />
Monitoring Spring Boot® Applications with Spring Boot Admin @ Spring I/O 2018

<img src="https://i.ytimg.com/vi/PWd9Q8_4OFo/maxresdefault.jpg" alt="Spring Boot® Admin - Monitoring and Configuring Spring Boot Applications at Runtime" width="240" height="135" border="10" />
Spring Boot® Admin - Monitoring and Configuring Spring Boot Applications at Runtime

Getting Help

Having trouble with codecentric's Spring Boot Admin? We’d like to help!

Reference Guide

Translated versions

The following reference guides have been translated by users of Spring Boot Admin and are not part of the official bundle. The maintainers of Spring Boot Admin will not update and maintain the guides mentioned below.

Version 2.6.6 (Chinese translated by @qq253498229)

Trademarks and licenses

The source code of codecentric's Spring Boot Admin is licensed under Apache License 2.0

Spring, Spring Boot and Spring Cloud are trademarks of Pivotal Software, Inc. in the U.S. and other countries.

Snapshot builds

You can access snapshot builds from the github snapshot repository by adding the following to your repositories:

<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

See CONTRIBUTING.md file.