すべてのプロパティ
Actuator が読むすべてのプロパティを、プレフィックスごとにまとめています。キーは Spring Boot のものです。spring_boot_actuator はエンドポイントのプロパティクラス (HealthEndpointProperties、ManagementHealthProperties、ManagementInfoProperties、EndpointsProperties、ProjectInfoProperties) を持ち、spring_boot_starter_actuator は WebEndpointProperties を追加します。どちらもそれらからエディター用のメタデータを生成します。
使う理由
Actuator はすべてプロパティで設定します。このページはすべてのキーを列挙しているため、名前、デフォルト、指定できる値を一か所で確認できます。
例
Kubernetes の背後にあり、詳細は管理者だけが見られるサーバー:
# lib/resources/application.yml
management:
endpoints:
web:
base-path: /actuator
exposure:
include: health,info,mappings
path-mapping:
health: health
access:
default: read-only
endpoint:
health:
show-details: when-authorized
show-components: always
roles: ADMIN
status:
order: fatal,down,out-of-service,unknown,up
http-mapping:
fatal: 500
group:
core:
include: ping,db
show-details: always
additional-path: "server:/healthz"
probes:
enabled: true
add-additional-paths: true
logging:
slow-indicator-threshold: 5s
mappings:
access: none
health:
diskspace:
path: /srv/shop
threshold: 500MB
info:
env:
enabled: true
git:
mode: full
spring:
info:
git:
location: file:./git.properties
info:
app:
team: neon-books
# lib/resources/application.properties: 同じ内容
management.endpoints.web.base-path=/actuator
management.endpoints.web.exposure.include=health,info,mappings
management.endpoints.web.path-mapping.health=health
management.endpoints.access.default=read-only
management.endpoint.health.show-details=when-authorized
management.endpoint.health.show-components=always
management.endpoint.health.roles=ADMIN
management.endpoint.health.status.order=fatal,down,out-of-service,unknown,up
management.endpoint.health.status.http-mapping.fatal=500
management.endpoint.health.group.core.include=ping,db
management.endpoint.health.group.core.show-details=always
management.endpoint.health.group.core.additional-path=server:/healthz
management.endpoint.health.probes.enabled=true
management.endpoint.health.probes.add-additional-paths=true
management.endpoint.health.logging.slow-indicator-threshold=5s
management.endpoint.mappings.access=none
management.health.diskspace.path=/srv/shop
management.health.diskspace.threshold=500MB
management.info.env.enabled=true
management.info.git.mode=full
spring.info.git.location=file:./git.properties
info.app.team=neon-books
値の書き方
- アクセス:
none、read-only、unrestricted (大文字小文字も区切り文字も問いません)。それ以外の値は起動を止めます。
- 表示:
never、when-authorized、always。
- リスト: カンマ区切りのリストか YAML のリスト。
exposure.include、exposure.exclude、グループの include では * はすべてを意味します。YAML では "*" を引用符で囲んでください。
status.order と http-mapping.<status> のステータス: up、down、out-of-service、unknown、または独自のもの。
- 期間 (
5s) とデータサイズ (500MB) は、他のすべてのプロパティと同じです。
management.endpoints.web.*: 公開とパス (spring_boot_starter_actuator)
| キー |
型 |
デフォルト |
意味 |
management.endpoints.web.base-path |
パス |
/actuator |
エンドポイントの場所。/ はディスカバリーページなしでルートに置く → エンドポイント |
management.endpoints.web.exposure.include |
List<String> |
health |
HTTP で公開する ID。すべてなら * |
management.endpoints.web.exposure.exclude |
List<String> |
なし |
公開しない ID。include より優先される |
management.endpoints.web.path-mapping.<id> |
パス |
ID |
エンドポイントの別のパス |
management.endpoints.web.discovery.enabled |
bool |
true |
ベースパスが、公開されたエンドポイントの _links を返す |
management.endpoints.* と management.endpoint.<id>.*: 有効化
| キー |
型 |
デフォルト |
意味 |
management.endpoint.<id>.access |
none / read-only / unrestricted |
なし |
Spring Boot 3.4 のスイッチ。none はエンドポイントを無効にする。enabled より優先される |
management.endpoint.<id>.enabled |
bool |
エンドポイントのデフォルト (health、info、mappings は true) |
エンドポイントが存在するかどうか |
management.endpoints.access.default |
none / read-only / unrestricted |
なし |
自分の設定を持たないすべてのエンドポイントのアクセス |
management.endpoints.enabled-by-default |
bool |
なし |
すべての management.endpoint.<id>.enabled のデフォルト |
<id> は health、info、mappings、jsonschemas、isolates、qps、または独自のエンドポイントの ID です。エンドポイント を参照してください。
management.endpoint.health.*: health エンドポイント
| キー |
型 |
デフォルト |
意味 |
management.endpoint.health.show-details |
Show |
never |
インジケーターの詳細を誰が見られるか → ヘルス |
management.endpoint.health.show-components |
Show |
show-details と同じ |
コンポーネントを名前で誰が見られるか |
management.endpoint.health.roles |
List<String> |
空: ログインした任意のユーザー |
when-authorized が求めるロール (いずれか一つ)。ADMIN は ROLE_ADMIN に一致する |
management.endpoint.health.status.order |
List<String> |
down、out-of-service、up、unknown |
最も深刻なものからのステータス。各部分の最初のものが集約結果 |
management.endpoint.health.status.http-mapping.<status> |
int |
down と out-of-service: 503。その他は 200 |
ヘルスのステータスの HTTP ステータス |
management.endpoint.health.group.<name>.include |
List<String> |
すべて |
/actuator/health/<name> のグループのメンバー。コンポジットの一部には db/primary |
management.endpoint.health.group.<name>.exclude |
List<String> |
なし |
除外するメンバー |
management.endpoint.health.group.<name>.show-details |
Show |
エンドポイントのもの |
グループの詳細を誰が見られるか |
management.endpoint.health.group.<name>.show-components |
Show |
グループの show-details |
グループのコンポーネントを誰が見られるか |
management.endpoint.health.group.<name>.roles |
List<String> |
エンドポイントのもの |
グループの when-authorized のロール |
management.endpoint.health.group.<name>.status.order |
List<String> |
エンドポイントのもの |
グループの集約 |
management.endpoint.health.group.<name>.status.http-mapping.<status> |
int |
エンドポイントのもの |
グループの HTTP コード |
management.endpoint.health.group.<name>.additional-path |
server:/path |
なし |
メインのサーバーのそのパスでもグループに応答する |
management.endpoint.health.probes.enabled |
bool |
false。Kubernetes と Cloud Foundry では true |
liveness と readiness のグループと、そのインジケーター |
management.endpoint.health.probes.add-additional-paths |
bool |
false |
/livez と /readyz でもプローブに応答する |
management.endpoint.health.validate-group-membership |
bool |
true |
存在しないコントリビューターを指定するグループは起動を止める |
management.endpoint.health.logging.slow-indicator-threshold |
Duration |
10s |
これより遅いインジケーターは警告としてログに出される |
management.endpoint.health.enabled、.access |
|
|
上の「有効化」を参照 |
management.health.*: インジケーター
| キー |
型 |
デフォルト |
意味 |
management.health.defaults.enabled |
bool |
true |
すべてのインジケーターの enabled のデフォルト |
management.health.ping.enabled |
bool |
defaults.enabled |
常に UP の ping インジケーター |
management.health.diskspace.enabled |
bool |
defaults.enabled |
diskSpace インジケーター |
management.health.diskspace.path |
パス |
. |
ファイルシステムをチェックするパス |
management.health.diskspace.threshold |
DataSize |
10MB |
UP となる最小の空き容量 |
management.health.db.enabled |
bool |
defaults.enabled |
spring_boot_starter_data の db インジケーター |
management.health.livenessstate.enabled |
bool |
false |
プローブなしでの livenessState インジケーター |
management.health.readinessstate.enabled |
bool |
false |
プローブなしでの readinessState インジケーター |
management.health.<name>.enabled |
bool |
defaults.enabled |
@ConditionalOnEnabledHealthIndicator('<name>') を使うライブラリのインジケーター |
management.info.*: 情報コントリビューター
| キー |
型 |
デフォルト |
意味 |
management.info.defaults.enabled |
bool |
true |
build と git のデフォルト → 情報 |
management.info.build.enabled |
bool |
defaults.enabled |
ファイルがあるときの build コントリビューター |
management.info.git.enabled |
bool |
defaults.enabled |
ファイルがあるときの git コントリビューター |
management.info.git.mode |
simple / full |
simple |
ブランチ、短いコミット ID、時刻、またはすべてのキー |
management.info.env.enabled |
bool |
false |
プレフィックスを除いた info.* プロパティ |
management.info.os.enabled |
bool |
false |
オペレーティングシステム |
management.info.dart.enabled |
bool |
false |
Dart のバージョン (Spring Boot の java) |
management.info.<id>.enabled |
bool |
|
@ConditionalOnEnabledInfoContributor('<id>') を使うライブラリのコントリビューター |
spring.info.*: プロジェクト情報のファイル
| キー |
型 |
デフォルト |
意味 |
spring.info.build.location |
ロケーション |
resources:build-info.properties |
ビルドの build.* キー (Spring Boot: classpath:META-INF/build-info.properties) |
spring.info.build.encoding |
UTF-8 / ISO-8859-1 |
UTF-8 |
そのエンコーディング |
spring.info.git.location |
ロケーション |
resources:git.properties |
git.* キー |
spring.info.git.encoding |
UTF-8 / ISO-8859-1 |
UTF-8 |
そのエンコーディング |
info.*
| キー |
型 |
デフォルト |
意味 |
info.<anything> |
任意 |
なし |
自由な詳細。management.info.env.enabled=true のとき、(info. を除いた) キーのもとに表示される |
Actuator が使う他のパッケージのプロパティ
| キー |
パッケージ |
効果 |
spring.application.name |
spring_boot_dart |
mappings でのコンテキストの名前 |
spring.main.cloud-platform |
spring_core_dart |
Kubernetes や Cloud Foundry ではプローブが有効になる |
server.port、server.context-path |
spring_boot_starter_web |
エンドポイントが応答する場所 |
spring.web.debug.qps.enabled |
spring_boot_starter_web |
ビルドが読みます。true は qps エンドポイントを、リクエストを数えるコードとともにアプリケーションに入れます → 毎秒のリクエスト数 |
server.isolates.* |
spring_boot_starter_web |
isolate のプールがあると、isolates と qps はどの isolate からでもアプリケーション全体について応答します。他のエンドポイントは、リクエストを受け取った isolate について応答します → isolate |
まだ対応していないもの
management.server.* (エンドポイント専用のポート)、management.endpoints.web.cors.*、management.endpoints.jmx.*、management.metrics.*、management.tracing.*、そして health、info、mappings 以外の Spring Boot のエンドポイント。
関連項目