Spring Boot 监控 Actuator

拼搏现实的明天。 2024-03-22 14:08 98阅读 0赞

## 一、概念 ##

Spring Boot Actuator是一个Spring Boot的子项目，它提供了许多有用的端点（endpoints）和监控功能，可以用于监控和管理你的应用程序。Actuator提供了许多有用的信息，例如应用程序运行时间、内存使用情况、HTTP请求数量、数据库连接池使用情况等，这些信息可以帮助你监控应用程序的运行情况并进行优化。

Actuator提供了许多内置的端点，例如/health、/info、/metrics等。你可以通过在应用程序的配置文件中启用这些端点，来访问这些信息并进行监控和管理。此外，你还可以自定义端点，提供一些特定的功能或信息。

Actuator还提供了一些可扩展的插件，例如Spring Boot Admin，可以用于图形化展示应用程序的运行情况和健康状况。

## 二、实例 ##

下面是一个简单的Spring Boot项目，演示如何在应用程序中使用Actuator。我们将启用内置的端点，并自定义一个端点来展示应用程序的版本信息。

首先，在项目的 `pom.xml` 文件中添加以下依赖：

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-actuator</artifactId>
    </dependency>

该依赖将为我们提供Actuator所需的所有类和配置文件。

接下来，在项目的配置文件中，添加以下配置来启用Actuator的内置端点：

management:
      endpoints:
        web:
          exposure:
            include: "*"

这会启用所有的内置端点，包括 `/health`、`/info`、`/metrics`等等。如果你只想启用特定的端点，可以使用`exclude`或`include`来指定。

现在，我们需要自定义一个端点，用于展示应用程序的版本信息。首先，创建一个Java类，实现`Endpoint`接口，并重写`invoke()`方法。以下是示例代码：

@Component
    public class VersionEndpoint implements Endpoint<String> {
        
    
        private final String version;
    
        public VersionEndpoint(@Value("${app.version}") String version) {
        
            this.version = version;
        }
    
        @Override
        public String getId() {
        
            return "version";
        }
    
        @Override
        public boolean isEnabled() {
        
            return true;
        }
    
        @Override
        public boolean isSensitive() {
        
            return false;
        }
    
        @Override
        public String invoke() {
        
            return "Version: " + version;
        }
    }

该类实现了`Endpoint`接口，并使用`@Component`注解将其交给Spring容器管理。构造函数中使用`@Value`注解获取应用程序的版本号，`invoke()`方法实现了自定义端点的功能，返回应用程序的版本信息。此外，我们还需要重写`getId()`、`isEnabled()`、`isSensitive()`方法，分别指定端点的ID、是否启用、是否敏感等信息。

最后，在`application.properties`文件中添加以下配置，指定应用程序的版本号：

app.version=1.0.0

现在，启动应用程序，并访问`/version`端点，就能够看到应用程序的版本信息了。