付録 A: 共通のアプリケーションプロパティ
application.properties
ファイル、application.yml
ファイル、コマンドラインスイッチとして、さまざまなプロパティを指定したり環境別に切り替えたりできます。この付録では、一般的な Spring Cloud Commons プロパティの一覧と、使用する基になるクラスへの参照を提供します。なお、プロパティ名はバージョンアップ時に変更される場合があるため、使用している Spring Boot バージョンのドキュメントを参照してください。
プロパティのコントリビュートは、クラスパス上の追加の jar ファイルから得られる可能性があるため、これを完全な一覧と見なすべきではありません。また、独自のプロパティを定義できます。 |
名前 | デフォルト | 説明 |
---|---|---|
spring.cloud.compatibility-verifier.compatible-boot-versions | Spring Boot 依存関係のデフォルトで受け入れられるバージョン。具体的な値を指定したくない場合は、パッチバージョンに {@code x} を設定できます。例: {@ コード 3.4.x} | |
spring.cloud.compatibility-verifier.enabled |
| Spring Cloud 互換性検証の作成を有効にします。 |
spring.cloud.config.allow-override |
| {@link #isOverrideSystemProperties()systemPropertiesOverride} を使用できることを示すフラグ。ユーザーが誤ってデフォルトを変更しないようにするには、false に設定します。デフォルトは true です。 |
spring.cloud.config.initialize-on-context-refresh |
| コンテキストリフレッシュイベントでブートストラップ構成を初期化するフラグ。デフォルトは false。 |
spring.cloud.config.override-none |
| {@link #setAllowOverride(boolean) allowedOverride} が true の場合、外部プロパティの優先順位が最も低くなり、既存のプロパティソース (ローカル構成ファイルを含む) をオーバーライドしてはならないことを示すフラグ。デフォルトは false。これは、config first bootstrap を使用する場合にのみ効果があります。 |
spring.cloud.config.override-system-properties |
| 外部プロパティがシステムプロパティをオーバーライドする必要があることを示すフラグ。デフォルトは true です。 |
spring.cloud.decrypt-environment-post-processor.enabled |
| DecryptEnvironmentPostProcessor を有効にします。 |
spring.cloud.discovery.client.composite-indicator.enabled |
| ディスカバリクライアントの複合ヘルスインジケータを有効にします。 |
spring.cloud.discovery.client.health-indicator.enabled |
| |
spring.cloud.discovery.client.health-indicator.include-description |
| |
spring.cloud.discovery.client.health-indicator.use-services-query |
| インジケーターがそのヘルスをチェックするために {@ linkDiscoveryClient#getServices} を使用する必要があるかどうか。{@code false} に設定すると、インジケーターは代わりにライターの {@link DiscoveryClient#probe()} を使用します。これは、返されるサービスの数によって操作が不必要に重くなる大規模なデプロイで役立ちます。 |
spring.cloud.discovery.client.simple.instances | ||
spring.cloud.discovery.client.simple.local.host | ||
spring.cloud.discovery.client.simple.local.instance-id | ||
spring.cloud.discovery.client.simple.local.metadata | ||
spring.cloud.discovery.client.simple.local.port |
| |
spring.cloud.discovery.client.simple.local.secure |
| |
spring.cloud.discovery.client.simple.local.service-id | ||
spring.cloud.discovery.client.simple.local.uri | ||
spring.cloud.discovery.client.simple.order | ||
spring.cloud.discovery.enabled |
| ディスカバリクライアントのヘルスインジケータを有効にします。 |
spring.cloud.features.enabled |
| 関数エンドポイントを有効にします。 |
spring.cloud.httpclientfactories.apache.enabled |
| Apache Http クライアントファクトリ Bean の作成を有効にします。 |
spring.cloud.httpclientfactories.ok.enabled |
| OKHttp クライアントファクトリ Bean の作成を有効にします。 |
spring.cloud.hypermedia.refresh.fixed-delay |
| |
spring.cloud.hypermedia.refresh.initial-delay |
| |
spring.cloud.inetutils.default-hostname |
| デフォルトのホスト名。エラーの場合に使用されます。 |
spring.cloud.inetutils.default-ip-address |
| デフォルトの IP アドレス。エラーの場合に使用されます。 |
spring.cloud.inetutils.ignored-interfaces | 無視されるネットワークインターフェースの Java 正規表現のリスト。 | |
spring.cloud.inetutils.preferred-networks | 優先されるネットワークアドレスの Java 正規表現のリスト。 | |
spring.cloud.inetutils.timeout-seconds |
| ホスト名を計算するためのタイムアウト(秒単位)。 |
spring.cloud.inetutils.use-only-site-local-interfaces |
| サイトのローカルアドレスを持つインターフェースのみを使用するかどうか。詳細については、{@ link InetAddress#isSiteLocalAddress()} を参照してください。 |
spring.cloud.loadbalancer.cache.caffeine.spec | キャッシュの作成に使用する仕様。スペック形式の詳細については、CaffeineSpec を参照してください。 | |
spring.cloud.loadbalancer.cache.capacity |
| int として表される初期キャッシュ容量。 |
spring.cloud.loadbalancer.cache.enabled |
| Spring Cloud LoadBalancer キャッシュメカニズムを有効にします。 |
spring.cloud.loadbalancer.cache.ttl |
| 有効期間 - レコードの書き込みからカウントされ、その後キャッシュエントリが期限切れになるまでの時間。 |
spring.cloud.loadbalancer.call-get-with-request-on-delegates |
| このフラグが {@code true} に設定されている場合、{@code ServiceInstanceListSupplier#get(Request request)} メソッドが実装され、{@code DelegatingServiceInstanceListSupplier} から割り当て可能なクラスでそのメソッドをまだ実装していない場合に {@code delegate.get(request)} が呼び出されます。ただし、{@code CachingServiceInstanceListSupplier} と {@code HealthCheckServiceInstanceListSupplier} は除外されます。これらのクラスは、リクエストベースのフィルタリングが行われる前に、ネットワーク経由でインスタンスの取得を実行するサプライヤーの直後にインスタンスサプライヤー階層に配置する必要があります。注: 4.1 では、この動作がデフォルトになります。 |
spring.cloud.loadbalancer.clients | ||
spring.cloud.loadbalancer.configurations |
| 事前定義された LoadBalancer 構成を有効にします。 |
spring.cloud.loadbalancer.eager-load.clients | クライアントの名前。 | |
spring.cloud.loadbalancer.enabled |
| Spring Cloud LoadBalancer を有効にします。 |
spring.cloud.loadbalancer.health-check.initial-delay |
| HealthCheck スケジューラーの初期遅延値。 |
spring.cloud.loadbalancer.health-check.interval |
| HealthCheck スケジューラーを再実行するための間隔。 |
spring.cloud.loadbalancer.health-check.interval |
| HealthCheck スケジューラーを再実行するための間隔。 |
spring.cloud.loadbalancer.health-check.path | ヘルスチェックリクエストを行うパス。 | |
spring.cloud.loadbalancer.health-check.port | ヘルスチェックリクエストを行う必要があるパス。何も設定されていない場合、リクエストされたサービスがサービスインスタンスで利用できるポート。 | |
spring.cloud.loadbalancer.health-check.refetch-instances |
|
|
spring.cloud.loadbalancer.health-check.refetch-instances-interval |
| 使用可能なサービスインスタンスを再フェッチする間隔。 |
spring.cloud.loadbalancer.health-check.repeat-health-check |
| ヘルスチェックを繰り返し続ける必要があるかどうかを示します。インスタンスを定期的に再フェッチする場合は、再フェッチのたびにヘルスチェックもトリガーされるため、これを |
spring.cloud.loadbalancer.health-check.update-results-list |
| 取得された有効な {@link ServiceInstance} ごとに {@code healthCheckFlux} を発行するかどうかを示します。{@code false} に設定すると、アライブインスタンスシーケンス全体が最初にリストに収集されてから出力されます。 |
spring.cloud.loadbalancer.hint | <code>hint</code> の値を設定できます。</code> that is passed on to the LoadBalancer request and can subsequently be used in {@link ReactiveLoadBalancer} implementations. | |
spring.cloud.loadbalancer.hint-header-name |
| ヒントベースのサービスインスタンスフィルタリングのヒントを渡すために使用されるヘッダーの名前を設定できます。 |
spring.cloud.loadbalancer.retry.avoid-previous-instance |
| Spring-Retry がクラスパスにある場合、ServiceInstanceListSupplier Bean を |
spring.cloud.loadbalancer.retry.backoff.enabled |
| Reactor 再試行バックオフを適用する必要があるかどうかを示します。 |
spring.cloud.loadbalancer.retry.backoff.jitter |
|
|
spring.cloud.loadbalancer.retry.backoff.max-backoff |
|
|
spring.cloud.loadbalancer.retry.backoff.min-backoff |
|
|
spring.cloud.loadbalancer.retry.enabled |
| LoadBalancer の再試行を有効にします。 |
spring.cloud.loadbalancer.retry.max-retries-on-next-service-instance |
| 次の |
spring.cloud.loadbalancer.retry.max-retries-on-same-service-instance |
| 同じ |
spring.cloud.loadbalancer.retry.retry-on-all-exceptions |
|
|
spring.cloud.loadbalancer.retry.retry-on-all-operations |
|
|
spring.cloud.loadbalancer.retry.retryable-exceptions |
| 再試行をトリガーする必要がある |
spring.cloud.loadbalancer.retry.retryable-status-codes |
| 再試行をトリガーするステータスコードの |
spring.cloud.loadbalancer.service-discovery.timeout | サービスディスカバリへの呼び出しのタイムアウトの期間の文字列表現。 | |
spring.cloud.loadbalancer.stats.micrometer.enabled |
| Spring Cloud LoadBalancer Micrometer 統計を有効にします。 |
spring.cloud.loadbalancer.sticky-session.add-service-instance-cookie |
| 新しく選択されたインスタンスを含む Cookie を LoadBalancer で追加する必要があるかどうかを示します。 |
spring.cloud.loadbalancer.sticky-session.instance-id-cookie-name |
| 優先インスタンス ID を保持する Cookie の名前。 |
spring.cloud.loadbalancer.x-forwarded.enabled |
| X-Forwarded ヘッダーを有効にします。 |
spring.cloud.loadbalancer.zone | Spring Cloud LoadBalancer ゾーン。 | |
spring.cloud.refresh.additional-property-sources-to-retain | リフレッシュ中に保持する追加のプロパティソース。通常、システムプロパティソースのみが保持されます。このプロパティを使用すると、EnvironmentPostProcessors によって作成されたプロパティソースなどのプロパティソースも保持できます。 | |
spring.cloud.refresh.enabled |
| リフレッシュスコープと関連機能の自動構成を有効にします。 |
spring.cloud.refresh.extra-refreshable |
| 後処理をリフレッシュスコープに入れる Bean の追加のクラス名。 |
spring.cloud.refresh.never-refreshable |
| Bean のクラス名のコンマ区切りリストは、リフレッシュまたはリバウンドされません。 |
spring.cloud.service-registry.auto-registration.enabled |
| サービスの自動登録が有効になっているかどうか。デフォルトは true です。 |
spring.cloud.service-registry.auto-registration.fail-fast |
| AutoServiceRegistration がない場合に起動に失敗するかどうか。デフォルトは false です。 |
spring.cloud.service-registry.auto-registration.register-management |
| 管理をサービスとして登録するかどうか。デフォルトは true です。 |
spring.cloud.util.enabled |
| Spring Cloud ユーティリティ Bean の作成を有効にします。 |
1. 可観測性メタデータ
1.1. 可観測性 - メトリクス
以下に、このプロジェクトで宣言されたすべての指標のリストを示します。
1.1.1. サーキットブレーカー機能の監視
フォールバックとして CircuitBreaker に渡される関数をラップするときに作成されたオブザベーション。
指標名 spring.cloud.circuitbreaker
(規約クラス org.springframework.cloud.client.circuitbreaker.observation.DefaultCircuitBreakerObservationConvention
で定義)。タイプ timer
.
指標名 spring.cloud.circuitbreaker.active
(規約クラス org.springframework.cloud.client.circuitbreaker.observation.DefaultCircuitBreakerObservationConvention
で定義)。タイプ long task timer
.
観測の開始後に追加された KeyValues は、*.active メトリクスから欠落している可能性があります。 |
Micrometer は、ベースユニットに nanoseconds を内部的に使用します。ただし、各バックエンドが実際のベースユニットを決定します。(つまり、Prometheus は秒を使用します) |
外側のクラス org.springframework.cloud.client.circuitbreaker.observation.CircuitBreakerObservationDocumentation
の完全修飾名。
すべてのタグには、spring.cloud.circuitbreaker プレフィックスを付ける必要があります。 |
名前 | 説明 |
| ラップされたラムダの型を定義します。 |
1.1.2. サーキットブレーカーサプライヤーの監視
CircuitBreaker に渡されたサプライヤーをラップするときに作成されたオブザベーション。
指標名 spring.cloud.circuitbreaker
(規約クラス org.springframework.cloud.client.circuitbreaker.observation.DefaultCircuitBreakerObservationConvention
で定義)。タイプ timer
.
指標名 spring.cloud.circuitbreaker.active
(規約クラス org.springframework.cloud.client.circuitbreaker.observation.DefaultCircuitBreakerObservationConvention
で定義)。タイプ long task timer
.
観測の開始後に追加された KeyValues は、*.active メトリクスから欠落している可能性があります。 |
Micrometer は、ベースユニットに nanoseconds を内部的に使用します。ただし、各バックエンドが実際のベースユニットを決定します。(つまり、Prometheus は秒を使用します) |
外側のクラス org.springframework.cloud.client.circuitbreaker.observation.CircuitBreakerObservationDocumentation
の完全修飾名。
すべてのタグには、spring.cloud.circuitbreaker プレフィックスを付ける必要があります。 |
名前 | 説明 |
| ラップされたラムダの型を定義します。 |
1.2. 可観測性 - スパン
以下に、このプロジェクトで宣言されたすべてのスパンのリストを示します。
1.2.1. サーキットブレーカー機能の観測期間
フォールバックとして CircuitBreaker に渡される関数をラップするときに作成されたオブザベーション。
スパン名 spring.cloud.circuitbreaker
(規約クラス org.springframework.cloud.client.circuitbreaker.observation.DefaultCircuitBreakerObservationConvention
で定義)。
外側のクラス org.springframework.cloud.client.circuitbreaker.observation.CircuitBreakerObservationDocumentation
の完全修飾名。
すべてのタグには、spring.cloud.circuitbreaker プレフィックスを付ける必要があります。 |
名前 | 説明 |
| ラップされたラムダの型を定義します。 |
1.2.2. サーキットブレーカーサプライヤーの観測期間
CircuitBreaker に渡されたサプライヤーをラップするときに作成されたオブザベーション。
スパン名 spring.cloud.circuitbreaker
(規約クラス org.springframework.cloud.client.circuitbreaker.observation.DefaultCircuitBreakerObservationConvention
で定義)。
外側のクラス org.springframework.cloud.client.circuitbreaker.observation.CircuitBreakerObservationDocumentation
の完全修飾名。
すべてのタグには、spring.cloud.circuitbreaker プレフィックスを付ける必要があります。 |
名前 | 説明 |
| ラップされたラムダの型を定義します。 |