hub / github.com/codecentric/spring-boot-admin

github.com/codecentric/spring-boot-admin @4.1.1 sqlite

repository ↗ · DeepWiki ↗ · release 4.1.1 ↗

2,734 symbols 11,363 edges 600 files 162 documented · 6%

README

Spring Boot Admin by codecentric

Maven Central Version

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
4.0	4.0.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:

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

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

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!

Check the reference documentation.
Ask a question on stackoverflow.com - we monitor questions tagged with spring-boot-admin.
Ask for help in our spring-boot-admin Gitter chat
Report bugs at http://github.com/codecentric/spring-boot-admin/issues.

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.

Extension points exported contracts — how you extend this code

ServiceInstanceConverter (Interface)

Converts ServiceInstances to Instances. @author Johannes Edmeier [7 implementers]

spring-boot-admin-server-cloud/src/main/java/de/codecentric/boot/admin/server/cloud/discovery/ServiceInstanceConverter.java

Notifier (Interface)

Interface for components which emits notifications upon status changes in clients @author Johannes Edmeier [7 implementers]

spring-boot-admin-server/src/main/java/de/codecentric/boot/admin/server/notify/Notifier.java

ActionHandler (Interface)

(no doc) [6 implementers]

spring-boot-admin-server-ui/src/main/frontend/views/applications/ActionHandler.ts

RegistrationClient (Interface)

(no doc) [7 implementers]

spring-boot-admin-client/src/main/java/de/codecentric/boot/admin/client/registration/RegistrationClient.java

GlobalComponents (Interface)

(no doc)

spring-boot-admin-server-ui/components.d.ts

HexMeshProps (Interface)

(no doc)

spring-boot-admin-docs/src/site/src/components/HexMesh.tsx

HttpHeadersProvider (Interface)

Is responsible to provide the HttpHeaders used to interact with the given Instance. @author Johannes Ed [7 implementers]

spring-boot-admin-server/src/main/java/de/codecentric/boot/admin/server/web/client/HttpHeadersProvider.java

IInstanceEvent (Interface)

(no doc) [1 implementers]

spring-boot-admin-server-ui/src/main/frontend/views/journal/InstanceEvent.ts

Core symbols most depended-on inside this repo

create

called by 560

spring-boot-admin-server/src/main/java/de/codecentric/boot/admin/server/domain/entities/Instance.java

put

called by 476

spring-boot-admin-server/src/main/java/de/codecentric/boot/admin/server/web/client/cookies/PerInstanceCookieStore.java

get

called by 332

spring-boot-admin-server/src/main/java/de/codecentric/boot/admin/server/web/client/cookies/PerInstanceCookieStore.java

getId

called by 268

spring-boot-admin-server/src/main/java/de/codecentric/boot/admin/server/notify/filter/NotificationFilter.java

build

called by 262

spring-boot-admin-server/src/main/java/de/codecentric/boot/admin/server/utils/jackson/InfoMixin.java

render

called by 228

spring-boot-admin-server-ui/src/main/frontend/test-utils.ts

called by 156

spring-boot-admin-server/src/main/java/de/codecentric/boot/admin/server/domain/values/InstanceId.java

filter

called by 104

spring-boot-admin-server/src/main/java/de/codecentric/boot/admin/server/services/InstanceFilter.java

Shape

Method 1,957

Class 470

Function 270

Interface 33

Enum 4

Languages

Java82%

TypeScript18%

Modules by API surface

spring-boot-admin-server-ui/src/main/frontend/services/instance.ts63 symbols

spring-boot-admin-server/src/main/java/de/codecentric/boot/admin/server/config/AdminServerNotifierAutoConfiguration.java42 symbols

spring-boot-admin-server/src/test/java/de/codecentric/boot/admin/server/web/client/InstanceExchangeFilterFunctionsTest.java36 symbols

spring-boot-admin-server/src/main/java/de/codecentric/boot/admin/server/config/AdminServerInstanceWebClientConfiguration.java32 symbols

spring-boot-admin-server/src/test/java/de/codecentric/boot/admin/server/config/AdminServerNotifierAutoConfigurationTest.java29 symbols

spring-boot-admin-server/src/main/java/de/codecentric/boot/admin/server/web/client/LegacyEndpointConverters.java28 symbols

spring-boot-admin-server-ui/src/main/frontend/services/application.ts28 symbols

spring-boot-admin-server/src/main/java/de/codecentric/boot/admin/server/notify/FeiShuNotifier.java27 symbols

spring-boot-admin-server-cloud/src/main/java/de/codecentric/boot/admin/server/cloud/discovery/InstanceDiscoveryListener.java27 symbols

spring-boot-admin-server/src/main/java/de/codecentric/boot/admin/server/notify/MicrosoftTeamsNotifier.java25 symbols

spring-boot-admin-server/src/main/java/de/codecentric/boot/admin/server/notify/OpsGenieNotifier.java24 symbols

spring-boot-admin-client/src/main/java/de/codecentric/boot/admin/client/registration/DefaultApplicationFactory.java22 symbols

Dependencies from manifests, versioned

com.github.luben:zstd-jni1×

com.google.code.findbugs:jsr3051×

com.hazelcast:hazelcast1×

com.puppycrawl.tools:checkstyle1×

de.codecentric:spring-boot-admin-client1×

de.codecentric:spring-boot-admin-sample-custom-ui1×

de.codecentric:spring-boot-admin-server1×

de.codecentric:spring-boot-admin-server-cloud1×

de.codecentric:spring-boot-admin-server-ui1×

de.codecentric:spring-boot-admin-starter-client1×

de.codecentric:spring-boot-admin-starter-server1×

io.netty:netty-tcnative-boringssl-static1×

Datastores touched

(mongodb)Database · 1 repos

adminDatabase · 1 repos

For agents

$ claude mcp add spring-boot-admin \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact