/spring-boot-admin

Admin UI for administration of spring boot applications

Primary LanguageJavaApache License 2.0Apache-2.0

codecentric's Spring Boot Admin

Apache License 2 Build Status Coverage Status Maven Central Gitter

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

It provides the following features for registered application.

  • 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
  • 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 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 availabe on YouTube:

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

Getting Help

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

Reference Guide

Version 2.0.1

Version 1.5.7

Version 1.4.6

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.

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

Snapshot builds

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

<repository>
	<id>sonatype-nexus-snapshots</id>
	<name>Sonatype Nexus Snapshots</name>
	<url>https://oss.sonatype.org/content/repositories/snapshots/</url>
	<snapshots>
		<enabled>true</enabled>
	</snapshots>
	<releases>
		<enabled>false</enabled>
	</releases>
</repository>

Build

In order to build spring-boot-admin you need to have node.js and npm on your $PATH.

./mvnw clean package