Red Hat ビルドの OpenTelemetry への移行

手順

1. OpenTelemetry Collector をサイドカーとして設定します。

   apiVersion: opentelemetry.io/v1beta1
   kind: OpenTelemetryCollector
   metadata:
     name: otel
     namespace: <otel-collector-namespace>
   spec:
     mode: sidecar
     config:
       receivers:
         jaeger:
           protocols:
             grpc: {}
             thrift_binary: {}
             thrift_compact: {}
             thrift_http: {}
       processors:
         batch: {}
         memory_limiter:
           check_interval: 1s
           limit_percentage: 50
           spike_limit_percentage: 30
         resourcedetection:
           detectors: [openshift]
           timeout: 2s
       exporters:
         otlp:
           endpoint: "tempo-<example>-gateway:8090" 

   1

   
           tls:
             insecure: true
       service:
         pipelines:
           traces:
             receivers: [jaeger]
             processors: [memory_limiter, resourcedetection, batch]
             exporters: [otlp]

   Copy to Clipboard Toggle word wrap

   1

   このエンドポイントは、<example> Tempo Operator を使用してデプロイされた TempoStack インスタンスのゲートウェイを指します。

2. アプリケーションを実行するためのサービスアカウントを作成します。

   apiVersion: v1
   kind: ServiceAccount
   metadata:
     name: otel-collector-sidecar

   Copy to Clipboard Toggle word wrap

3. 一部のプロセッサーで必要な権限のためのクラスターロールを作成します。

   apiVersion: rbac.authorization.k8s.io/v1
   kind: ClusterRole
   metadata:
     name: otel-collector-sidecar
   rules:
     

   1

   
   - apiGroups: ["config.openshift.io"]
     resources: ["infrastructures", "infrastructures/status"]
     verbs: ["get", "watch", "list"]

   Copy to Clipboard Toggle word wrap

   1

   resourcedetectionprocessor には、インフラストラクチャーとインフラストラクチャー/ステータスに対する権限が必要です。

4. ClusterRoleBinding を作成して、サービスアカウントの権限を設定します。

   apiVersion: rbac.authorization.k8s.io/v1
   kind: ClusterRoleBinding
   metadata:
     name: otel-collector-sidecar
   subjects:
   - kind: ServiceAccount
     name: otel-collector-deployment
     namespace: otel-collector-example
   roleRef:
     kind: ClusterRole
     name: otel-collector
     apiGroup: rbac.authorization.k8s.io

   Copy to Clipboard Toggle word wrap
5. OpenTelemetry Collector をサイドカーとしてデプロイします。
6. Deployment オブジェクトから "sidecar.jaegertracing.io/inject": "true" アノテーションを削除することで、注入された Jaeger Agent をアプリケーションから削除します。
7. sidecar.opentelemetry.io/inject: "true" アノテーションを Deployment オブジェクトの .spec.template.metadata.annotations フィールドに追加して、OpenTelemetry サイドカーの自動注入を有効にします。
8. 作成したサービスアカウントをアプリケーションのデプロイメントに使用します。そうすることで、プロセッサーは正しい情報を取得してトレースに追加できます。

手順

1. OpenTelemetry Collector デプロイメントを設定します。

2. OpenTelemetry Collector のデプロイ先となるプロジェクトを作成します。

   apiVersion: project.openshift.io/v1
   kind: Project
   metadata:
     name: observability

   Copy to Clipboard Toggle word wrap

3. OpenTelemetry Collector インスタンスを実行するためのサービスアカウントを作成します。

   apiVersion: v1
   kind: ServiceAccount
   metadata:
     name: otel-collector-deployment
     namespace: observability

   Copy to Clipboard Toggle word wrap

4. プロセッサーに必要な権限を設定するためのクラスターロールを作成します。

   apiVersion: rbac.authorization.k8s.io/v1
   kind: ClusterRole
   metadata:
     name: otel-collector
   rules:
     

   1

   2

   
   - apiGroups: ["", "config.openshift.io"]
     resources: ["pods", "namespaces", "infrastructures", "infrastructures/status"]
     verbs: ["get", "watch", "list"]

   Copy to Clipboard Toggle word wrap

   1

   k8sattributesprocessor には、pods および namespace リソースに対する権限が必要です。

   2

   resourcedetectionprocessor には、infrastructures および infrastructures/status に対する権限が必要です。

5. ClusterRoleBinding を作成して、サービスアカウントの権限を設定します。

   apiVersion: rbac.authorization.k8s.io/v1
   kind: ClusterRoleBinding
   metadata:
     name: otel-collector
   subjects:
   - kind: ServiceAccount
     name: otel-collector-deployment
     namespace: observability
   roleRef:
     kind: ClusterRole
     name: otel-collector
     apiGroup: rbac.authorization.k8s.io

   Copy to Clipboard Toggle word wrap

6. OpenTelemetry Collector インスタンスを作成します。

   注記

   この Collector は、トレースを TempoStack インスタンスにエクスポートします。Red Hat Tempo Operator を使用して TempoStack インスタンスを作成し、正しいエンドポイントを配置する必要があります。

   apiVersion: opentelemetry.io/v1beta1
   kind: OpenTelemetryCollector
   metadata:
     name: otel
     namespace: observability
   spec:
     mode: deployment
     serviceAccount: otel-collector-deployment
     config:
       receivers:
         jaeger:
           protocols:
             grpc: {}
             thrift_binary: {}
             thrift_compact: {}
             thrift_http: {}
       processors:
         batch: {}
         k8sattributes: {}
         memory_limiter:
           check_interval: 1s
           limit_percentage: 50
           spike_limit_percentage: 30
         resourcedetection:
           detectors: [openshift]
       exporters:
         otlp:
           endpoint: "tempo-example-gateway:8090"
           tls:
             insecure: true
       service:
         pipelines:
           traces:
             receivers: [jaeger]
             processors: [memory_limiter, k8sattributes, resourcedetection, batch]
             exporters: [otlp]

   Copy to Clipboard Toggle word wrap
7. トレースエンドポイントを OpenTelemetry Operator に指定します。

8. トレースをアプリケーションから Jaeger に直接エクスポートする場合は、API エンドポイントを Jaeger エンドポイントから OpenTelemetry Collector エンドポイントに変更します。

   Golang を使用する jaegerexporter でトレースをエクスポートする場合の例

   exp, err := jaeger.New(jaeger.WithCollectorEndpoint(jaeger.WithEndpoint(url))) 

   1

   Copy to Clipboard Toggle word wrap

   1

   URL は OpenTelemetry Collector API エンドポイントを指します。