Skip to content

codecentric/spring-boot-admin

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

codecentric's Spring Boot Admin

Apache License 2 Build Status codecov Maven Central Gitter

This community project provides an admin interface for Spring Boot ® applications.

Monitoring Python applications is available using Pyctuator.

Spring Boot Admin provides the following features for registered applications:

  • Show health status
  • Show details, like
    • JVM & memory metrics
    • micrometer.io metrics
    • Datasource metrics
    • Cache metrics
  • Show build-info number
  • Follow and download logfile
  • View jvm system- & environment-properties
  • View Spring Boot Configuration Properties
  • Support for Spring Cloud's postable /env- &/refresh-endpoint
  • Easy loglevel management
  • Interact with JMX-beans
  • View thread dump
  • View http-traces
  • View auditevents
  • View http-endpoints
  • View scheduled tasks
  • View and delete active sessions (using spring-session)
  • View Flyway / Liquibase database migrations
  • Download heapdump
  • Notification on status change (via e-mail, Slack, Hipchat, ...)
  • Event journal of status changes (non persistent)

Getting Started

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

There are introductory talks available on YouTube:

Cloud Native Spring Boot® Admin by Johannes Edmeier @ Spring I/O 2019
Cloud Native Spring Boot® Admin by Johannes Edmeier @ Spring I/O 2019

Monitoring Spring Boot® Applications with Spring Boot Admin @ Spring I/O 2018
Monitoring Spring Boot® Applications with Spring Boot Admin @ Spring I/O 2018

Spring Boot® Admin - Monitoring and Configuring Spring Boot Applications at Runtime
Spring Boot® Admin - Monitoring and Configuring Spring Boot Applications at Runtime

Compatibility Matrix

Spring Boot Admin's version matches the major and minor versions of Spring Boot:

  • SBA 2.0.X -> Spring Boot 2.0.Y
  • SBA 2.1.X -> Spring Boot 2.1.Y
  • SBA 2.2.X -> Spring Boot 2.2.Y

etc. pp.

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 Help

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

Reference Guide

Version 2.6.6

Version 2.5.6

Version 1.5.7

Translated version 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 sonatype 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>

Screenshots

Screenshot application list Dashboard with desktop notifications

Screenshot details View application health, info and details

Screenshot metrics View metric counters and gauges

Screenshot logfile View logfile (with follow)

Screenshot environment View and change Spring environment (via Spring Cloud)

Screenshot logging Manage Logback logger levels

Screenshot jmx View and use JMX beans via jolokia

Screenshot threads View thread dump

Screenshot traces View http request traces

Screenshot journal View history of registered applications

Build

Requirements:

  • JDK >= 1.8

Please make sure you set $JAVA_HOME points to the correct JDK.

./mvnw clean package

Contributing

See CONTRIBUTING.md file.