共通のアプリケーションプロパティ

さまざまなプロパティは、application.properties ファイル内、application.yml ファイル内、またはコマンドラインスイッチとして指定できます。この付録では、一般的な Spring Cloud Consul プロパティのリストと、使用する基礎となるクラスへの参照を提供します。

プロパティのコントリビュートは、クラスパス上の追加の jar ファイルから得られる可能性があるため、これを完全な一覧と見なすべきではありません。また、独自のプロパティを定義できます。

名前デフォルト説明

名前	デフォルト	説明
spring.cloud.consul.config.acl-token
spring.cloud.consul.config.data-key	`data`	format が Format.PROPERTIES または Format.YAML の場合、次のフィールドは、構成について領事を検索するためのキーとして使用されます。
spring.cloud.consul.config.default-context	`application`
spring.cloud.consul.config.enabled	`true`
spring.cloud.consul.config.fail-fast	`true`	true の場合は構成ルックアップ中に例外をスローし、そうでない場合は警告をログに記録します。
spring.cloud.consul.config.format	`key-value`
spring.cloud.consul.config.name		領事 KV で値を検索する際に使用する spring.application.name の代替。
spring.cloud.consul.config.prefix
spring.cloud.consul.config.prefixes
spring.cloud.consul.config.profile-separator	`,`
spring.cloud.consul.config.watch.delay	`1000`	監視の固定遅延の値（ミリ単位）。デフォルトは 1000 です。
spring.cloud.consul.config.watch.enabled	`true`	監視が有効になっている場合。デフォルトは true です。
spring.cloud.consul.config.watch.wait-time	`55`	ウォッチクエリを待機（またはブロック）する秒数。デフォルトは 55 です。デフォルトの ConsulClient（デフォルトは 60）未満である必要があります。ConsulClient タイムアウトを増やすには、カスタム HttpClient を使用してカスタム ConsulRawClient を使用して ConsulClient Bean を作成します。
spring.cloud.consul.discovery.acl-token
spring.cloud.consul.discovery.catalog-services-watch-delay	`1000`	領事カタログを監視するための呼び出し間の遅延（ミリ単位）。デフォルトは 1000 です。
spring.cloud.consul.discovery.catalog-services-watch-timeout	`2`	領事カタログを見ながらブロックする秒数。デフォルトは 2 秒です。
spring.cloud.consul.discovery.consistency-mode	`default`	医療サービスリクエストの整合性モード。
spring.cloud.consul.discovery.datacenters		serviceId のマップ→ サーバーリストでクエリするデータセンター。これにより、別のデータセンターのサービスを検索できます。
spring.cloud.consul.discovery.default-query-tag		serverListQueryTags にリストされていない場合にサービスリストで照会するタグ。カンマ区切りの値で複数のタグを指定できます。
spring.cloud.consul.discovery.default-zone-metadata-name	`zone`	サービスインスタンスゾーンはメタデータから取得されます。これにより、メタデータタグ名を変更できます。
spring.cloud.consul.discovery.deregister	`true`	領事館でのサービスの自動登録解除を無効にします。
spring.cloud.consul.discovery.enable-tag-override		登録済みサービスのタグオーバーライドを有効にします。
spring.cloud.consul.discovery.enabled	`true`	サービスディスカバリは有効になっていますか？
spring.cloud.consul.discovery.fail-fast	`true`	true の場合、サービス登録中に例外をスローします。それ以外の場合は、警告をログに記録します（デフォルトは true）。
spring.cloud.consul.discovery.health-check-critical-timeout		タイムアウトよりも長い間重要なサービスの登録を解除するためのタイムアウト（例: 30m）。領事バージョン 7.x 以降が必要です。
spring.cloud.consul.discovery.health-check-headers		ヘルスチェック呼び出しに適用されるヘッダー。
spring.cloud.consul.discovery.health-check-interval	`10s`	ヘルスチェックを実行する頻度（例: 10 秒）。デフォルトは 10 秒です。
spring.cloud.consul.discovery.health-check-path	`/actuator/health`	ヘルスチェックのために呼び出す代替サーバーパス。
spring.cloud.consul.discovery.health-check-timeout		ヘルスチェックのタイムアウト（例: 10 秒）。
spring.cloud.consul.discovery.health-check-tls-skip-verify		true の場合、サービスチェック中に証明書の検証をスキップします。それ以外の場合は、証明書の検証を実行します。
spring.cloud.consul.discovery.health-check-url		デフォルトを上書きするカスタムヘルスチェック URL。
spring.cloud.consul.discovery.heartbeat.actuator-health-group		アクチュエーターを介してシステムの状態を判断するときに使用するアクチュエーターの状態グループ (ルートグループの場合は null)。
spring.cloud.consul.discovery.heartbeat.enabled	`false`
spring.cloud.consul.discovery.heartbeat.interval-ratio
spring.cloud.consul.discovery.heartbeat.reregister-service-on-failure	`false`
spring.cloud.consul.discovery.heartbeat.ttl	`30s`
spring.cloud.consul.discovery.heartbeat.use-actuator-health	`true`	アプリケーションの状態を Consul TTL チェックに報告するときに、現在のシステムの状態 (アクチュエーターの状態エンドポイントを介して報告される) を考慮するかどうか。Actuator Health エンドポイントもアプリケーションで利用できる必要があります。
spring.cloud.consul.discovery.hostname		サーバーにアクセスするときに使用するホスト名。
spring.cloud.consul.discovery.include-hostname-in-instance-id	`false`	サービスの登録時にホスト名がデフォルトのインスタンス ID に含まれるかどうか。
spring.cloud.consul.discovery.instance-group		サービスインスタンスグループ。
spring.cloud.consul.discovery.instance-id		一意のサービスインスタンス ID。
spring.cloud.consul.discovery.instance-zone		サービスインスタンスゾーン。
spring.cloud.consul.discovery.ip-address		サービスにアクセスするときに使用する IP アドレス（使用する preferIpAddress も設定する必要があります）。
spring.cloud.consul.discovery.lifecycle.enabled	`true`
spring.cloud.consul.discovery.management-enable-tag-override		登録された管理サービスのタグオーバーライドを有効にします。
spring.cloud.consul.discovery.management-metadata		管理サービスの登録時に使用するメタデータ。
spring.cloud.consul.discovery.management-port		管理サービスを登録するポート（デフォルトは管理ポート）。
spring.cloud.consul.discovery.management-suffix	`management`	管理サービスの登録時に使用するサフィックス。
spring.cloud.consul.discovery.management-tags		管理サービスの登録時に使用するタグ。
spring.cloud.consul.discovery.metadata		サービスの登録時に使用するメタデータ。
spring.cloud.consul.discovery.order	`0`	`CompositeDiscoveryClient` が利用可能なクライアントを並べ替えるために使用する検出クライアントの順序。
spring.cloud.consul.discovery.port		サービスを登録するポート（デフォルトはリスニングポート）。
spring.cloud.consul.discovery.prefer-agent-address	`false`	使用するアドレスを決定する方法のソース。
spring.cloud.consul.discovery.prefer-ip-address	`false`	登録時には、ホスト名ではなく IP アドレスを使用してください。
spring.cloud.consul.discovery.query-passing	`false`	/v1/health/service/serviceName に "passing" パラメーターを追加します。これにより、ヘルスチェックがサーバーにプッシュされます。
spring.cloud.consul.discovery.register	`true`	領事館にサービスとして登録します。
spring.cloud.consul.discovery.register-health-check	`true`	領事館にヘルス診断を登録してください。サービスの開発中に役立ちます。
spring.cloud.consul.discovery.scheme	`http`	http または https サービスを登録するかどうか。
spring.cloud.consul.discovery.server-list-query-tags		サーバーリストで照会する serviceId の → タグのマップ。これにより、1 つ以上のタグでサービスをフィルターできます。複数のタグは、コンマ区切りの値で指定できます。
spring.cloud.consul.discovery.service-name		サービス名。
spring.cloud.consul.discovery.tags		サービス登録時に使用するタグ。
spring.cloud.consul.enabled	`true`	Spring のクラウド領事は有効になっていますか？
spring.cloud.consul.host	`localhost`	Consul エージェントのホスト名。デフォルトは "localhost" です。
spring.cloud.consul.path		領事が非ルートにある場合のカスタムパス。
spring.cloud.consul.port	`8500`	Consul エージェントポート。デフォルトは "8500" です。
spring.cloud.consul.retry.enabled	`true`	領事の再試行が有効になっている場合。
spring.cloud.consul.retry.initial-interval	`1000`	ミリ秒単位の初期再試行間隔。
spring.cloud.consul.retry.max-attempts	`6`	最大試行回数。
spring.cloud.consul.retry.max-interval	`2000`	バックオフの最大間隔。
spring.cloud.consul.retry.multiplier	`1.1`	次の区間の乗数。
spring.cloud.consul.ribbon.enabled	`true`	Consul と Ribbon の統合を有効にします。
spring.cloud.consul.scheme		Consul エージェントスキーム（HTTP/HTTPS）。アドレスにスキームがない場合、クライアントは HTTP を使用します。
spring.cloud.consul.service-registry.auto-registration.enabled	`true`	Consul サービスレジストリの自動登録を有効にします。
spring.cloud.consul.service-registry.enabled	`true`	Consul サービスレジストリ機能を有効にします。
spring.cloud.consul.tls.certificate-password		証明書を開くためのパスワード。
spring.cloud.consul.tls.certificate-path		証明書へのファイルパス。
spring.cloud.consul.tls.key-store-instance-type		使用する主要なフレームワークの型。
spring.cloud.consul.tls.key-store-password		外部キーストアへのパスワード。
spring.cloud.consul.tls.key-store-path		外部キーストアへのパス。

spring.cloud.consul.config.acl-token

spring.cloud.consul.config.data-key

data

format が Format.PROPERTIES または Format.YAML の場合、次のフィールドは、構成について領事を検索するためのキーとして使用されます。

spring.cloud.consul.config.default-context

application

spring.cloud.consul.config.enabled

true

spring.cloud.consul.config.fail-fast

true

true の場合は構成ルックアップ中に例外をスローし、そうでない場合は警告をログに記録します。

spring.cloud.consul.config.format

key-value

spring.cloud.consul.config.name

領事 KV で値を検索する際に使用する spring.application.name の代替。

spring.cloud.consul.config.prefix

spring.cloud.consul.config.prefixes

spring.cloud.consul.config.profile-separator

,

spring.cloud.consul.config.watch.delay

1000

監視の固定遅延の値（ミリ単位）。デフォルトは 1000 です。

spring.cloud.consul.config.watch.enabled

true

監視が有効になっている場合。デフォルトは true です。

spring.cloud.consul.config.watch.wait-time

55

ウォッチクエリを待機（またはブロック）する秒数。デフォルトは 55 です。デフォルトの ConsulClient（デフォルトは 60）未満である必要があります。ConsulClient タイムアウトを増やすには、カスタム HttpClient を使用してカスタム ConsulRawClient を使用して ConsulClient Bean を作成します。

spring.cloud.consul.discovery.acl-token

spring.cloud.consul.discovery.catalog-services-watch-delay

1000

領事カタログを監視するための呼び出し間の遅延（ミリ単位）。デフォルトは 1000 です。

spring.cloud.consul.discovery.catalog-services-watch-timeout

2

領事カタログを見ながらブロックする秒数。デフォルトは 2 秒です。

spring.cloud.consul.discovery.consistency-mode

default

医療サービスリクエストの整合性モード。

spring.cloud.consul.discovery.datacenters

serviceId のマップ→ サーバーリストでクエリするデータセンター。これにより、別のデータセンターのサービスを検索できます。

spring.cloud.consul.discovery.default-query-tag

serverListQueryTags にリストされていない場合にサービスリストで照会するタグ。カンマ区切りの値で複数のタグを指定できます。

spring.cloud.consul.discovery.default-zone-metadata-name

zone

サービスインスタンスゾーンはメタデータから取得されます。これにより、メタデータタグ名を変更できます。

spring.cloud.consul.discovery.deregister

true

領事館でのサービスの自動登録解除を無効にします。

spring.cloud.consul.discovery.enable-tag-override

登録済みサービスのタグオーバーライドを有効にします。

spring.cloud.consul.discovery.enabled

true

サービスディスカバリは有効になっていますか？

spring.cloud.consul.discovery.fail-fast

true

true の場合、サービス登録中に例外をスローします。それ以外の場合は、警告をログに記録します（デフォルトは true）。

spring.cloud.consul.discovery.health-check-critical-timeout

タイムアウトよりも長い間重要なサービスの登録を解除するためのタイムアウト（例: 30m）。領事バージョン 7.x 以降が必要です。

spring.cloud.consul.discovery.health-check-headers

ヘルスチェック呼び出しに適用されるヘッダー。

spring.cloud.consul.discovery.health-check-interval

10s

ヘルスチェックを実行する頻度（例: 10 秒）。デフォルトは 10 秒です。

spring.cloud.consul.discovery.health-check-path

/actuator/health

ヘルスチェックのために呼び出す代替サーバーパス。

spring.cloud.consul.discovery.health-check-timeout

ヘルスチェックのタイムアウト（例: 10 秒）。

spring.cloud.consul.discovery.health-check-tls-skip-verify

true の場合、サービスチェック中に証明書の検証をスキップします。それ以外の場合は、証明書の検証を実行します。

spring.cloud.consul.discovery.health-check-url

デフォルトを上書きするカスタムヘルスチェック URL。

spring.cloud.consul.discovery.heartbeat.actuator-health-group

アクチュエーターを介してシステムの状態を判断するときに使用するアクチュエーターの状態グループ (ルートグループの場合は null)。

spring.cloud.consul.discovery.heartbeat.enabled

false

spring.cloud.consul.discovery.heartbeat.interval-ratio

spring.cloud.consul.discovery.heartbeat.reregister-service-on-failure

false

spring.cloud.consul.discovery.heartbeat.ttl

30s

spring.cloud.consul.discovery.heartbeat.use-actuator-health

true

アプリケーションの状態を Consul TTL チェックに報告するときに、現在のシステムの状態 (アクチュエーターの状態エンドポイントを介して報告される) を考慮するかどうか。Actuator Health エンドポイントもアプリケーションで利用できる必要があります。

spring.cloud.consul.discovery.hostname

サーバーにアクセスするときに使用するホスト名。

spring.cloud.consul.discovery.include-hostname-in-instance-id

false

サービスの登録時にホスト名がデフォルトのインスタンス ID に含まれるかどうか。

spring.cloud.consul.discovery.instance-group

サービスインスタンスグループ。

spring.cloud.consul.discovery.instance-id

一意のサービスインスタンス ID。

spring.cloud.consul.discovery.instance-zone

サービスインスタンスゾーン。

spring.cloud.consul.discovery.ip-address

サービスにアクセスするときに使用する IP アドレス（使用する preferIpAddress も設定する必要があります）。

spring.cloud.consul.discovery.lifecycle.enabled

true

spring.cloud.consul.discovery.management-enable-tag-override

登録された管理サービスのタグオーバーライドを有効にします。

spring.cloud.consul.discovery.management-metadata

管理サービスの登録時に使用するメタデータ。

spring.cloud.consul.discovery.management-port

管理サービスを登録するポート（デフォルトは管理ポート）。

spring.cloud.consul.discovery.management-suffix

management

管理サービスの登録時に使用するサフィックス。

spring.cloud.consul.discovery.management-tags

管理サービスの登録時に使用するタグ。

spring.cloud.consul.discovery.metadata

サービスの登録時に使用するメタデータ。

spring.cloud.consul.discovery.order

0

CompositeDiscoveryClient が利用可能なクライアントを並べ替えるために使用する検出クライアントの順序。

spring.cloud.consul.discovery.port

サービスを登録するポート（デフォルトはリスニングポート）。

spring.cloud.consul.discovery.prefer-agent-address

false

使用するアドレスを決定する方法のソース。

spring.cloud.consul.discovery.prefer-ip-address

false

登録時には、ホスト名ではなく IP アドレスを使用してください。

spring.cloud.consul.discovery.query-passing

false

/v1/health/service/serviceName に "passing" パラメーターを追加します。これにより、ヘルスチェックがサーバーにプッシュされます。

spring.cloud.consul.discovery.register

true

領事館にサービスとして登録します。

spring.cloud.consul.discovery.register-health-check

true

領事館にヘルス診断を登録してください。サービスの開発中に役立ちます。

spring.cloud.consul.discovery.scheme

http

http または https サービスを登録するかどうか。

spring.cloud.consul.discovery.server-list-query-tags

サーバーリストで照会する serviceId の → タグのマップ。これにより、1 つ以上のタグでサービスをフィルターできます。複数のタグは、コンマ区切りの値で指定できます。

spring.cloud.consul.discovery.service-name

サービス名。

spring.cloud.consul.discovery.tags

サービス登録時に使用するタグ。

spring.cloud.consul.enabled

true

Spring のクラウド領事は有効になっていますか？

spring.cloud.consul.host

localhost

Consul エージェントのホスト名。デフォルトは "localhost" です。

spring.cloud.consul.path

領事が非ルートにある場合のカスタムパス。

spring.cloud.consul.port

8500

Consul エージェントポート。デフォルトは "8500" です。

spring.cloud.consul.retry.enabled

true

領事の再試行が有効になっている場合。

spring.cloud.consul.retry.initial-interval

1000

ミリ秒単位の初期再試行間隔。

spring.cloud.consul.retry.max-attempts

6

最大試行回数。

spring.cloud.consul.retry.max-interval

2000

バックオフの最大間隔。

spring.cloud.consul.retry.multiplier

1.1

次の区間の乗数。

spring.cloud.consul.ribbon.enabled

true

Consul と Ribbon の統合を有効にします。

spring.cloud.consul.scheme

Consul エージェントスキーム（HTTP/HTTPS）。アドレスにスキームがない場合、クライアントは HTTP を使用します。

spring.cloud.consul.service-registry.auto-registration.enabled

true

Consul サービスレジストリの自動登録を有効にします。

spring.cloud.consul.service-registry.enabled

true

Consul サービスレジストリ機能を有効にします。

spring.cloud.consul.tls.certificate-password

証明書を開くためのパスワード。

spring.cloud.consul.tls.certificate-path

証明書へのファイルパス。

spring.cloud.consul.tls.key-store-instance-type

使用する主要なフレームワークの型。

spring.cloud.consul.tls.key-store-password

外部キーストアへのパスワード。

spring.cloud.consul.tls.key-store-path

外部キーストアへのパス。