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

application.properties ファイル、application.yml ファイル、コマンドラインスイッチとして、さまざまなプロパティを指定したり環境別に切り替えたりできます。この付録では、一般的な Spring Cloud Sleuth プロパティの一覧と、使用する基になるクラスへの参照を提供します。なお、プロパティ名はバージョンアップ時に変更される場合があるため、使用している Spring Boot バージョンのドキュメントを参照してください。

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

spring.sleuth.async.configurer.enabled

true

デフォルトの AsyncConfigurer を有効にします。

spring.sleuth.async.enabled

true

トレース情報がスレッド間で渡されるように、非同期関連コンポーネントのインスツルメンテーションを有効にします。

spring.sleuth.async.ignored-beans

{@link java.util.concurrent.Executor} Bean 名のリスト。無視して、トレース表現でラップしないでください。

spring.sleuth.baggage.correlation-enabled

true

バゲッジコンテキストとロギングコンテキストの相関を有効にします。

spring.sleuth.baggage.correlation-fields

回線を介して伝播する必要があるフィールドのリスト。

spring.sleuth.baggage.local-fields

JVM プロセス内でアクセス可能である必要があるが、ネットワークを介して伝播されないフィールドのリスト。

spring.sleuth.baggage.remote-fields

回線上と同じインプロセスで参照されるフィールドのリスト。例: フィールド "x-vcap-request-id" は、プレフィックスを含めてそのまま設定されます。

spring.sleuth.baggage.tag-fields

自動的にタグになるフィールドのリスト。

spring.sleuth.batch.enabled

true

Spring Batch インストルメンテーションを有効にします。

spring.sleuth.cassandra.enabled

true

Cassandra インストルメンテーションを有効にします。

spring.sleuth.circuitbreaker.enabled

true

Spring Cloud CircuitBreaker インストルメンテーションを有効にします。

spring.sleuth.config.server.enabled

true

Spring Cloud Config サーバーインストルメンテーションを有効にします。

spring.sleuth.deployer.enabled

true

Spring Cloud Deployer インストルメンテーションを有効にします。

spring.sleuth.deployer.status-poll-delay

500

デプロイされたアプリケーションのステータスを取得するためのデフォルトのポーリング遅延。

spring.sleuth.enabled

true

spring.sleuth.feign.enabled

true

Feign を使用するときにスパン情報の伝播を有効にします。

spring.sleuth.feign.processor.enabled

true

トレース表現で FeignContext をラップするポストプロセッサーを有効にします。

spring.sleuth.function.enabled

true

Spring Cloud Function および Spring Cloud Function ベースのプロジェクト(Spring Cloud Stream など)のインストルメンテーションを有効にします。

spring.sleuth.grpc.enabled

true

GRPC を使用するときにスパン情報の伝播を有効にします。

spring.sleuth.http.enabled

true

HTTP サポートを有効にします。

spring.sleuth.integration.enabled

true

Spring Integration インストルメンテーションを有効にします。

spring.sleuth.integration.patterns

[!hystrixStreamOutput*, *, !channel*]

チャネル名が照合されるパターンの配列。@see org.springframework.integration.config.GlobalChannelInterceptor#patterns() デフォルトは、Hystrix Stream および関数 Stream チャネル名と一致しないチャネル名です。

spring.sleuth.integration.websockets.enabled

true

WebSockets のトレースを有効にします。

spring.sleuth.jdbc.datasource-proxy.enabled

true

データソースプロキシトレースを有効にする必要がありますか?

spring.sleuth.jdbc.datasource-proxy.json-format

false

クエリのログに json 出力を使用します。@see ProxyDataSourceBuilder#asJson()

spring.sleuth.jdbc.datasource-proxy.logging

クエリのログに使用するログ。

spring.sleuth.jdbc.datasource-proxy.multiline

true

クエリのログに複数行の出力を使用します。@see ProxyDataSourceBuilder#multiline()

spring.sleuth.jdbc.datasource-proxy.query.enable-logging

false

すべてのクエリをログに記録できるようにします。

spring.sleuth.jdbc.datasource-proxy.query.log-level

DEBUG

クエリロガーの重大度。

spring.sleuth.jdbc.datasource-proxy.query.logger-name

クエリロガーの名前。

spring.sleuth.jdbc.datasource-proxy.slow-query.enable-logging

false

ログへの低速クエリのログ記録を有効にします。

spring.sleuth.jdbc.datasource-proxy.slow-query.log-level

WARN

遅いクエリロガーの重大度。

spring.sleuth.jdbc.datasource-proxy.slow-query.logger-name

遅いクエリロガーの名前。

spring.sleuth.jdbc.datasource-proxy.slow-query.threshold

300

クエリが遅いと見なす秒数。

spring.sleuth.jdbc.enabled

true

JDBC インストルメンテーションを有効にします。

spring.sleuth.jdbc.excluded-data-source-bean-names

装飾されない DataSource Bean 名のリスト。

spring.sleuth.jdbc.includes

どの型のトレースを含めたいか。

spring.sleuth.jdbc.p6spy.custom-appender-class

使用するクラスファイル (logging=custom の場合のみ)。クラスは {@link com.p6spy.engine.spy.appender.FormattedLogger} を実装する必要があります。

spring.sleuth.jdbc.p6spy.enable-logging

false

JDBC イベントのログ記録を有効にします。

spring.sleuth.jdbc.p6spy.enabled

true

p6spy トレースを有効にする必要がありますか?

spring.sleuth.jdbc.p6spy.log-file

spy.log

使用するログファイルの名前(logging = file の場合のみ)。

spring.sleuth.jdbc.p6spy.log-filter.pattern

正規表現パターンを使用して、ログメッセージをフィルタリングします。一致したメッセージのみがログに記録されます。

spring.sleuth.jdbc.p6spy.log-format

カスタムログ形式。

spring.sleuth.jdbc.p6spy.logging

クエリのログに使用するログ。

spring.sleuth.jdbc.p6spy.multiline

true

複数行出力を有効にします。

spring.sleuth.jdbc.p6spy.tracing.include-parameter-values

false

有効な SQL 文字列( "?" を実数値に置き換えたもの)をトレースシステムに報告します。<p> 注この設定は、ログメッセージには影響しません。

spring.sleuth.kafka.enabled

true

Apache Kafka クライアントの計測を有効にします。

spring.sleuth.messaging.aspect.enabled

false

{@linkMessageMapping} 折り返しを有効にする必要があります。

spring.sleuth.messaging.enabled

false

メッセージングをオンにする必要があります。

spring.sleuth.messaging.jms.enabled

true

JMS のトレースを有効にします。

spring.sleuth.messaging.jms.remote-service-name

jms

JMS リモートサービス名。

spring.sleuth.messaging.kafka.enabled

true

Kafka のトレースを有効にします。

spring.sleuth.messaging.kafka.mapper.enabled

true

Kafka の DefaultKafkaHeaderMapper トレースを有効にします。

spring.sleuth.messaging.kafka.remote-service-name

kafka

Kafka リモートサービス名。

spring.sleuth.messaging.kafka.streams.enabled

false

Kafka ストリームをオンにする必要があります。

spring.sleuth.messaging.rabbit.enabled

true

RabbitMQ のトレースを有効にします。

spring.sleuth.messaging.rabbit.remote-service-name

rabbitmq

Rabbit リモートサービス名。

spring.sleuth.mongodb.enabled

true

MongoDb のトレースを有効にします。

spring.sleuth.mongodb.socket-address-span-customizer.enabled

false

Mongo スパンで SocketAddress 情報の設定を有効にします。

spring.sleuth.opentracing.enabled

true

OpenTracing サポートを有効にします。

spring.sleuth.propagation.type

コンテキスト伝播型のトレース。

spring.sleuth.quartz.enabled

true

Quartz のトレースを有効にします。

spring.sleuth.r2dbc.enabled

true

R2dbc インストルメンテーションを有効にします。

spring.sleuth.reactor.decorate-on-each

true

true が各演算子で装飾されると、パフォーマンスは低下しますが、ロギングには常に各演算子のトレースエントリが含まれます。最後の演算子で false を装飾すると、パフォーマンスは向上しますが、ロギングにトレースエントリが常に含まれるとは限りません。@deprecated は、{@ link SleuthReactorProperties#instrumentationType} を介して明示的な値を使用します

spring.sleuth.reactor.enabled

true

true の場合、リアクターの計測が有効になります。

spring.sleuth.reactor.instrumentation-type

spring.sleuth.reactor.netty.debug.enabled

false

WARNING: 慎重に使用すると、パフォーマンスに重大な問題が発生する可能性があります。Reactor Netty の追加の計測を有効にします。

spring.sleuth.redis.enabled

true

Redis を使用する場合は、スパン情報の伝播を有効にします。

spring.sleuth.redis.legacy.enabled

false

Brave を介してのみ機能する Redis のレガシートレースを有効にします。

spring.sleuth.redis.remote-service-name

redis

リモート Redis エンドポイントのサービス名。

spring.sleuth.rpc.enabled

true

RPC のトレースを有効にします。

spring.sleuth.rsocket.enabled

true

true の場合、rsocket のインストルメンテーションが有効になります。

spring.sleuth.rxjava.schedulers.hook.enabled

true

RxJavaSchedulersHook を介して RxJava のサポートを有効にします。

spring.sleuth.rxjava.schedulers.ignoredthreads

[HystrixMetricPoller, ^RxComputation.*$]

スパンがサンプリングされないスレッド名。

spring.sleuth.sampler.probability

サンプリングする必要があるリクエストの確率。例: 1.0-100% リクエストをサンプリングする必要があります。精度は整数のみです(つまり、トレースの 0.1% はサポートされていません)。

spring.sleuth.sampler.rate

10

1 秒あたりのレートは、サージ保護を可能にするため、トラフィックの少ないエンドポイントに適しています。例: エンドポイントが 1 秒あたり 50 を超えるリクエストを取得することを期待できない場合があります。トラフィックが突然急増し、1 秒あたり 5000 リクエストになった場合でも、1 秒あたり 50 トレースになります。逆に、10% のようなパーセンテージがある場合、同じサージが 1 秒あたり 500 トレースになり、ストレージがオーバーロードになる可能性があります。Amazon X-Ray には、この目的のためにレート制限されたサンプラー(Reservoir という名前)が含まれています。Brave は、{@ linkbrave.sampler.RateLimitingSampler} を介して同じアプローチを採用しています。

spring.sleuth.sampler.refresh.enabled

true

サンプラーのリフレッシュスコープを有効にします。

spring.sleuth.scheduled.enabled

true

{@link org.springframework.scheduling.annotation.Scheduled} のトレースを有効にします。

spring.sleuth.scheduled.skip-pattern

スキップする必要があるクラスの完全修飾名のパターン。

spring.sleuth.session.enabled

true

Spring Session インストルメンテーションを有効にします。

spring.sleuth.span-filter.additional-span-name-patterns-to-ignore

無視するスパン名の追加リスト。{@ link#spanNamePatternsToSkip} に追加されます。

spring.sleuth.span-filter.enabled

false

デフォルトの Sleuth ハンドラーメカニズムをオンにします。特定のスパンのエクスポートを無視する場合があります。

spring.sleuth.span-filter.span-name-patterns-to-skip

^catalogWatchTaskScheduler$

無視するスパン名のリスト。それらは外部システムに送信されません。

spring.sleuth.supports- 参加する

true

True は、トレースシステムがクライアントとサーバー間のスパン ID の共有をサポートしていることを意味します。

spring.sleuth.task.enabled

true

Spring Cloud Task インストルメンテーションを有効にします。

spring.sleuth.trace-id128

false

true の場合、64 ビットではなく 128 ビットのトレース ID を生成します。

spring.sleuth.tracer.mode

どのトレーサー実装を選択するかを設定します。

spring.sleuth.tx.enabled

true

Spring TX インストルメンテーションを有効にします。

spring.sleuth.vault.enabled

true

Spring Vault インストルメンテーションを有効にします。

spring.sleuth.web.additional-skip-pattern

トレースでスキップする必要がある URL の追加パターン。これは {@ linkSleuthWebProperties#skipPattern} に追加されます。

spring.sleuth.web.client.enabled

true

{@link org.springframework.web.client.RestTemplate} へのインターセプターの挿入を有効にします。

spring.sleuth.web.client.skip-pattern

クライアント側のトレースでスキップする必要がある URL のパターン。

spring.sleuth.web.enabled

true

true の場合、Web アプリケーションのインストルメンテーションが有効になります。

spring.sleuth.web.filter-order

0

トレースフィルターを登録する順序。

spring.sleuth.web.ignore-auto-configured-skip-patterns

false

true に設定すると、自動構成されたスキップパターンは無視されます。

spring.sleuth.web.servlet.enabled

true

サーブレットインストルメンテーションを有効にします。

spring.sleuth.web.skip-pattern

/api-docs.*|/swagger.*|.*\.png|.*\.css|.*\.js|.*\.html|/favicon.ico|/hystrix.stream

トレースでスキップする必要がある URL のパターン。

spring.sleuth.web.tomcat.enabled

true

Tomcat のトレースインスツルメンテーションを有効にします。

spring.sleuth.web.webclient.enabled

true

WebClient のトレースインスツルメンテーションを有効にします。

spring.zipkin.activemq.message-max-bytes

100000

ActiveMQ 経由で Zipkin に送信される、スパンを含む特定のメッセージの最大バイト数。

spring.zipkin.activemq.queue

zipkin

スパンが Zipkin に送信される ActiveMQ キューの名前。

spring.zipkin.api- パス

baseUrl (上記) にサフィックスとして追加する API パス。これは、New Relic などの他の監視ツールを使用する場合に適用されます。トレース API には API パスは必要ないため、構成で空白 ("") に設定できます。

spring.zipkin.base-url

http://localhost:9411/

zipkin クエリサーバーインスタンスの URL。Zipkin がサービス検出に登録されている場合は、Zipkin サーバーのサービス ID を指定することもできます (例: zipkinserver/ (英語) )。

spring.zipkin.check-timeout

1000

Zipkin の可用性チェックのタイムアウト (ミリ単位)。

spring.zipkin.compression.enabled

false

spring.zipkin.discovery-client-enabled

{@code false} に設定すると、{@ link ZipkinProperties#baseUrl} は常に URL として扱われます。

spring.zipkin.enabled

true

Zipkin へのスパンの送信を有効にします。

spring.zipkin.encoder

Zipkin に送信されるスパンのエンコーディング型。サーバーが最新でない場合は、{@link SpanBytesEncoder#JSON_V1} に設定します。

spring.zipkin.kafka.topic

zipkin

スパンを Zipkin に送信する必要がある Kafka トピックの名前。

spring.zipkin.locator.discovery.enabled

false

サービス検出を介したホスト名の検索の有効化。

spring.zipkin.message-timeout

1

保留中のスパンがバッチで Zipkin に送信されるまでのタイムアウト (秒単位)。

spring.zipkin.queued-max-spans

1000

報告されたスパンと送信されたスパンの最大バックログ。

spring.zipkin.rabbitmq.addresses

スパンを Zipkin に送信するために使用される RabbitMQ ブローカーのアドレス

spring.zipkin.rabbitmq.queue

zipkin

スパンを Zipkin に送信する RabbitMQ キューの名前。

spring.zipkin.sender.type

スパンを Zipkin に送信する手段。

spring.zipkin.service.name

HTTP 経由で Span が送信されたサービスの名前。Zipkin に表示されます。

1. Spring Cloud Sleuth スパン

以下に、Spring Cloud Sleuth によって作成されたすべてのスパンのリストを示します。

1.1. 新規または継続スパンのアノテーション

@NewSpan または @ContinueSpan アノテーションをラップするスパン。

スパン名  %s - %s が含まれているため、名前は動的であり、実行時に解決されます。

囲んでいるクラス org.springframework.cloud.sleuth.instrument.annotation.SleuthAnnotationSpan の完全修飾名

表 1: タグキー

名前

説明

class

メソッドに Sleuth アノテーションが付けられたクラス名。

method

Sleuth アノテーションが付けられたメソッド名。

表 2: イベント値

名前

説明

%s.after

@ContinueSpan または @NewSpan でアノテーションが付けられたメソッドを実行した後にアノテーションが付けられます。(名前には %s が含まれているため、最終的な値は実行時に解決されます)

%s.afterFailure

@ContinueSpan または @NewSpan でアノテーションが付けられたメソッドから例外をスローした後にアノテーションが付けられます。(名前には %s が含まれているため、最終的な値は実行時に解決されます)

%s.before

@ContinueSpan または @NewSpan でアノテーションが付けられたメソッドを実行する前にアノテーションが付けられます。(名前には %s が含まれているため、最終的な値は実行時に解決されます)

1.2. 非同期アノテーションスパン

@Async アノテーションをラップするスパン。既存のものを継続するか、現在のものがない場合は新しいものを作成します。

スパン名  %s - %s が含まれているため、名前は動的であり、実行時に解決されます。

囲んでいるクラス org.springframework.cloud.sleuth.instrument.async.SleuthAsyncSpan の完全修飾名

表 3: タグキー

名前

説明

class

メソッドに @Async アノテーションが付けられたクラス名。

method

@Async でアノテーションが付けられたメソッド名。

1.3. 非同期呼び出し可能スパン

Callable をインストルメント化する必要があるときはいつでも作成されるスパン。

スパン名  %s - %s が含まれているため、名前は動的であり、実行時に解決されます。

囲んでいるクラス org.springframework.cloud.sleuth.instrument.async.SleuthAsyncSpan の完全修飾名

1.4. 非同期実行可能スパン

Runnable をインストルメント化する必要があるときはいつでも作成されるスパン。

スパン名  %s - %s が含まれているため、名前は動的であり、実行時に解決されます。

囲んでいるクラス org.springframework.cloud.sleuth.instrument.async.SleuthAsyncSpan の完全修飾名

1.5. バッチジョブスパン

ジョブの実行を中心に作成されたスパン。

スパン名  %s - %s が含まれているため、名前は動的であり、実行時に解決されます。

囲んでいるクラス org.springframework.cloud.sleuth.instrument.batch.SleuthBatchSpan の完全修飾名

表 4: タグキー

名前

説明

batch.job.executionId

Spring Batch 実行の ID。

batch.job.instanceId

Spring Batch ジョブインスタンスの ID。

batch.job.name

Spring Batch ジョブの名前。

1.6. バッチステップスパン

ジョブの実行を中心に作成されたスパン。

スパン名  %s - %s が含まれているため、名前は動的であり、実行時に解決されます。

囲んでいるクラス org.springframework.cloud.sleuth.instrument.batch.SleuthBatchSpan の完全修飾名

表 5: タグキー

名前

説明

batch.job.executionId

Spring Batch 実行の ID。

batch.step.executionId

Spring Batch 実行の ID。

batch.step.name

Spring Batch ジョブの名前。

batch.step.type

Spring Batch ジョブの型。

1.7. Cassandra スパン

CqlSession の実行を中心に作成されたスパン。

スパン名  %s - %s が含まれているため、名前は動的であり、実行時に解決されます。

囲んでいるクラス org.springframework.cloud.sleuth.instrument.cassandra.SleuthCassandraSpan の完全修飾名

すべてのタグとイベントには、cassandra. プレフィックスを付ける必要があります。
表 6: タグキー

名前

説明

cassandra.cql

Cassandra CQL を含むタグ。

cassandra.keyspace

Cassandra キースペースの名前。

cassandra.node [%s] .error

指定されたノードで発生したエラーを含むタグ。(名前には %s が含まれているため、最終的な値は実行時に解決されます)

表 7: イベント値

名前

説明

cassandra.node.error

特定のノードでエラーが発生するたびに設定します。

cassandra.node.success

セッション処理が成功したときに設定します。

1.8. サーキットブレーカーの機能スパン

CircuitBreaker にフォールバックとして渡される関数をラップするときに作成されるスパン。

スパン名  %s - %s が含まれているため、名前は動的であり、実行時に解決されます。

囲んでいるクラス org.springframework.cloud.sleuth.instrument.circuitbreaker.SleuthCircuitBreakerSpan の完全修飾名

1.9. サーキットブレーカーサプライヤースパン

CircuitBreaker に渡されたサプライヤーをラップするときに作成されるスパン。

スパン名  %s - %s が含まれているため、名前は動的であり、実行時に解決されます。

囲んでいるクラス org.springframework.cloud.sleuth.instrument.circuitbreaker.SleuthCircuitBreakerSpan の完全修飾名

1.10. 構成スパン

EnvironmentRepository を中心に作成されたスパン。

スパン名  find.

囲んでいるクラス org.springframework.cloud.sleuth.instrument.config.SleuthConfigSpan の完全修飾名

表 8: タグキー

名前

説明

config.environment.class

EnvironmentRepository の実装。

config.environment.method

EnvironmentRepository で実行されるメソッド。

1.11. Deployer Deploy Span

アプリケーションのデプロイ時に作成されるスパン。

スパン名  deploy.

囲んでいるクラス org.springframework.cloud.sleuth.instrument.deployer.SleuthDeployerSpan の完全修飾名

表 9: タグキー

名前

説明

deployer.app.group

デプロイされたアプリケーションのグループ。

deployer.app.id

デプロイされたアプリケーションの ID。

deployer.app.name

デプロイされたアプリケーションの名前。

deployer.platform.cf.org

CloudFoundry 組織。

deployer.platform.cf.space

CloudFoundry スペース。

deployer.platform.cf.url

CloudFoundry APIURL。

deployer.platform.k8s.namespace

Kubernetes 名前空間。

deployer.platform.k8s.url

KubernetesAPI の URL。

deployer.platform.name

アプリがデプロイされているプラットフォームの名前。

表 10: イベント値

名前

説明

%s

デプロイヤーがデプロイされたアプリケーションの状態を変更したとき。(名前には %s が含まれているため、最終的な値は実行時に解決されます)

deployer.start

デプロイヤーがアプリケーションのデプロイを開始したとき。

1.12. Deployer Get Log Span

デプロイされたアプリケーションのログを要求するときに作成されるスパン。

スパン名  getLog.

囲んでいるクラス org.springframework.cloud.sleuth.instrument.deployer.SleuthDeployerSpan の完全修飾名

表 11: タグキー

名前

説明

deployer.app.group

デプロイされたアプリケーションのグループ。

deployer.app.id

デプロイされたアプリケーションの ID。

deployer.app.name

デプロイされたアプリケーションの名前。

deployer.platform.cf.org

CloudFoundry 組織。

deployer.platform.cf.space

CloudFoundry スペース。

deployer.platform.cf.url

CloudFoundry APIURL。

deployer.platform.k8s.namespace

Kubernetes 名前空間。

deployer.platform.k8s.url

KubernetesAPI の URL。

deployer.platform.name

アプリがデプロイされているプラットフォームの名前。

表 12: イベント値

名前

説明

%s

デプロイヤーがデプロイされたアプリケーションの状態を変更したとき。(名前には %s が含まれているため、最終的な値は実行時に解決されます)

deployer.start

デプロイヤーがアプリケーションのデプロイを開始したとき。

1.13. デプロイヤのスケールスパン

デプロイされたアプリケーションのログを要求するときに作成されるスパン。

スパン名  scale.

囲んでいるクラス org.springframework.cloud.sleuth.instrument.deployer.SleuthDeployerSpan の完全修飾名

表 13: タグキー

名前

説明

deployer.app.group

デプロイされたアプリケーションのグループ。

deployer.app.id

デプロイされたアプリケーションの ID。

deployer.app.name

デプロイされたアプリケーションの名前。

deployer.platform.cf.org

CloudFoundry 組織。

deployer.platform.cf.space

CloudFoundry スペース。

deployer.platform.cf.url

CloudFoundry APIURL。

deployer.platform.k8s.namespace

Kubernetes 名前空間。

deployer.platform.k8s.url

KubernetesAPI の URL。

deployer.platform.name

アプリがデプロイされているプラットフォームの名前。

deployer.scale.count

スケールカウント。

deployer.scale.deploymentId

スケールコマンドデプロイ ID。

表 14: イベント値

名前

説明

%s

デプロイヤーがデプロイされたアプリケーションの状態を変更したとき。(名前には %s が含まれているため、最終的な値は実行時に解決されます)

deployer.start

デプロイヤーがアプリケーションのデプロイを開始したとき。

1.14. デプロイヤステータススパン

デプロイされたアプリケーションのステータスを要求するときに作成されるスパン。

スパン名  statuses.

囲んでいるクラス org.springframework.cloud.sleuth.instrument.deployer.SleuthDeployerSpan の完全修飾名

表 15: タグキー

名前

説明

deployer.app.group

デプロイされたアプリケーションのグループ。

deployer.app.id

デプロイされたアプリケーションの ID。

deployer.app.name

デプロイされたアプリケーションの名前。

deployer.platform.cf.org

CloudFoundry 組織。

deployer.platform.cf.space

CloudFoundry スペース。

deployer.platform.cf.url

CloudFoundry APIURL。

deployer.platform.k8s.namespace

Kubernetes 名前空間。

deployer.platform.k8s.url

KubernetesAPI の URL。

deployer.platform.name

アプリがデプロイされているプラットフォームの名前。

表 16: イベント値

名前

説明

%s

デプロイヤーがデプロイされたアプリケーションの状態を変更したとき。(名前には %s が含まれているため、最終的な値は実行時に解決されます)

deployer.start

デプロイヤーがアプリケーションのデプロイを開始したとき。

1.15. デプロイヤステータススパン

デプロイされたアプリケーションのステータスを要求するときに作成されるスパン。

スパン名  status.

囲んでいるクラス org.springframework.cloud.sleuth.instrument.deployer.SleuthDeployerSpan の完全修飾名

表 17: タグキー

名前

説明

deployer.app.group

デプロイされたアプリケーションのグループ。

deployer.app.id

デプロイされたアプリケーションの ID。

deployer.app.name

デプロイされたアプリケーションの名前。

deployer.platform.cf.org

CloudFoundry 組織。

deployer.platform.cf.space

CloudFoundry スペース。

deployer.platform.cf.url

CloudFoundry APIURL。

deployer.platform.k8s.namespace

Kubernetes 名前空間。

deployer.platform.k8s.url

KubernetesAPI の URL。

deployer.platform.name

アプリがデプロイされているプラットフォームの名前。

表 18: イベント値

名前

説明

%s

デプロイヤーがデプロイされたアプリケーションの状態を変更したとき。(名前には %s が含まれているため、最終的な値は実行時に解決されます)

deployer.start

デプロイヤーがアプリケーションのデプロイを開始したとき。

1.16. Deployer Undeploy Span

アプリケーションのアンデプロイ時に作成されるスパン。

スパン名  undeploy.

囲んでいるクラス org.springframework.cloud.sleuth.instrument.deployer.SleuthDeployerSpan の完全修飾名

表 19: タグキー

名前

説明

deployer.app.group

デプロイされたアプリケーションのグループ。

deployer.app.id

デプロイされたアプリケーションの ID。

deployer.app.name

デプロイされたアプリケーションの名前。

deployer.platform.cf.org

CloudFoundry 組織。

deployer.platform.cf.space

CloudFoundry スペース。

deployer.platform.cf.url

CloudFoundry APIURL。

deployer.platform.k8s.namespace

Kubernetes 名前空間。

deployer.platform.k8s.url

KubernetesAPI の URL。

deployer.platform.name

アプリがデプロイされているプラットフォームの名前。

表 20: イベント値

名前

説明

%s

デプロイヤーがデプロイされたアプリケーションの状態を変更したとき。(名前には %s が含まれているため、最終的な値は実行時に解決されます)

deployer.start

デプロイヤーがアプリケーションのデプロイを開始したとき。

1.17. Jdbc 接続スパン

JDBC 接続が行われるときに作成されるスパン。

スパン名  connection.

囲んでいるクラス org.springframework.cloud.sleuth.instrument.jdbc.SleuthJdbcSpan の完全修飾名

すべてのタグとイベントには、jdbc. プレフィックスを付ける必要があります。
表 21: タグキー

名前

説明

jdbc.datasource.driver

JDBC データソースドライバーの名前。

jdbc.datasource.pool

JDBC データソースプールの名前。

1.18. Jdbc クエリスパン

JDBC クエリが実行されたときに作成されるスパン。

スパン名  %s - %s が含まれているため、名前は動的であり、実行時に解決されます。

囲んでいるクラス org.springframework.cloud.sleuth.instrument.jdbc.SleuthJdbcSpan の完全修飾名

すべてのタグとイベントには、jdbc. プレフィックスを付ける必要があります。
表 22: タグキー

名前

説明

jdbc.query

SQL クエリ値。

jdbc.row-count

SQL 行の数。

表 23: イベント値

名前

説明

jdbc.commit

トランザクションがコミットされたとき。

jdbc.rollback

トランザクションがロールバックされたとき。

1.19. Jdbc 結果セットスパン

JDBC 結果セットを操作するときに作成されるスパン。

スパン名  result-set.

囲んでいるクラス org.springframework.cloud.sleuth.instrument.jdbc.SleuthJdbcSpan の完全修飾名

すべてのタグとイベントには、jdbc. プレフィックスを付ける必要があります。
表 24: タグキー

名前

説明

jdbc.query

SQL クエリ値。

jdbc.row-count

SQL 行の数。

表 25: イベント値

名前

説明

jdbc.commit

トランザクションがコミットされたとき。

jdbc.rollback

トランザクションがロールバックされたとき。

1.20. Kafka コンシューマースパン

Kafka コンシューマー側で作成されたスパン。

スパン名  kafka.consume.

囲んでいるクラス org.springframework.cloud.sleuth.instrument.kafka.SleuthKafkaSpan の完全修飾名

すべてのタグとイベントには、kafka. プレフィックスを付ける必要があります。
表 26: タグキー

名前

説明

kafka.offset

Kafka オフセット番号。

kafka.partition

Kafka パーティション番号。

kafka.topic

Kafka トピックの名前。

1.21. メッセージスパン上の Kafka

MessageListener を使用する場合、Kafka コンシューマー側で作成されるスパン。

スパン名  kafka.on-message.

囲んでいるクラス org.springframework.cloud.sleuth.instrument.kafka.SleuthKafkaSpan の完全修飾名

すべてのタグとイベントには、kafka. プレフィックスを付ける必要があります。
表 27: タグキー

名前

説明

kafka.offset

Kafka オフセット番号。

kafka.partition

Kafka パーティション番号。

kafka.topic

Kafka トピックの名前。

1.22. Kafka プロデューサースパン

Kafka コンシューマー側で作成されたスパン。

スパン名  kafka.produce.

囲んでいるクラス org.springframework.cloud.sleuth.instrument.kafka.SleuthKafkaSpan の完全修飾名

すべてのタグとイベントには、kafka. プレフィックスを付ける必要があります。
表 28: タグキー

名前

説明

kafka.topic

Kafka トピックの名前。

1.23. メッセージングスパン

メッセージが送信または受信されたときに作成されるスパン。

スパン名  %s - %s が含まれているため、名前は動的であり、実行時に解決されます。

囲んでいるクラス org.springframework.cloud.sleuth.instrument.messaging.SleuthMessagingSpan の完全修飾名

表 29: タグキー

名前

説明

%s

ユーザーがカスタマイズオプションを介してキーを提供しました。(名前には %s が含まれているため、最終的な値は実行時に解決されます)

channel

Spring Integration チャネルの名前。

function.name

Spring Cloud Function 関数名の名前。

1.24. Mvc ハンドラーインターセプタースパン

HandlerInterceptor の周囲にまたがります。現在のスパンを継続してタグ付けします

スパン名  %s - %s が含まれているため、名前は動的であり、実行時に解決されます。

囲んでいるクラス org.springframework.cloud.sleuth.instrument.web.mvc.SleuthMvcSpan の完全修飾名

表 30: タグキー

名前

説明

mvc.controller.class

メソッドに @Scheduled アノテーションが付けられたクラス名。

mvc.controller.method

@Scheduled でアノテーションが付けられたメソッド名。

1.25. Quartz トリガースパン

トリガーが起動されてから完了するときに作成されるスパン。

スパン名  %s - %s が含まれているため、名前は動的であり、実行時に解決されます。

囲んでいるクラス org.springframework.cloud.sleuth.instrument.quartz.SleuthQuartzSpan の完全修飾名

表 31: タグキー

名前

説明

quartz.trigger

トリガーの名前。

1.26. R2dbc クエリスパン

Kafka コンシューマー側で作成されたスパン。

スパン名  query.

囲んでいるクラス org.springframework.cloud.sleuth.instrument.r2dbc.SleuthR2dbcSpan の完全修飾名

すべてのタグとイベントには、r2dbc. プレフィックスを付ける必要があります。
表 32: タグキー

名前

説明

r2dbc.connection

R2DBC 接続の名前。

r2dbc.query [%s]

R2DBC クエリの名前。(名前には %s が含まれているため、最終的な値は実行時に解決されます)

r2dbc.thread

R2DBC スレッドの名前。

1.27. Rsocket リクエスタースパン

RSocket レスポンダー側で作成されたスパン。

スパン名  %s - %s が含まれているため、名前は動的であり、実行時に解決されます。

囲んでいるクラス org.springframework.cloud.sleuth.instrument.rsocket.SleuthRSocketSpan の完全修飾名

すべてのタグとイベントには、rsocket. プレフィックスを付ける必要があります。
表 33: タグキー

名前

説明

rsocket.request-type

R2DBC スレッドの名前。

rsocket.route

RSocket ルートの名前。

1.28. Rsocket レスポンダースパン

RSocket レスポンダー側で作成されたスパン。

スパン名  %s - %s が含まれているため、名前は動的であり、実行時に解決されます。

囲んでいるクラス org.springframework.cloud.sleuth.instrument.rsocket.SleuthRSocketSpan の完全修飾名

1.29. RxJava トレースアクションスパン

RxJava をラップするスパン。

スパン名  rxjava.

囲んでいるクラス org.springframework.cloud.sleuth.instrument.rxjava.SleuthRxJavaSpan の完全修飾名

表 34: タグキー

名前

説明

thread

スレッドの名前。

1.30. スケジュールされたアノテーションスパン

アノテーション付きメソッドをラップするスパン。新しいスパンを作成するか、既存のスパンを継続します。

スパン名  %s - %s が含まれているため、名前は動的であり、実行時に解決されます。

囲んでいるクラス org.springframework.cloud.sleuth.instrument.scheduling.SleuthSchedulingSpan の完全修飾名

表 35: タグキー

名前

説明

class

メソッドに @Scheduled アノテーションが付けられたクラス名。

method

@Scheduled でアノテーションが付けられたメソッド名。

1.31. セキュリティコンテキストの変更

現在のスパン中に SecurityContextChangedEvent が発生したことを示します。

スパン名  Security Context Change.

囲んでいるクラス org.springframework.cloud.sleuth.instrument.security.SleuthSecuritySpan の完全修飾名

表 36: イベント値

名前

説明

認証が %s をクリアしました

認証オブジェクトが SecurityContext から削除されたときに作成されるイベント。(名前には %s が含まれているため、最終的な値は実行時に解決されます)

認証が %s に置き換わりました

SecurityContext で認証オブジェクトが新しいオブジェクトに置き換えられたときに作成されるイベント。(名前には %s が含まれているため、最終的な値は実行時に解決されます)

認証セット %s

認証オブジェクトが SecurityContext に追加されたときに作成されるイベント。(名前には %s が含まれているため、最終的な値は実行時に解決されます)

1.32. セッション作成スパン

新しいセッションを作成する必要があるときに作成されるスパン。

スパン名  session.create.

囲んでいるクラス org.springframework.cloud.sleuth.instrument.session.SleuthSessionSpan の完全修飾名

1.33. セッション削除スパン

セッションが削除されたときに作成されるスパン。

スパン名  session.delete.

囲んでいるクラス org.springframework.cloud.sleuth.instrument.session.SleuthSessionSpan の完全修飾名

1.34. セッション検索スパン

新しいセッションが検索されたときに作成されるスパン。

スパン名  session.find.

囲んでいるクラス org.springframework.cloud.sleuth.instrument.session.SleuthSessionSpan の完全修飾名

すべてのタグとイベントには、session. プレフィックスを付ける必要があります。
表 37: タグキー

名前

説明

session.index.name

1.35. セッション保存スパン

新しいセッションが保存されたときに作成されるスパン。

スパン名  session.save.

囲んでいるクラス org.springframework.cloud.sleuth.instrument.session.SleuthSessionSpan の完全修飾名

1.36. タスク実行リスナースパン

タスクのライフサイクル内で作成されたスパン。

スパン名  %s - %s が含まれているため、名前は動的であり、実行時に解決されます。

囲んでいるクラス org.springframework.cloud.sleuth.instrument.task.SleuthTaskSpan の完全修飾名

1.37. タスクランナースパン

タスクランナーの実行時に作成されるスパン。

スパン名  %s - %s が含まれているため、名前は動的であり、実行時に解決されます。

囲んでいるクラス org.springframework.cloud.sleuth.instrument.task.SleuthTaskSpan の完全修飾名

1.38. 送信スパン

以前のトランザクションがなかったときに作成されたスパン。存在する場合は、伝播が必要でない限り継続します。

スパン名  tx.

囲んでいるクラス org.springframework.cloud.sleuth.instrument.tx.SleuthTxSpan の完全修飾名

すべてのタグとイベントには、tx. プレフィックスを付ける必要があります。
表 38: タグキー

名前

説明

tx.isolation-level

トランザクション分離レベル。

tx.name

トランザクション名。

tx.propagation-level

トランザクション伝播レベル。

tx.read-only

トランザクションが読み取り専用かどうか。

tx.timeout

トランザクションタイムアウト。

tx.transaction-manager

TransactionManager の名前。

1.39. Web フィルタースパン

WebFilter の周囲にまたがります。現在のスパンを継続するか、新しいスパンを作成してタグを付けます

スパン名  %s - %s が含まれているため、名前は動的であり、実行時に解決されます。

囲んでいるクラス org.springframework.cloud.sleuth.instrument.web.SleuthWebSpan の完全修飾名

表 39: タグキー

名前

説明

http.status_code

レスポンスステータスコード。

mvc.controller.class

リクエストを処理しているクラスの名前。

mvc.controller.method

リクエストを処理しているメソッドの名前。