Spring Boot アクチュエーターエンドポイントが明らかに: アプリケーションを簡単に監視-安全性-php.cn

1. Spring Boot Actuator エンドポイントの概要

1.1 Actuator エンドポイントとは

Spring Boot Actuator は、Spring Boot アプリケーションの監視と管理に使用されるサブプロジェクトです。アプリケーションのステータス、動作ステータス、動作インジケーターを表示するために使用できる一連の組み込みエンドポイント (エンドポイント) を提供します。アクチュエータエンドポイントは、HTTP、JMX、またはその他の形式で外部システムに公開できるため、運用および保守担当者がアプリケーションを監視、診断、管理することが容易になります。

1.2 エンドポイントの役割と機能

Actuator エンドポイントは主に次の機能を実装するために使用されます:

データベース接続、キャッシュ、メッセージキューなどを含むアプリケーションプログラムの健全性チェックを提供します。
メモリ使用量、GC ステータス、スレッドステータスなどのアプリケーションメトリックデータを収集します。
環境変数、システムプロパティ、構成ファイル内のプロパティなど、アプリケーションの構成情報を表示します。
ログを管理するログの表示と動的変更を含むアプリケーションのレベル
アプリケーションの Spring Bean 情報やアプリケーションのメタデータなどを取得します。
アプリケーションのシャットダウン機能などを提供します。

1.3 Actuator エンドポイントのデフォルト構成

Spring Boot Actuator は、一連のアクチュエーターエンドポイントを提供します。デフォルトでは組み込みエンドポイントがあり、開発環境では直接アクセスできますが、運用環境では、エンドポイントの権限制御と公開ポリシーを構成する必要がある場合があります。アクチュエーターエンドポイントは、application.properties または application.yml ファイルを通じて構成できます。たとえば、
management.endpoints.web.exposure.include を構成することで、どのエンドポイントを外部アクセスに公開するかを制御したり、management.endpoints.web.base-path を通じてエンドポイントの URL パスを変更したりできます。

2. 組み込みエンドポイントの詳細な説明

Spring Boot Actuator は、アプリケーションのさまざまな側面を表示および管理するための多くの組み込みエンドポイントを提供します。以下は、一般的に使用されるエンドポイントの詳細です。

2.1 /actuator/health

このエンドポイントは、アプリケーションの正常性状態を表示するために使用されます。データベース接続、キャッシュ、メッセージキューなどのさまざまなコンポーネントのステータスをチェックします。返されるステータスには、UP(正常)、DOWN(異常)、OUT_OF_SERVICE(メンテナンス中)などが含まれます。

2.2 /actuator/info

このエンドポイントは、バージョン番号、ビルド時間など、アプリケーションの基本情報を表示するために使用されます。この情報は通常、アプリケーションの構成ファイルまたはビルドシステムから取得されます。

2.3 /actuator/metrics

このエンドポイントは、アプリケーションのメトリックデータを表示するために使用されます。メモリ使用量、GC、スレッドステータスなどに関するデータを収集します。特定のメトリクスの詳細は、パラメータを追加することで表示できます。例:

/actuator/metrics/jvm.memory.used。

ログイン後にコピー

2.4 /actuator/beans

このエンドポイントは、すべてのメトリクスを表示するために使用されます。春の豆。 Bean の名前、タイプ、スコープ、所属する ApplicationContext などの情報が表示されます。

2.5 /actuator/env

このエンドポイントは、環境変数、システムプロパティ、構成ファイル内のプロパティなど、アプリケーションの環境情報を表示するために使用されます。。 /actuator/env/server.port などのパラメータを追加すると、特定のプロパティの値を表示できます。

2.6 /actuator/loggers

このエンドポイントは、アプリケーションのログの表示と管理に使用されます。現在のアプリケーション内のすべてのロガーの名前とログレベルが表示されます。 POST リクエストを送信することで、ロガーのログレベルを動的に変更することもできます。

2.7 /actuator/shutdown

このエンドポイントは、アプリケーションをシャットダウンするために使用されます。有効にするには、
management.endpoint.shutdown.enabled を true に設定する必要があります。運用環境では、通常、悪用を防ぐためにこのエンドポイントのアクセス許可を制御する必要があります。

2.8 その他のエンドポイント

上記の一般的なエンドポイントに加えて、Spring Boot Actuator は次のような他のエンドポイントも提供します。

/actuator/auditevents：查看应用程序的审计事件
/actuator/threaddump：获取应用程序的线程转储信息
/actuator/heapdump：获取应用程序的堆转储信息
/actuator/mappings：查看应用程序的 URL 映射信息

三、端点配置与定制

在实际项目中，我们可能需要对 Spring Boot Actuator 的端点进行一些定制，以满足特定的需求。本节将介绍如何对端点进行配置和定制。

3.1 控制端点访问权限

访问端点可能涉及敏感信息，我们需要对端点进行权限控制。可以通过集成 Spring Security 或自定义拦截器实现访问权限控制。例如，仅允许具有 ADMIN 角色的用户访问 /actuator/shutdown 端点。

3.2 端点暴露策略

可以通过management.endpoints.web.exposure.include 和 management.endpoints.web.exposure.exclude 配置项来控制哪些端点应该被暴露。默认情况下，仅暴露 /actuator/health 和 /actuator/info 端点。例如，暴露所有端点：

management.endpoints.web.exposure.include=*

ログイン後にコピー

或者仅暴露某些特定端点：

management.endpoints.web.exposure.include=health,info,metrics,env

ログイン後にコピー

3.3 修改端点的 URL 路径

默认情况下，所有端点的路径都是以 /actuator 开头的。我们可以通过
management.endpoints.web.base-path 配置项修改这个前缀。例如，将其更改为 /admin：

management.endpoints.web.base-path=/admin

ログイン後にコピー

3.4 端点响应内容定制

默认情况下，某些端点的响应内容可能不包含我们关心的所有信息。可以通过实现自定义的 EndpointFilter 来定制端点的响应内容。例如，可以为 /actuator/health 端点添加自定义的健康指标。或者通过继承并重写原有端点的方法来实现定制。

通过这些定制方法，我们可以使 Spring Boot Actuator 更好地适应实际项目需求。

四、创建自定义端点

在某些情况下，内置的端点无法满足我们的需求，因此我们需要创建自定义端点。本节将介绍自定义端点的实现方式、应用场景举例以及如何注册和配置自定义端点。

4.1 自定义端点的实现方式

要创建自定义端点，需要实现org.springframework.boot.actuate.endpoint.web.annotation.RestControllerEndpoint 接口或 org.springframework.boot.actuate.endpoint.annotation.Endpoint 接口。其中，RestControllerEndpoint 接口允许我们创建基于 Web 的端点，而 Endpoint 接口则适用于其他类型的端点。

4.2 注册和配置自定义端点

创建自定义端点后，需要将其注册到 Spring Boot Actuator。我们可以通过将自定义端点作为 Bean 注册到 Spring 上下文来实现。例如：

import org.springframework.boot.actuate.endpoint.annotation.Endpoint;
import org.springframework.boot.actuate.endpoint.annotation.ReadOperation;
import org.springframework.stereotype.Component;

@Component
@Endpoint(id = "cache-status")
public class CacheStatusEndpoint {

@ReadOperation
public CacheStatus getCacheStatus() {
// 在这里实现获取缓存状态的逻辑
// 例如，从缓存管理器中获取相关信息
CacheStatus cacheStatus = new CacheStatus();
cacheStatus.setCacheSize(100);
cacheStatus.setHitCount(200);
cacheStatus.setMissCount(50);
return cacheStatus;
}
}

ログイン後にコピー

在上面的代码中，我们首先使用@Endpoint注解来指定端点的ID（即cache-status）。然后，我们定义了一个getCacheStatus()方法，使用@ReadOperation注解来表示这是一个读操作。此方法应返回一个表示缓存状态的对象（例如，CacheStatus类）。

接下来，我们需要定义CacheStatus类：

public class CacheStatus {

private int cacheSize;
private int hitCount;
private int missCount;

// 省略 getter 和 setter 方法
}

ログイン後にコピー

接下来，我们需要为自定义端点配置访问权限、暴露策略等。这可以通过在 application.properties 文件中添加相关配置来实现。例如：

management.endpoints.web.exposure.include=health,info,cache-status

ログイン後にコピー

这将使得我们的自定义端点 /actuator/cache-status 能够被访问。

五、端点数据监控与可视化

在本节中，我们将介绍如何利用Spring Boot Actuator端点数据进行监控与可视化，从而更好地了解应用程序的运行状况。

5.1 使用JMX监控端点

Java Management Extensions（JMX）是Java平台的一种技术，允许对Java应用程序进行管理和监控。Spring Boot Actuator默认支持将端点数据暴露到JMX。要使用JMX监控端点，请确保在应用程序的application.properties或application.yml文件中启用了JMX：

management.endpoints.jmx.exposure.include=*

ログイン後にコピー

然后，您可以使用JMX客户端（如Java Mission Control、VisualVM等）连接到应用程序的JMX端口，查看和操作暴露的端点数据。

5.2 使用Prometheus和Grafana进行可视化监控

Prometheus是一个流行的开源监控系统，与Grafana这个数据可视化工具结合使用，可以为Spring Boot Actuator端点数据提供强大的可视化监控功能。

首先，需要在Spring Boot应用程序中集成Prometheus。添加相应的依赖并配置application.properties或application.yml文件，以启用Prometheus端点：

management.endpoints.web.exposure.include=*
management.metrics.export.prometheus.enabled=true

ログイン後にコピー

接下来，需要配置Prometheus来抓取Spring Boot应用程序的数据。在Prometheus的配置文件中（通常是prometheus.yml），添加以下内容：

scrape_configs:
- job_name: 'spring-boot-actuator'
metrics_path: '/actuator/prometheus'
static_configs:
- targets: ['localhost:8080'] # 将此处替换为Spring Boot应用程序的实际地址

ログイン後にコピー

最后，在Grafana中添加Prometheus数据源，并创建仪表板来展示和分析Spring Boot Actuator端点的数据。如下图所示：

Spring Boot Actuator端点大揭秘：轻松监控你的应用程序