SpringBoot详解整合Spring Boot Admin实现监控功能

Spring Boot监控功能详解

为什么需要监控功能？

在创建一个Web应用程序时，必须将其部署到服务器上并运行。为了使应用程序保持健康，需要监视服务器和应用程序的状态。例如，你可能需要知道服务器是否在线，有多少人访问了你的网站，哪些服务正在运行并占用多少内存，这些情况都需要有一个监控平台来进行管理和展示。

Spring Boot Admin

Spring Boot Admin是一个可以监控Spring Boot应用程序的应用程序。它可以方便地展示应用程序的运行情况，包括应用程序健康状态、线程状态等。在本文中，我们将详细介绍如何在Spring Boot应用程序中使用Spring Boot Admin来实现监控功能。

步骤

添加依赖

首先，我们需要在pom.xml文件中添加以下依赖：

<dependency>
    <groupId>de.codecentric</groupId>
    <artifactId>spring-boot-admin-starter-server</artifactId>
    <version>2.3.1</version>
</dependency>

配置文件

接下来，我们需要为Spring Boot Admin应用程序创建一个配置文件。在src/main/resources目录下创建一个名为application.yml的文件，并添加以下内容：

spring:
  security:
    user:
      name: admin
      password: admin
# Default context path is "/admin". You may customize the context path:
server:
  servlet:
    context-path: /your-context-path

在以上配置中，我们设置了管理员账户名和密码，以及自定义上下文路径。

添加注解

在我们的Spring Boot应用程序的启动类上添加@EnableAdminServer注解，以开启Spring Boot Admin服务：

import de.codecentric.boot.admin.server.config.EnableAdminServer;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
@EnableAdminServer
public class ServerApplication {
    public static void main(String[] args) {
        SpringApplication.run(ServerApplication.class, args);
    }
}

启动应用程序

启动我们的Spring Boot应用程序。在浏览器中输入http://localhost:8080/your-context-path，输入管理员账户名和密码即可进入Spring Boot Admin管理界面。

在Spring Boot Admin界面中，我们可以看到我们的应用程序的运行情况。例如，我们可以查看应用程序/actuator/health的状态，还可以查看应用程序的峰值内存占用情况等。

添加客户端

要追踪我们的Spring Boot应用程序，需要将Spring Boot Admin客户端添加到我们的应用程序中。在客户端中添加以下依赖：

<dependency>
    <groupId>de.codecentric</groupId>
    <artifactId>spring-boot-admin-starter-client</artifactId>
    <version>2.3.1</version>
</dependency>

并在应用程序的配置文件中添加以下配置：

spring:
  boot:
    admin:
      client:
        url: http://localhost:8080/your-context-path
management:
  endpoints:
    web:
      exposure:
        include: '*'

在启动客户端应用程序时，它将自动注册到Spring Boot Admin服务器，并将状态信息发送到服务器。

docker-compose示例

以下是一个使用docker-compose创建Spring Boot Admin服务和应用程序集群的示例：

version: "3.8"
services:
  admin:
    image: springbootadmin/server:2.3.3
    container_name: admin
    ports:
      - "8080:8080"
    environment:
      SPRING_SECURITY_USER_NAME: admin
      SPRING_SECURITY_USER_PASSWORD: admin
  hello-world:
    image: helloworld:latest
    container_name: hello-world1
    environment:
      SPRING_BOOT_ADMIN_URL: http://admin:8080

在以上示例中，我们创建了一个Spring Boot Admin服务和一个名为hello-world的应用程序。在应用程序的配置中，我们将SPRING_BOOT_ADMIN_URL设置为Spring Boot Admin服务器的URL。

Kubernetes示例

以下是一个使用Kubernetes创建Spring Boot Admin服务和应用程序集群的示例：

apiVersion: v1
kind: Service
metadata:
  name: springbootadmin
  labels:
    app: springbootadmin
spec:
  selector:
    app: springbootadmin
  ports:
  - name: http
    port: 8080
    targetPort: 8080
  sessionAffinity: None
  type: LoadBalancer
---
apiVersion: apps/v1
kind: Deployment
metadata:
  name: springbootadmin
  labels:
    app: springbootadmin
spec:
  replicas: 1
  selector:
    matchLabels:
      app: springbootadmin
  template:
    metadata:
      labels:
        app: springbootadmin
    spec:
      containers:
      - name: springbootadmin
        image: springbootadmin/server:2.3.3
        env:
        - name: SPRING_SECURITY_USER_NAME
          value: admin
        - name: SPRING_SECURITY_USER_PASSWORD
          value: admin
        ports:
        - containerPort: 8080
---
apiVersion: apps/v1
kind: Deployment
metadata:
  name: helloworld
  labels:
    app: helloworld
spec:
  replicas: 2
  selector:
    matchLabels:
      app: helloworld
  template:
    metadata:
      labels:
        app: helloworld
    spec:
      containers:
      - name: helloworld
        image: helloworld:latest
        env:
        - name: SPRING_BOOT_ADMIN_URL
          value: "http://springbootadmin:8080"

在以上示例中，我们创建了一个Spring Boot Admin服务和一个名为helloworld的应用程序。在应用程序的配置中，我们将SPRING_BOOT_ADMIN_URL设置为Spring Boot Admin服务器的URL。

总结

在本文中，我们介绍了如何使用Spring Boot Admin实现监控功能。我们讨论了Spring Boot Admin的作用以及如何设置和配置它。此外，我们还展示了如何在docker-compose和Kubernetes中使用Spring Boot Admin监控应用程序集群的示例。通过本文，你现在可以在你自己的Spring Boot应用程序中添加监控功能了。