9.3. 分散トレースの設定

1. spec.template プロパティーで、トレーサーサービスを設定します。

   • トレーシング環境変数 をテンプレートの設定プロパティーとして使用します。
   • OpenTelemetry の場合、spec.tracing.type プロパティーを opentelemetry に設定します。
   • OpenTracing の場合、spec.tracing.type プロパティーを jaeger に設定します。

   OpenTelemetry を使用した Kafka Connect のトレース設定の例

   apiVersion: kafka.strimzi.io/v1beta2
   kind: KafkaConnect
   metadata:
     name: my-connect-cluster
   spec:
     #...
     template:
       connectContainer:
         env:
           - name: OTEL_SERVICE_NAME
             value: my-otel-service
           - name: OTEL_EXPORTER_JAEGER_ENDPOINT
             value: "http://jaeger-host:14250"
     tracing:
       type: opentelemetry
     #...

   OpenTelemetry を使用した MirrorMaker のトレース設定の例

   apiVersion: kafka.strimzi.io/v1beta2
   kind: KafkaMirrorMaker
   metadata:
     name: my-mirror-maker
   spec:
     #...
     template:
       mirrorMakerContainer:
         env:
           - name: OTEL_SERVICE_NAME
             value: my-otel-service
           - name: OTEL_EXPORTER_JAEGER_ENDPOINT
             value: "http://jaeger-host:14250"
     tracing:
       type: opentelemetry
   #...

   OpenTelemetry を使用した MirrorMaker 2.0 のトレース設定の例

   apiVersion: kafka.strimzi.io/v1beta2
   kind: KafkaMirrorMaker2
   metadata:
     name: my-mm2-cluster
   spec:
     #...
     template:
       connectContainer:
         env:
           - name: OTEL_SERVICE_NAME
             value: my-otel-service
           - name: OTEL_EXPORTER_JAEGER_ENDPOINT
             value: "http://jaeger-host:14250"
     tracing:
       type: opentelemetry
   #...

   OpenTelemetry を使用した Kafka Bridge のトレース設定の例

   apiVersion: kafka.strimzi.io/v1beta2
   kind: KafkaBridge
   metadata:
     name: my-bridge
   spec:
     #...
     template:
       bridgeContainer:
         env:
           - name: OTEL_SERVICE_NAME
             value: my-otel-service
           - name: OTEL_EXPORTER_JAEGER_ENDPOINT
             value: "http://jaeger-host:14250"
     tracing:
       type: opentelemetry
   #...

   OpenTracing を使用した Kafka Connect のトレース設定の例

   apiVersion: kafka.strimzi.io/v1beta2
   kind: KafkaConnect
   metadata:
     name: my-connect-cluster
   spec:
     #...
     template:
       connectContainer:
         env:
           - name: JAEGER_SERVICE_NAME
             value: my-jaeger-service
           - name: JAEGER_AGENT_HOST
             value: jaeger-agent-name
           - name: JAEGER_AGENT_PORT
             value: "6831"
     tracing:
       type: jaeger
     #...

   OpenTracing を使用した MirrorMaker のトレース設定の例

   apiVersion: kafka.strimzi.io/v1beta2
   kind: KafkaMirrorMaker
   metadata:
     name: my-mirror-maker
   spec:
     #...
     template:
       mirrorMakerContainer:
         env:
           - name: JAEGER_SERVICE_NAME
             value: my-jaeger-service
           - name: JAEGER_AGENT_HOST
             value: jaeger-agent-name
           - name: JAEGER_AGENT_PORT
             value: "6831"
     tracing:
       type: jaeger
   #...

   OpenTracing を使用した MirrorMaker 2.0 のトレース設定の例

   apiVersion: kafka.strimzi.io/v1beta2
   kind: KafkaMirrorMaker2
   metadata:
     name: my-mm2-cluster
   spec:
     #...
     template:
       connectContainer:
         env:
           - name: JAEGER_SERVICE_NAME
             value: my-jaeger-service
           - name: JAEGER_AGENT_HOST
             value: jaeger-agent-name
           - name: JAEGER_AGENT_PORT
             value: "6831"
     tracing:
       type: jaeger
   #...

   OpenTracing を使用した Kafka Bridge のトレース設定の例

   apiVersion: kafka.strimzi.io/v1beta2
   kind: KafkaBridge
   metadata:
     name: my-bridge
   spec:
     #...
     template:
       bridgeContainer:
         env:
           - name: JAEGER_SERVICE_NAME
             value: my-jaeger-service
           - name: JAEGER_AGENT_HOST
             value: jaeger-agent-name
           - name: JAEGER_AGENT_PORT
             value: "6831"
     tracing:
       type: jaeger
   #...

2. リソースを作成または更新します。

   oc apply -f <resource_configuration_file>

1. クライアントアプリケーションの pom.xml ファイルに Maven 依存関係を追加します。

   OpenTelemetry の依存関係

   <dependency>
       <groupId>io.opentelemetry</groupId>
       <artifactId>opentelemetry-sdk-extension-autoconfigure</artifactId>
       <version>1.18.0-alpha</version>
   </dependency>
   <dependency>
     <groupId>io.opentelemetry.instrumentation</groupId>
     <artifactId>opentelemetry-kafka-clients-{OpenTelemetryKafkaClient}</artifactId>
     <version>1.18.0-alpha</version>
   </dependency>
   <dependency>
     <groupId>io.opentelemetry</groupId>
     <artifactId>opentelemetry-exporter-jaeger</artifactId>
     <version>1.18.0</version>
   </dependency>

   OpenTracing の依存関係

   <dependency>
       <groupId>io.jaegertracing</groupId>
       <artifactId>jaeger-client</artifactId>
       <version>1.3.2</version>
   </dependency>
   <dependency>
     <groupId>io.opentracing.contrib</groupId>
     <artifactId>opentracing-kafka-client</artifactId>
     <version>0.1.15</version>
   </dependency>

2. トレース環境変数 を使用して、トレーサーの設定を定義します。

3. 環境変数で初期化されるトレーサーを作成します。

   OpenTelemetry のトレーサーの作成

   OpenTelemetry ot = GlobalOpenTelemetry.get();

   OpenTracing のトレーサーの作成

   Tracer tracer = Configuration.fromEnv().getTracer();

4. トレーサーをグローバルトレーサーとして登録します。

   GlobalTracer.register(tracer);

5. クライアントをインストルメント化します。

   • 「Kafka プロデューサーおよびコンシューマーをトレース用にインストルメント化」
   • 「Kafka Streams アプリケーションのトレース用のインストルメント化」

手順

1. トレースアーティファクトを AMQ Streams Kafka イメージの /opt/kafka/libs/ ディレクトリーに追加します。

   新しいカスタムイメージを作成するための基本イメージとして、Red Hat Ecosystem Catalog の Kafka コンテナーイメージを使用できます。

   Zipkin の OpenTelemetry アーティファクト

   io.opentelemetry:opentelemetry-exporter-zipkin

2. 新しいトレース実装のトレースエクスポーターとエンドポイントを設定します。

   Zikpin トレーサーの設定例

   apiVersion: kafka.strimzi.io/v1beta2
   kind: KafkaMirrorMaker2
   metadata:
     name: my-mm2-cluster
   spec:
     #...
     template:
       connectContainer:
         env:
           - name: OTEL_SERVICE_NAME
             value: my-zipkin-service
           - name: OTEL_EXPORTER_ZIPKIN_ENDPOINT
             value: http://zipkin-exporter-host-name:9411/api/v2/spans 

   1

   
           - name: OTEL_TRACES_EXPORTER
             value: zipkin 

   2

   
     tracing:
       type: opentelemetry
   #...

   1

   接続先の Zipkin エンドポイントを指定します。

   2

   Zipkin エクスポーター。