ホーム
製品
OpenShift Container Platform
4.10
Service Mesh
1.26. Jaeger 設定リファレンス

1.26. Jaeger 設定リファレンス

Service Mesh Operator は ServiceMeshControlPlane リソースをデプロイする際に、分散トレースのリソースを作成することもできます。Service Mesh は分散トレースに Jaeger を使用します。

重要

Jaeger は、FIPS 検証済みの暗号化モジュールを使用しません。

1.26.1. トレースの有効化および無効化
リンクのコピー

ServiceMeshControlPlane リソースでトレースタイプおよびサンプリングレートを指定して、分散トレースを有効にします。

デフォルトの all-in-one Jaeger パラメーター

apiVersion: maistra.io/v2
kind: ServiceMeshControlPlane
metadata:
  name: basic
spec:
  version: v2.4
  tracing:
    sampling: 100
    type: Jaeger

apiVersion: maistra.io/v2
kind: ServiceMeshControlPlane
metadata:
  name: basic
spec:
  version: v2.4
  tracing:
    sampling: 100
    type: Jaeger

Copy to Clipboard

Toggle word wrap

現在、サポートされるトレーサーの唯一のタイプは Jaeger です。

Jaeger はデフォルトで有効になっています。トレースを無効にするには、type を None に設定します。

サンプリングレートは、Envoy プロキシーがトレースを生成する頻度を決定します。サンプリングレートオプションを使用して、トレースシステムに報告される要求の割合を制御できます。この設定は、メッシュ内のトラフィックおよび収集するトレースデータ量に基づいて設定できます。sampling は 0.01% の増分を表すスケーリングされた整数として設定します。たとえば、値を 10 サンプル (0.1% トレース)、および 500 サンプル (5% トレース)、および 10000 サンプル (100% トレース) に設定します。

注記

SMCP サンプリング設定オプションは Envoy サンプリングレートを制御します。Jaeger トレースサンプリングレートを Jaeger カスタムリソースで設定します。

1.26.2. SMCP での Jaeger 設定の指定
リンクのコピー

Jaeger は、ServiceMeshControlPlane リソースの addons セクションで設定します。ただし、SMCP で設定可能な内容にはいくつかの制限があります。

SMCP が設定情報を Red Hat OpenShift 分散トレースプラットフォーム Operator に渡すと、allInOne、production、または streaming の 3 つのデプロイメントストラテジーのいずれかがトリガーされます。

1.26.3. 分散トレースプラットフォームのデプロイ
リンクのコピー

分散トレースプラットフォームには、事前に定義されたデプロイメントストラテジーがあります。Jaeger カスタムリソース (CR) ファイルでデプロイメントストラテジーを指定します。分散トレースプラットフォームインスタンスの作成時に、Red Hat OpenShift 分散トレースプラットフォーム Operator はこの設定ファイルを使用してデプロイメントに必要なオブジェクトを作成します。

Red Hat OpenShift 分散トレースプラットフォーム Operator は現時点で以下のデプロイメントストラテジーをサポートします。

allInOne (デフォルト): このストラテジーは、開発、テスト、およびデモを目的としたものであり、実稼働での使用を目的としたものではありません。主なバックエンドコンポーネントである Agent、Collector、および Query サービスはすべて、インメモリーストレージを使用するように (デフォルトで) 設定された単一の実行可能ファイルにパッケージ化されます。このデプロイメントストラテジーは、SMCP で設定できます。
注記
インメモリーストレージには永続性がありません。つまり、Jaeger インスタンスがシャットダウンするか、再起動するか、置き換えられると、トレースデータが失われます。各 Pod には独自のメモリーがあるため、インメモリーストレージはスケーリングできません。永続ストレージの場合は、デフォルトのストレージとして Elasticsearch を使用する production または streaming ストラテジーを使用する必要があります。
production: production ストラテジーは、実稼働環境向けのストラテジーであり、トレースデータの長期の保存が重要となり、より拡張性および高可用性のあるアーキテクチャーも必要になります。そのため、バックエンドの各コンポーネントは別々にデプロイされます。エージェントは、インストルメント化されたアプリケーションのサイドカーとして挿入できます。Query および Collector サービスは、サポートされているストレージタイプ (現時点では Elasticsearch) で設定されます。これらの各コンポーネントの複数のインスタンスは、パフォーマンスと回復性を確保するために、必要に応じてプロビジョニングできます。このデプロイメントストラテジーを SMCP に設定できますが、完全にカスタマイズするには、Jaeger CR で設定を指定し、SMCP にリンクする必要があります。
streaming: streaming ストラテジーは、Collector と Elasticsearch バックエンドストレージ間に配置されるストリーミング機能を提供することで、production ストラテジーを増強する目的で設計されています。これにより、負荷の高い状況でバックエンドストレージに加わる圧力を軽減し、他のトレース処理後の機能がストリーミングプラットフォーム (AMQ Streams/ Kafka) から直接リアルタイムのスパンデータを利用できるようにします。このデプロイメントストラテジーを SMCP で設定することはできません。Jaeger CR を設定し、SMCP へのリンクを設定する必要があります。

注記

streaming ストラテジーには、AMQ Streams 用の追加の Red Hat サブスクリプションが必要です。

1.26.3.1. デフォルトの分散トレースプラットフォームのデプロイ
リンクのコピー

Jaeger 設定オプションを指定しない場合、ServiceMeshControlPlane リソースはデフォルトで allInOne Jaeger デプロイメントストラテジーを使用します。デフォルトの allInOne デプロイメントストラテジーを使用する場合は、spec.addons.jaeger.install.storage.type を Memory に設定します。デフォルトを使用するか、install で追加設定オプションを許可できます。

コントロールプレーンのデフォルト Jaeger パラメーター (Memory)

apiVersion: maistra.io/v2
kind: ServiceMeshControlPlane
metadata:
  name: basic
spec:
  version: v2.4
  tracing:
    sampling: 10000
    type: Jaeger
  addons:
    jaeger:
      name: jaeger
      install:
        storage:
          type: Memory

apiVersion: maistra.io/v2
kind: ServiceMeshControlPlane
metadata:
  name: basic
spec:
  version: v2.4
  tracing:
    sampling: 10000
    type: Jaeger
  addons:
    jaeger:
      name: jaeger
      install:
        storage:
          type: Memory

Copy to Clipboard

Toggle word wrap

1.26.3.2. 分散トレースプラットフォームの実稼働デプロイメント (最小)
リンクのコピー

production デプロイメントストラテジーのデフォルト設定を使用するには、spec.addons.jaeger.install.storage.type を Elasticsearch に設定し、install で追加設定オプションを指定します。SMCP は Elasticsearch リソースおよびイメージ名の設定のみをサポートすることに注意してください。

コントロールプレーンのデフォルト Jaeger パラメーター (Elasticsearch)

apiVersion: maistra.io/v2
kind: ServiceMeshControlPlane
metadata:
  name: basic
spec:
  version: v2.4
  tracing:
    sampling: 10000
    type: Jaeger
  addons:
    jaeger:
      name: jaeger  #name of Jaeger CR
      install:
        storage:
          type: Elasticsearch
        ingress:
          enabled: true
  runtime:
    components:
      tracing.jaeger.elasticsearch: # only supports resources and image name
        container:
          resources: {}

apiVersion: maistra.io/v2
kind: ServiceMeshControlPlane
metadata:
  name: basic
spec:
  version: v2.4
  tracing:
    sampling: 10000
    type: Jaeger
  addons:
    jaeger:
      name: jaeger  #name of Jaeger CR
      install:
        storage:
          type: Elasticsearch
        ingress:
          enabled: true
  runtime:
    components:
      tracing.jaeger.elasticsearch: # only supports resources and image name
        container:
          resources: {}

Copy to Clipboard

Toggle word wrap

1.26.3.3. 分散トレースプラットフォームの実稼働デプロイメント (完全にカスタマイズ)
リンクのコピー

SMCP は最小限の Elasticsearch パラメーターのみをサポートします。実稼働環境を完全にカスタマイズし、すべての Elasticsearch 設定パラメーターにアクセスするには、Jaeger カスタムリソース (CR) を使用して Jaeger を設定します。

または、Jaeger インスタンスを作成および設定し、spec.addons.jaeger.name を Jaeger インスタンスの名前 (この例では MyJaegerInstance) に設定できます。

Jaeger production CR がリンクされたコントロールプレーン

apiVersion: maistra.io/v2
kind: ServiceMeshControlPlane
metadata:
  name: basic
spec:
  version: v2.4
  tracing:
    sampling: 1000
    type: Jaeger
  addons:
    jaeger:
      name: MyJaegerInstance #name of Jaeger CR
      install:
        storage:
          type: Elasticsearch
        ingress:
          enabled: true

apiVersion: maistra.io/v2
kind: ServiceMeshControlPlane
metadata:
  name: basic
spec:
  version: v2.4
  tracing:
    sampling: 1000
    type: Jaeger
  addons:
    jaeger:
      name: MyJaegerInstance #name of Jaeger CR
      install:
        storage:
          type: Elasticsearch
        ingress:
          enabled: true

Copy to Clipboard

Toggle word wrap

1.26.3.4. Jaeger デプロイメントのストリーミング
リンクのコピー

streaming デプロイメントストラテジーを使用するには、まず Jaeger インスタンスを作成および設定してから、spec.addons.jaeger.name を Jaeger インスタンスの名前 (この例では MyJaegerInstance) に設定します。

リンクされた Jaeger ストリーミング CR を使用したコントロールプレーン

apiVersion: maistra.io/v2
kind: ServiceMeshControlPlane
metadata:
  name: basic
spec:
  version: v2.4
  tracing:
    sampling: 1000
    type: Jaeger
  addons:
    jaeger:
      name: MyJaegerInstance  #name of Jaeger CR

apiVersion: maistra.io/v2
kind: ServiceMeshControlPlane
metadata:
  name: basic
spec:
  version: v2.4
  tracing:
    sampling: 1000
    type: Jaeger
  addons:
    jaeger:
      name: MyJaegerInstance  #name of Jaeger CR

Copy to Clipboard

Toggle word wrap

1.26.4. Jaeger カスタムリソースでの Jaeger 設定の指定
リンクのコピー

ServiceMeshControlPlane (SMCP) リソースではなく Jaeger カスタムリソース (CR) に Jaeger を設定し、Jaeger デプロイメントを完全にカスタマイズできます。この設定は SMCP の外部に指定されているため、外部 Jaeger と呼ばれることもあります。

注記

SMCP と Jaeger CR を同じ namespace にデプロイする必要があります。たとえば、istio-system です。

スタンドアロンの Jaeger インスタンスを設定し、デプロイしてから、Jaeger リソースの name を、SMCP リソースの spec.addons.jaeger.name の値として指定できます。name の値に一致する Jaeger CR が存在する場合、Service Mesh コントロールプレーンは既存のインストールを使用します。この方法では、Jaeger 設定を完全にカスタマイズできます。

1.26.4.1. デプロイメントのベストプラクティス
リンクのコピー

Red Hat OpenShift 分散トレースインスタンスの名前は一意でなければなりません。複数の Red Hat OpenShift 分散トレースプラットフォームインスタンスがあり、サイドカーが挿入されたエージェントを使用している場合、Red Hat OpenShift 分散トレースプラットフォームインスタンスには一意の名前が必要となり、挿入 (injection) のアノテーションはトレースデータを報告する必要のある Red Hat OpenShift 分散トレースプラットフォームインスタンスの名前を明示的に指定する必要があります。
マルチテナントの実装があり、テナントが namespace で分離されている場合は、Red Hat OpenShift 分散トレースプラットフォームインスタンスを各テナント namespace にデプロイします。
- デーモンセットとしてのエージェントは、マルチテナントインストールまたは Red Hat OpenShift Dedicated ではサポートされません。サイドカーとしてのエージェントは、これらのユースケースでサポートされる唯一の設定です。
Red Hat OpenShift Service Mesh の一部として分散トレースをインストールする場合、分散トレースリソースは、ServiceMeshControlPlane リソースと同じ namespace にインストールする必要があります。

永続ストレージの設定は、永続ストレージについてと、選択したストレージオプションに適した設定トピックを参照してください。

1.26.4.2. サービスメッシュの分散トレースセキュリティーの設定
リンクのコピー

分散トレーシングプラットフォームは、デフォルトの認証に OAuth を使用します。ただし、Red Hat OpenShift Service Mesh は htpasswd と呼ばれるシークレットを使用して、Grafana、Kiali、分散トレーシングプラットフォームなどの依存サービス間の通信を容易にします。ServiceMeshControlPlane で分散トレーシングプラットフォームを設定すると、Service Mesh は htpasswd を使用するようにセキュリティー設定を自動的に設定します。

Jaeger カスタムリソースで分散トレースプラットフォーム設定を指定している場合は、htpasswd 設定を手動で設定し、htpasswd シークレットが Jaeger インスタンスにマウントされていることを確認して、Kiali が Jaeger インスタンスと通信できるようにする必要があります。

1.26.4.2.1. OpenShift コンソールからのサービスメッシュの分散トレースセキュリティー設定
リンクのコピー

Jaeger リソースを変更して、OpenShift コンソールの Service Mesh で使用する分散トレースプラットフォームセキュリティーを設定できます。

前提条件

cluster-admin ロールを持つユーザーとしてクラスターにアクセスできる。(Red Hat OpenShift Dedicated を使用する場合) dedicated-admin ロールがあるアカウント。
Red Hat OpenShift Service Mesh Operator がインストールされている必要がある。
クラスターにデプロイされた ServiceMeshControlPlane。
OpenShift Container Platform Web コンソールにアクセスできる。

手順

cluster-admin ロールを持つユーザーとして OpenShift Container Platform Web コンソールにログインします。
Operators Installed Operators の順に移動します。
Project メニューをクリックし、一覧から ServiceMeshControlPlane リソースがデプロイされているプロジェクト (例: istio-system) を選択します。
Red Hat OpenShift distributed tracing platform Operator をクリックします。
Operator の詳細 ページで、Jaeger タブをクリックします。
Jaeger インスタンスの名前をクリックします。
Jaeger の詳細ページで、YAML タブをクリックして設定を変更します。

次の例に示すように、Jaeger カスタムリソースファイルを編集して、htpasswd 設定を追加します。

spec.ingress.openshift.htpasswdFile
spec.volumes

spec.volumeMounts

htpasswd 設定を示す Jaeger リソースの例

apiVersion: jaegertracing.io/v1
kind: Jaeger
spec:
  ingress:
    enabled: true
    openshift:
      htpasswdFile: /etc/proxy/htpasswd/auth
      sar: '{"namespace": "istio-system", "resource": "pods", "verb": "get"}'
    options: {}
    resources: {}
    security: oauth-proxy
  volumes:
    - name: secret-htpasswd
      secret:
        secretName: htpasswd
    - configMap:
        defaultMode: 420
        items:
          - key: ca-bundle.crt
            path: tls-ca-bundle.pem
        name: trusted-ca-bundle
        optional: true
      name: trusted-ca-bundle
  volumeMounts:
    - mountPath: /etc/proxy/htpasswd
      name: secret-htpasswd
    - mountPath: /etc/pki/ca-trust/extracted/pem/
      name: trusted-ca-bundle
      readOnly: true

apiVersion: jaegertracing.io/v1
kind: Jaeger
spec:
  ingress:
    enabled: true
    openshift:
      htpasswdFile: /etc/proxy/htpasswd/auth
      sar: '{"namespace": "istio-system", "resource": "pods", "verb": "get"}'
    options: {}
    resources: {}
    security: oauth-proxy
  volumes:
    - name: secret-htpasswd
      secret:
        secretName: htpasswd
    - configMap:
        defaultMode: 420
        items:
          - key: ca-bundle.crt
            path: tls-ca-bundle.pem
        name: trusted-ca-bundle
        optional: true
      name: trusted-ca-bundle
  volumeMounts:
    - mountPath: /etc/proxy/htpasswd
      name: secret-htpasswd
    - mountPath: /etc/pki/ca-trust/extracted/pem/
      name: trusted-ca-bundle
      readOnly: true

Copy to Clipboard

Toggle word wrap

Save をクリックします。

1.26.4.2.2. コマンドラインからのサービスメッシュの分散トレースセキュリティーの設定
リンクのコピー

Jaeger リソースを変更して、oc ユーティリティーを使用してコマンドラインから Service Mesh で使用する分散トレースプラットフォームセキュリティーを設定できます。

前提条件

cluster-admin ロールを持つユーザーとしてクラスターにアクセスできる。(Red Hat OpenShift Dedicated を使用する場合) dedicated-admin ロールがあるアカウント。
Red Hat OpenShift Service Mesh Operator がインストールされている必要がある。
クラスターにデプロイされた ServiceMeshControlPlane。
OpenShift Container Platform バージョンに一致する OpenShift CLI (oc) にアクセスできる。

手順

cluster-admin ロールを持つユーザーとして OpenShift Container Platform CLI にログインします。(Red Hat OpenShift Dedicated を使用する場合) dedicated-admin ロールがあるアカウント。
```
oc login https://<HOSTNAME>:6443
```
```
$ oc login https://<HOSTNAME>:6443
```
Copy to Clipboard Toggle word wrap
次のコマンドを入力して、コントロールプレーンをインストールしたプロジェクト (istio-system など) に変更します。
```
oc project istio-system
```
```
$ oc project istio-system
```
Copy to Clipboard Toggle word wrap
次のコマンドを実行して Jaeger カスタムリソースファイルを編集します。ここで、jaeger.yaml は Jaeger カスタムリソースの名前に置き換えます。
```
oc edit -n tracing-system -f jaeger.yaml
```
```
$ oc edit -n tracing-system -f jaeger.yaml
```
Copy to Clipboard Toggle word wrap

次の例に示すように、Jaeger カスタムリソースファイルを編集して、htpasswd 設定を追加します。

spec.ingress.openshift.htpasswdFile
spec.volumes

spec.volumeMounts

htpasswd 設定を示す Jaeger リソースの例

apiVersion: jaegertracing.io/v1
kind: Jaeger
spec:
  ingress:
    enabled: true
    openshift:
      htpasswdFile: /etc/proxy/htpasswd/auth
      sar: '{"namespace": "istio-system", "resource": "pods", "verb": "get"}'
    options: {}
    resources: {}
    security: oauth-proxy
  volumes:
    - name: secret-htpasswd
      secret:
        secretName: htpasswd
    - configMap:
        defaultMode: 420
        items:
          - key: ca-bundle.crt
            path: tls-ca-bundle.pem
        name: trusted-ca-bundle
        optional: true
      name: trusted-ca-bundle
  volumeMounts:
    - mountPath: /etc/proxy/htpasswd
      name: secret-htpasswd
    - mountPath: /etc/pki/ca-trust/extracted/pem/
      name: trusted-ca-bundle
      readOnly: true

apiVersion: jaegertracing.io/v1
kind: Jaeger
spec:
  ingress:
    enabled: true
    openshift:
      htpasswdFile: /etc/proxy/htpasswd/auth
      sar: '{"namespace": "istio-system", "resource": "pods", "verb": "get"}'
    options: {}
    resources: {}
    security: oauth-proxy
  volumes:
    - name: secret-htpasswd
      secret:
        secretName: htpasswd
    - configMap:
        defaultMode: 420
        items:
          - key: ca-bundle.crt
            path: tls-ca-bundle.pem
        name: trusted-ca-bundle
        optional: true
      name: trusted-ca-bundle
  volumeMounts:
    - mountPath: /etc/proxy/htpasswd
      name: secret-htpasswd
    - mountPath: /etc/pki/ca-trust/extracted/pem/
      name: trusted-ca-bundle
      readOnly: true

Copy to Clipboard

Toggle word wrap

以下のコマンドを実行して変更を適用します。ここで、<jaeger.yaml> は Jaeger カスタムリソースの名前に置き換えます。
```
oc apply -n tracing-system -f <jaeger.yaml>
```
```
$ oc apply -n tracing-system -f <jaeger.yaml>
```
Copy to Clipboard Toggle word wrap
Pod のデプロイメントの進行状況を監視するには、次のコマンドを実行します。
```
oc get pods -n tracing-system -w
```
```
$ oc get pods -n tracing-system -w
```
Copy to Clipboard Toggle word wrap

1.26.4.3. 分散トレースのデフォルト設定オプション
リンクのコピー

Jaeger カスタムリソース (CR) は、分散トレースプラットフォームリソースの作成時に使用されるアーキテクチャーおよび設定を定義します。これらのパラメーターを変更して、分散トレースプラットフォームの実装をビジネスニーズに合わせてカスタマイズできます。

Jaeger 汎用 YAML の例

apiVersion: jaegertracing.io/v1
kind: Jaeger
metadata:
  name: name
spec:
  strategy: <deployment_strategy>
  allInOne:
    options: {}
    resources: {}
  agent:
    options: {}
    resources: {}
  collector:
    options: {}
    resources: {}
  sampling:
    options: {}
  storage:
    type:
    options: {}
  query:
    options: {}
    resources: {}
  ingester:
    options: {}
    resources: {}
  options: {}

apiVersion: jaegertracing.io/v1
kind: Jaeger
metadata:
  name: name
spec:
  strategy: <deployment_strategy>
  allInOne:
    options: {}
    resources: {}
  agent:
    options: {}
    resources: {}
  collector:
    options: {}
    resources: {}
  sampling:
    options: {}
  storage:
    type:
    options: {}
  query:
    options: {}
    resources: {}
  ingester:
    options: {}
    resources: {}
  options: {}

Copy to Clipboard

Toggle word wrap

Expand

表1.39 Jaeger パラメーター
パラメーター	説明	値	デフォルト値
`apiVersion:`		オブジェクトの作成時に使用する API バージョン。	`jaegertracing.io/v1`
`jaegertracing.io/v1`	`kind:`	作成する Kubernetes オブジェクトの種類を定義します。	`jaeger`
	`metadata:`	`name` 文字列、`UID`、およびオプションの `namespace` などのオブジェクトを一意に特定するのに役立つデータ。
OpenShift Container Platform は `UID` を自動的に生成し、オブジェクトが作成されるプロジェクトの名前で `namespace` を完了します。	`name:`	オブジェクトの名前。	分散トレースプラットフォームインスタンスの名前。
`jaeger-all-in-one-inmemory`	`spec:`	作成するオブジェクトの仕様。	分散トレースプラットフォームインスタンスのすべての設定パラメーターが含まれます。すべての Jaeger コンポーネントの共通定義が必要な場合、これは `spec` ノードで定義されます。定義が個々のコンポーネントに関連する場合は、`spec/<component>` ノードに置かれます。
該当なし	`strategy:`	Jaeger デプロイメントストラテジー	`allInOne`、`production`、または `streaming`
`allInOne`	`allInOne:`	`allInOne` イメージは Agent、Collector、Query、Ingester、および Jaeger UI を単一 Pod にデプロイするため、このデプロイメントの設定は、コンポーネント設定を `allInOne` パラメーターの下でネストする必要があります。
	`agent:`	Agent を定義する設定オプション。
	`collector:`	Jaeger Collector を定義する設定オプション。
	`sampling:`	トレース用のサンプリングストラテジーを定義する設定オプション。
	`storage:`	ストレージを定義する設定オプション。すべてのストレージ関連のオプションは、`allInOne` または他のコンポーネントオプションではなく、`storage` に配置される必要があります。
	`query:`	Query サービスを定義する設定オプション。
	`ingester:`	Ingester サービスを定義する設定オプション。

以下の YAML の例は、デフォルト設定を使用して Red Hat OpenShift 分散トレースプラットフォームのデプロイメントを作成するために最低限必要なものです。

最小限必要な dist-tracing-all-in-one.yaml の例

apiVersion: jaegertracing.io/v1
kind: Jaeger
metadata:
  name: jaeger-all-in-one-inmemory

apiVersion: jaegertracing.io/v1
kind: Jaeger
metadata:
  name: jaeger-all-in-one-inmemory

Copy to Clipboard

Toggle word wrap

1.26.4.4. Jaeger Collector 設定オプション
リンクのコピー

Jaeger Collector は、トレーサーによってキャプチャーされたスパンを受信し、production ストラテジーを使用する場合はそれらを永続 Elasticsearch ストレージに書き込み、streaming ストラテジーを使用する場合は AMQ Streams に書き込むコンポーネントです。

Collector はステートレスであるため、Jaeger Collector のインスタンスの多くは並行して実行できます。Elasticsearch クラスターの場所を除き、Collector では設定がほとんど必要ありません。

Expand

表1.40 Operator によって使用される Jaeger Collector パラメーターを定義するためのパラメーター
パラメーター	説明	値
`collector: replicas:` Copy to Clipboard Toggle word wrap	作成する Collector レプリカの数を指定します。	整数 (例: `5`)。

Expand

表1.41 Collector に渡される設定パラメーター
パラメーター	説明	値
`spec: collector: options: {}` Copy to Clipboard Toggle word wrap	Jaeger Collector を定義する設定オプション。
`options: collector: num-workers:` Copy to Clipboard Toggle word wrap	キューからプルするワーカーの数。	整数 (例: `50`)。
`options: collector: queue-size:` Copy to Clipboard Toggle word wrap	Collector キューのサイズ。	整数 (例: `2000`)。
`options: kafka: producer: topic: jaeger-spans` Copy to Clipboard Toggle word wrap	`topic` パラメーターは、Collector によってメッセージを生成するために使用され、Ingester によってメッセージを消費するために使用される Kafka 設定を特定します。	プロデューサーのラベル。
`options: kafka: producer: brokers: my-cluster-kafka-brokers.kafka:9092` Copy to Clipboard Toggle word wrap	メッセージを生成するために Collector によって使用される Kafka 設定を特定します。ブローカーが指定されていない場合で、AMQ Streams 1.4.0+ がインストールされている場合、Red Hat OpenShift 分散トレースプラットフォーム Operator は Kafka をセルフプロビジョニングします。
`options: log-level:` Copy to Clipboard Toggle word wrap	Collector のロギングレベル。	使用できる値は、`debug`、`info`、`warn`、`error`、`fatal`、`panic` です。

1.26.4.5. 分散トレースのサンプリング設定オプション
リンクのコピー

この Red Hat OpenShift 分散トレースプラットフォーム Operator は、リモートサンプラーを使用するように設定されているトレーサーに提供されるサンプリングストラテジーを定義するために使用できます。

すべてのトレースが生成される間に、それらの一部のみがサンプリングされます。トレースをサンプリングすると、追加の処理や保存のためにトレースにマークが付けられます。

注記

これは、トレースがサンプリングの意思決定が行われる際に Envoy プロキシーによって開始されている場合に関連がありません。Jaeger サンプリングの意思決定は、トレースがクライアントを使用してアプリケーションによって開始される場合にのみ関連します。

サービスがトレースコンテキストが含まれていない要求を受信すると、クライアントは新しいトレースを開始し、これにランダムなトレース ID を割り当て、現在インストールされているサンプリングストラテジーに基づいてサンプリングの意思決定を行います。サンプリングの意思決定はトレース内の後続のすべての要求に伝播され、他のサービスが再度サンプリングの意思決定を行わないようにします。

分散トレースプラットフォームライブラリーは、以下のサンプラーをサポートします。

Probabilistic: サンプラーは、sampling.param プロパティーの値と等しいサンプリングの確率で、ランダムなサンプリングの意思決定を行います。たとえば、sampling.param=0.1 を使用した場合は、約 10 のうち 1 トレースがサンプリングされます。
Rate Limiting: サンプラーは、リーキーバケット (leaky bucket) レートリミッターを使用して、トレースが一定のレートでサンプリングされるようにします。たとえば、sampling.param=2.0 を使用した場合は、1 秒あたり 2 トレースの割合で要求がサンプリングされます。

Expand

表1.42 Jaeger サンプリングのオプション
パラメーター	説明	値	デフォルト値
`spec: sampling: options: {} default_strategy: service_strategy:` Copy to Clipboard Toggle word wrap	トレース用のサンプリングストラテジーを定義する設定オプション。		設定を指定しない場合、Collector はすべてのサービスの確率 0.001 (0.1%) のデフォルトの確率的なサンプリングポリシーを返します。
`default_strategy: type: service_strategy: type:` Copy to Clipboard Toggle word wrap	使用するサンプリングストラテジー。上記の説明を参照してください。	有効な値は `probabilistic`、および `ratelimiting` です。	`probabilistic`
`default_strategy: param: service_strategy: param:` Copy to Clipboard Toggle word wrap	選択したサンプリングストラテジーのパラメーター	10 進値および整数値 (0、.1、1、10)	1

この例では、トレースインスタンスをサンプリングする確率が 50% の確率的なデフォルトサンプリングストラテジーを定義します。

確率的なサンプリングの例

apiVersion: jaegertracing.io/v1
kind: Jaeger
metadata:
  name: with-sampling
spec:
  sampling:
    options:
      default_strategy:
        type: probabilistic
        param: 0.5
      service_strategies:
        - service: alpha
          type: probabilistic
          param: 0.8
          operation_strategies:
            - operation: op1
              type: probabilistic
              param: 0.2
            - operation: op2
              type: probabilistic
              param: 0.4
        - service: beta
          type: ratelimiting
          param: 5

apiVersion: jaegertracing.io/v1
kind: Jaeger
metadata:
  name: with-sampling
spec:
  sampling:
    options:
      default_strategy:
        type: probabilistic
        param: 0.5
      service_strategies:
        - service: alpha
          type: probabilistic
          param: 0.8
          operation_strategies:
            - operation: op1
              type: probabilistic
              param: 0.2
            - operation: op2
              type: probabilistic
              param: 0.4
        - service: beta
          type: ratelimiting
          param: 5

Copy to Clipboard

Toggle word wrap

ユーザーによって指定される設定がない場合、分散トレースプラットフォームは以下の設定を使用します。

デフォルトのサンプリング

spec:
  sampling:
    options:
      default_strategy:
        type: probabilistic
        param: 1

spec:
  sampling:
    options:
      default_strategy:
        type: probabilistic
        param: 1

Copy to Clipboard

Toggle word wrap

1.26.4.6. 分散トレースのストレージ設定オプション
リンクのコピー

spec.storage の下で Collector、Ingester、および Query サービスのストレージを設定します。これらの各コンポーネントの複数のインスタンスは、パフォーマンスと回復性を確保するために、必要に応じてプロビジョニングできます。

Expand

表1.43 分散トレースストレージを定義するために Red Hat OpenShift 分散トレースプラットフォーム Operator によって使用される一般的なストレージパラメーター
パラメーター	説明	値	デフォルト値
`spec: storage: type:` Copy to Clipboard Toggle word wrap	デプロイメントに使用するストレージのタイプ。	`memory` または `elasticsearch`メモリーストレージは、Pod がシャットダウンした場合にデータが永続化されないため、開発、テスト、デモ、および概念検証用の環境にのみに適しています。実稼働環境では、分散トレースプラットフォームは永続ストレージの Elasticsearch をサポートします。	`memory`
`storage: secretname:` Copy to Clipboard Toggle word wrap	シークレットの名前 (例:`tracing-secret` )。		該当なし
`storage: options: {}` Copy to Clipboard Toggle word wrap	ストレージを定義する設定オプション。

Expand

表1.44 Elasticsearch インデックスクリーナーのパラメーター
パラメーター	説明	値	デフォルト値
`storage: esIndexCleaner: enabled:` Copy to Clipboard Toggle word wrap	Elasticsearch ストレージを使用する場合は、デフォルトでジョブが作成され、古いトレースをインデックスからクリーンアップします。このパラメーターは、インデックスクリーナージョブを有効または無効にします。	`true`/ `false`	`true`
`storage: esIndexCleaner: numberOfDays:` Copy to Clipboard Toggle word wrap	インデックスの削除を待機する日数。	整数値	`7`
`storage: esIndexCleaner: schedule:` Copy to Clipboard Toggle word wrap	Elasticsearch インデックスを消去する頻度に関するスケジュールを定義します。	cron 式	"55 23 * * *"

1.26.4.6.1. Elasticsearch インスタンスの自動プロビジョニング
リンクのコピー

Jaeger カスタムリソースをデプロイする場合に、Red Hat OpenShift 分散トレースプラットフォーム Operator は、OpenShift Elasticsearch Operator を使用して、カスタムリソースファイルの ストレージ セクションで提供される設定に基づいて Elasticsearch クラスターを作成します。以下の設定が設定されている場合は、Red Hat 分散トレースプラットフォーム Operator は Elasticsearch をプロビジョニングします。

spec.storage:type は elasticsearch に設定されている
spec.storage.elasticsearch.doNotProvision は false に設定されている
spec.storage.options.es.server-urls が定義されていない。つまり、Red Hat Elasticsearch Operator によってプロビジョニングされていない Elasticsearch インスタンスへの接続がない。

Elasticsearch をプロビジョニングする場には、Red Hat OpenShift 分散トレースプラットフォーム Operator は、Elasticsearch カスタムリソース 名 を Jaeger カスタムリソースの spec.storage.elasticsearch.name の値に設定します。spec.storage.elasticsearch.name に値を指定しない場合、Operator は elasticsearch を使用します。

制約

namespace ごとにセルフプロビジョニングされた Elasticsearch インスタンスがある分散トレースプラットフォーム 1 つだけを使用できます。Elasticsearch クラスターは単一の分散トレースプラットフォームインスタンスの専用のクラスターになります。
namespace ごとに 1 つの Elasticsearch のみを使用できます。

注記

Elasticsearch を OpenShift ロギングの一部としてインストールしている場合、Red Hat OpenShift 分散トレースプラットフォーム Operator はインストールされた OpenShift Elasticsearch Operator を使用してストレージをプロビジョニングできます。

以下の設定パラメーターは、セルフプロビジョニングされた Elasticsearch インスタンスに対するものです。これは、OpenShift Elasticsearch Operator を使用して Red Hat OpenShift 分散トレースプラットフォーム Operator によって作成されるインスタンスです。セルフプロビジョニングされた Elasticsearch の設定オプションは、設定ファイルの spec:storage:elasticsearch の下で指定します。

Expand

表1.45 Elasticsearch リソース設定パラメーター
パラメーター	説明	値	デフォルト値
`elasticsearch: properties: doNotProvision:` Copy to Clipboard Toggle word wrap	Elasticsearch インスタンスを Red Hat 分散トレースプラットフォーム Operator がプロビジョニングする必要があるかどうかを指定するために使用します。	`true`/`false`	`true`
`elasticsearch: properties: name:` Copy to Clipboard Toggle word wrap	Elasticsearch インスタンスの名前。Red Hat OpenShift 分散トレースプラットフォーム Operator は、このパラメーターで指定された Elasticsearch インスタンスを使用して Elasticsearch に接続します。	string	`elasticsearch`
`elasticsearch: nodeCount:` Copy to Clipboard Toggle word wrap	Elasticsearch ノードの数。高可用性を確保するには、少なくとも 3 つのノードを使用します。スプリットブレインの問題が生じる可能性があるため、2 つのノードを使用しないでください。	整数値。例: 概念実証用 = 1、最小デプロイメント = 3	3
`elasticsearch: resources: requests: cpu:` Copy to Clipboard Toggle word wrap	ご使用の環境設定に基づく、要求に対する中央処理単位の数。	コアまたはミリコアで指定されます (例: 200m、0.5、1)。例: 概念実証用 = 500m、最小デプロイメント = 1	1
`elasticsearch: resources: requests: memory:` Copy to Clipboard Toggle word wrap	ご使用の環境設定に基づく、要求に使用できるメモリー。	バイト単位で指定します (例:200Ki、50Mi、5Gi)。例: 概念実証用 = 1Gi、最小デプロイメント = 16Gi*	16Gi
`elasticsearch: resources: limits: cpu:` Copy to Clipboard Toggle word wrap	ご使用の環境設定に基づく、中央処理単位数の制限。	コアまたはミリコアで指定されます (例: 200m、0.5、1)。例: 概念実証用 = 500m、最小デプロイメント = 1
`elasticsearch: resources: limits: memory:` Copy to Clipboard Toggle word wrap	ご使用の環境設定に基づく、利用可能なメモリー制限。	バイト単位で指定します (例:200Ki、50Mi、5Gi)。例: 概念実証用 = 1Gi、最小デプロイメント = 16Gi*
`elasticsearch: redundancyPolicy:` Copy to Clipboard Toggle word wrap	データレプリケーションポリシーは、Elasticsearch シャードをクラスター内のデータノードにレプリケートする方法を定義します。指定されていない場合、Red Hat OpenShift 分散トレースプラットフォーム Operator はノード数に基づいて最も適切なレプリケーションを自動的に判別します。	`ZeroRedundancy`(レプリカシャードなし)、`SingleRedundancy`(レプリカシャード 1 つ)、`MultipleRedundancy`(各インデックスはデータノードの半分に分散される)、`FullRedundancy` (各インデックスはクラスター内のすべてのデータノードに完全にレプリケートされます)
`elasticsearch: useCertManagement:` Copy to Clipboard Toggle word wrap	分散トレースプラットフォームが Red Hat の証明書管理機能を使用するかどうかを指定するために使用します。この機能は、OpenShift Container Platform 4.7 の Red Hat OpenShift 5.2 向けのロギングサブシステムに追加されており、新しい Jaeger デプロイメントに推奨の設定です。	`true`/`false`	`true`
Copy to Clipboard Toggle word wrap	各 Elasticsearch ノードはこれより低い値のメモリー設定でも動作しますが、これは実稼働環境でのデプロイメントには推奨されません。実稼働環境で使用する場合は、デフォルトで各 Pod に割り当てる設定を 16Gi 未満にすることはできず、Pod ごとに最大 64Gi を割り当てることを推奨します。

実稼働ストレージの例

apiVersion: jaegertracing.io/v1
kind: Jaeger
metadata:
  name: simple-prod
spec:
  strategy: production
  storage:
    type: elasticsearch
    elasticsearch:
      nodeCount: 3
      resources:
        requests:
          cpu: 1
          memory: 16Gi
        limits:
          memory: 16Gi

apiVersion: jaegertracing.io/v1
kind: Jaeger
metadata:
  name: simple-prod
spec:
  strategy: production
  storage:
    type: elasticsearch
    elasticsearch:
      nodeCount: 3
      resources:
        requests:
          cpu: 1
          memory: 16Gi
        limits:
          memory: 16Gi

Copy to Clipboard

Toggle word wrap

永続ストレージを含むストレージの例:

apiVersion: jaegertracing.io/v1
kind: Jaeger
metadata:
  name: simple-prod
spec:
  strategy: production
  storage:
    type: elasticsearch
    elasticsearch:
      nodeCount: 1
      storage: 
        storageClassName: gp2
        size: 5Gi
      resources:
        requests:
          cpu: 200m
          memory: 4Gi
        limits:
          memory: 4Gi
      redundancyPolicy: ZeroRedundancy

apiVersion: jaegertracing.io/v1
kind: Jaeger
metadata:
  name: simple-prod
spec:
  strategy: production
  storage:
    type: elasticsearch
    elasticsearch:
      nodeCount: 1
      storage:


        storageClassName: gp2
        size: 5Gi
      resources:
        requests:
          cpu: 200m
          memory: 4Gi
        limits:
          memory: 4Gi
      redundancyPolicy: ZeroRedundancy

Copy to Clipboard

Toggle word wrap

1: 永続ストレージの設定。この場合、AWS gp2 のサイズは 5Gi です。値の指定がない場合、分散トレースプラットフォームは emptyDir を使用します。OpenShift Elasticsearch Operator は、分散トレースプラットフォームインスタンスで削除されないPersistentVolumeClaim および PersistentVolume をプロビジョニングします。同じ名前および namespace で分散トレースプラットフォームインスタンスを作成する場合は、同じボリュームをマウントできます。

1.26.4.6.2. 既存の Elasticsearch インスタンスへの接続
リンクのコピー

分散トレースを使用したストレージには、既存の Elasticsearch クラスターを使用できます。外部 Elasticsearch インスタンスとも呼ばれる既存の Elasticsearch クラスターは、Red Hat 分散トレースプラットフォーム Operator または Red Hat Operator によってインストールされなかったインスタンスです。

以下の設定が指定されている場合に、Jaeger カスタムリソースをデプロイすると、Red Hat 分散トレースプラットフォーム Operator は Elasticsearch をプロビジョニングしません。

spec.storage.elasticsearch.doNotProvision が true に設定されている
spec.storage.options.es.server-urls に値がある
spec.storage.elasticsearch.name に値がある場合、または Elasticsearch インスタンス名が elasticsearch の場合。

Red Hat OpenShift 分散トレースプラットフォーム Operator は、spec.storage.elasticsearch.name で指定された Elasticsearch インスタンスを使用して Elasticsearch に接続します。

制約

分散トレースプラットフォームで OpenShift Container Platform ロギング Elasticsearch インスタンスを共有したり、再利用したりすることはできません。Elasticsearch クラスターは単一の分散トレースプラットフォームインスタンスの専用のクラスターになります。

注記

Red Hat は、外部 Elasticsearch インスタンスのサポートを提供しません。カスタマーポータルでテスト済み統合マトリックスを確認できます。

以下の設定パラメーターは、外部 Elasticsearch インスタンスとして知られる、既存の Elasticsearch インスタンス向けです。この場合は、カスタムリソースファイルの spec:storage:options:es で、Elasticsearch の設定オプションを指定します。

Expand

表1.46 汎用 ES 設定パラメーター
パラメーター	説明	値	デフォルト値
`es: server-urls:` Copy to Clipboard Toggle word wrap	Elasticsearch インスタンスの URL。	Elasticsearch サーバーの完全修飾ドメイン名。	`http://elasticsearch.<namespace>.svc:9200`
`es: max-doc-count:` Copy to Clipboard Toggle word wrap	Elasticsearch クエリーから返す最大ドキュメント数。これは集約にも適用されます。`es.max-doc-count` と `es.max-num-spans` の両方を設定する場合は、Elasticsearch は 2 つの内の小さい方の値を使用します。		10000
`es: max-num-spans:` Copy to Clipboard Toggle word wrap	[非推奨: 今後のリリースで削除されます。代わりに `es.max-doc-count` を使用してください。] Elasticsearch のクエリーごとに、1 度にフェッチするスパンの最大数。`es.max-num-spans` と `es.max-doc-count` の両方を設定する場合、Elasticsearch は 2 つの内の小さい方の値を使用します。		10000
`es: max-span-age:` Copy to Clipboard Toggle word wrap	Elasticsearch のスパンの最大ルックバック。		72h0m0s
`es: sniffer:` Copy to Clipboard Toggle word wrap	Elasticsearch のスニファー設定。クライアントはスニッフィングプロセスを使用してすべてのノードを自動的に検索します。デフォルトでは無効になっています。	`true`/ `false`	`false`
`es: sniffer-tls-enabled:` Copy to Clipboard Toggle word wrap	Elasticsearch クラスターに対してスニッフィングする際に TLS を有効にするためのオプション。クライアントはスニッフィングプロセスを使用してすべてのノードを自動的に検索します。デフォルトでは無効になっています。	`true`/ `false`	`false`
`es: timeout:` Copy to Clipboard Toggle word wrap	クエリーに使用されるタイムアウト。ゼロに設定するとタイムアウトはありません。		0s
`es: username:` Copy to Clipboard Toggle word wrap	Elasticsearch で必要なユーザー名。Basic 認証は、指定されている場合に CA も読み込みます。`es.password` も参照してください。
`es: password:` Copy to Clipboard Toggle word wrap	Elasticsearch で必要なパスワード。`es.username` も参照してください。
`es: version:` Copy to Clipboard Toggle word wrap	主要な Elasticsearch バージョン。指定されていない場合、値は Elasticsearch から自動検出されます。		0

Expand

表1.47 ES データレプリケーションパラメーター
パラメーター	説明	値	デフォルト値
`es: num-replicas:` Copy to Clipboard Toggle word wrap	Elasticsearch のインデックスごとのレプリカ数。		1
`es: num-shards:` Copy to Clipboard Toggle word wrap	Elasticsearch のインデックスごとのシャード数。		5

Expand

表1.48 ES インデックス設定パラメーター
パラメーター	説明	値	デフォルト値
`es: create-index-templates:` Copy to Clipboard Toggle word wrap	`true` に設定されている場合は、アプリケーションの起動時にインデックステンプレートを自動的に作成します。テンプレートが手動でインストールされる場合は、`false` に設定されます。	`true`/ `false`	`true`
`es: index-prefix:` Copy to Clipboard Toggle word wrap	分散トレースプラットフォームインデックスのオプション接頭辞。たとえば、これを production に設定すると、production-tracing-*という名前のインデックスが作成されます。

Expand

表1.49 ES バルクプロセッサー設定パラメーター
パラメーター	説明	デフォルト値
`es: bulk: actions:` Copy to Clipboard Toggle word wrap	バルクプロセッサーがディスクへの更新のコミットを決定する前にキューに追加できる要求の数。	1000
`es: bulk: flush-interval:` Copy to Clipboard Toggle word wrap	`time.Duration`: この後に、他のしきい値に関係なく一括要求がコミットされます。バルクプロセッサーのフラッシュ間隔を無効にするには、これをゼロに設定します。	200ms
`es: bulk: size:` Copy to Clipboard Toggle word wrap	バルクプロセッサーがディスクへの更新をコミットするまでに一括要求が発生する可能性のあるバイト数。	5000000
`es: bulk: workers:` Copy to Clipboard Toggle word wrap	一括要求を受信し、Elasticsearch にコミットできるワーカーの数。	1

Expand

表1.50 ES TLS 設定パラメーター
パラメーター	説明	値	デフォルト値
`es: tls: ca:` Copy to Clipboard Toggle word wrap	リモートサーバーの検証に使用される TLS 認証局 (CA) ファイルへのパス。		デフォルトではシステムトラストストアを使用します。
`es: tls: cert:` Copy to Clipboard Toggle word wrap	リモートサーバーに対するこのプロセスの特定に使用される TLS 証明書ファイルへのパス。
`es: tls: enabled:` Copy to Clipboard Toggle word wrap	リモートサーバーと通信する際に、トランスポート層セキュリティー (TLS) を有効にします。デフォルトでは無効になっています。	`true`/ `false`	`false`
`es: tls: key:` Copy to Clipboard Toggle word wrap	リモートサーバーに対するこのプロセスの特定に使用される TLS 秘密鍵ファイルへのパス。
`es: tls: server-name:` Copy to Clipboard Toggle word wrap	リモートサーバーの証明書の予想される TLS サーバー名を上書きします。
`es: token-file:` Copy to Clipboard Toggle word wrap	ベアラートークンが含まれるファイルへのパス。このフラグは、指定されている場合は認証局 (CA) ファイルも読み込みます。

Expand

表1.51 ES アーカイブ設定パラメーター
パラメーター	説明	値	デフォルト値
`es-archive: bulk: actions:` Copy to Clipboard Toggle word wrap	バルクプロセッサーがディスクへの更新のコミットを決定する前にキューに追加できる要求の数。		0
`es-archive: bulk: flush-interval:` Copy to Clipboard Toggle word wrap	`time.Duration`: この後に、他のしきい値に関係なく一括要求がコミットされます。バルクプロセッサーのフラッシュ間隔を無効にするには、これをゼロに設定します。		0s
`es-archive: bulk: size:` Copy to Clipboard Toggle word wrap	バルクプロセッサーがディスクへの更新をコミットするまでに一括要求が発生する可能性のあるバイト数。		0
`es-archive: bulk: workers:` Copy to Clipboard Toggle word wrap	一括要求を受信し、Elasticsearch にコミットできるワーカーの数。		0
`es-archive: create-index-templates:` Copy to Clipboard Toggle word wrap	`true` に設定されている場合は、アプリケーションの起動時にインデックステンプレートを自動的に作成します。テンプレートが手動でインストールされる場合は、`false` に設定されます。	`true`/ `false`	`false`
`es-archive: enabled:` Copy to Clipboard Toggle word wrap	追加ストレージを有効にします。	`true`/ `false`	`false`
`es-archive: index-prefix:` Copy to Clipboard Toggle word wrap	分散トレースプラットフォームインデックスのオプション接頭辞。たとえば、これを production に設定すると、production-tracing-*という名前のインデックスが作成されます。
`es-archive: max-doc-count:` Copy to Clipboard Toggle word wrap	Elasticsearch クエリーから返す最大ドキュメント数。これは集約にも適用されます。		0
`es-archive: max-num-spans:` Copy to Clipboard Toggle word wrap	[非推奨: 今後のリリースで削除されます。代わりに `es-archive.max-doc-count` を使用してください。] Elasticsearch のクエリーごとに、1 度にフェッチするスパンの最大数。		0
`es-archive: max-span-age:` Copy to Clipboard Toggle word wrap	Elasticsearch のスパンの最大ルックバック。		0s
`es-archive: num-replicas:` Copy to Clipboard Toggle word wrap	Elasticsearch のインデックスごとのレプリカ数。		0
`es-archive: num-shards:` Copy to Clipboard Toggle word wrap	Elasticsearch のインデックスごとのシャード数。		0
`es-archive: password:` Copy to Clipboard Toggle word wrap	Elasticsearch で必要なパスワード。`es.username` も参照してください。
`es-archive: server-urls:` Copy to Clipboard Toggle word wrap	Elasticsearch サーバーのコンマ区切りの一覧。完全修飾 URL(例: `http://localhost:9200`) として指定される必要があります。
`es-archive: sniffer:` Copy to Clipboard Toggle word wrap	Elasticsearch のスニファー設定。クライアントはスニッフィングプロセスを使用してすべてのノードを自動的に検索します。デフォルトでは無効になっています。	`true`/ `false`	`false`
`es-archive: sniffer-tls-enabled:` Copy to Clipboard Toggle word wrap	Elasticsearch クラスターに対してスニッフィングする際に TLS を有効にするためのオプション。クライアントはスニッフィングプロセスを使用してすべてのノードを自動的に検索します。デフォルトでは無効になっています。	`true`/ `false`	`false`
`es-archive: timeout:` Copy to Clipboard Toggle word wrap	クエリーに使用されるタイムアウト。ゼロに設定するとタイムアウトはありません。		0s
`es-archive: tls: ca:` Copy to Clipboard Toggle word wrap	リモートサーバーの検証に使用される TLS 認証局 (CA) ファイルへのパス。		デフォルトではシステムトラストストアを使用します。
`es-archive: tls: cert:` Copy to Clipboard Toggle word wrap	リモートサーバーに対するこのプロセスの特定に使用される TLS 証明書ファイルへのパス。
`es-archive: tls: enabled:` Copy to Clipboard Toggle word wrap	リモートサーバーと通信する際に、トランスポート層セキュリティー (TLS) を有効にします。デフォルトでは無効になっています。	`true`/ `false`	`false`
`es-archive: tls: key:` Copy to Clipboard Toggle word wrap	リモートサーバーに対するこのプロセスの特定に使用される TLS 秘密鍵ファイルへのパス。
`es-archive: tls: server-name:` Copy to Clipboard Toggle word wrap	リモートサーバーの証明書の予想される TLS サーバー名を上書きします。
`es-archive: token-file:` Copy to Clipboard Toggle word wrap	ベアラートークンが含まれるファイルへのパス。このフラグは、指定されている場合は認証局 (CA) ファイルも読み込みます。
`es-archive: username:` Copy to Clipboard Toggle word wrap	Elasticsearch で必要なユーザー名。Basic 認証は、指定されている場合に CA も読み込みます。`es-archive.password` も参照してください。
`es-archive: version:` Copy to Clipboard Toggle word wrap	主要な Elasticsearch バージョン。指定されていない場合、値は Elasticsearch から自動検出されます。		0

ボリュームマウントを含むストレージの例

apiVersion: jaegertracing.io/v1
kind: Jaeger
metadata:
  name: simple-prod
spec:
  strategy: production
  storage:
    type: elasticsearch
    options:
      es:
        server-urls: https://quickstart-es-http.default.svc:9200
        index-prefix: my-prefix
        tls:
          ca: /es/certificates/ca.crt
    secretName: tracing-secret
  volumeMounts:
    - name: certificates
      mountPath: /es/certificates/
      readOnly: true
  volumes:
    - name: certificates
      secret:
        secretName: quickstart-es-http-certs-public

apiVersion: jaegertracing.io/v1
kind: Jaeger
metadata:
  name: simple-prod
spec:
  strategy: production
  storage:
    type: elasticsearch
    options:
      es:
        server-urls: https://quickstart-es-http.default.svc:9200
        index-prefix: my-prefix
        tls:
          ca: /es/certificates/ca.crt
    secretName: tracing-secret
  volumeMounts:
    - name: certificates
      mountPath: /es/certificates/
      readOnly: true
  volumes:
    - name: certificates
      secret:
        secretName: quickstart-es-http-certs-public

Copy to Clipboard

Toggle word wrap

以下の例は、ボリュームからマウントされる TLS CA 証明書およびシークレットに保存されるユーザー/パスワードを使用して外部 Elasticsearch クラスターを使用する Jaeger CR を示しています。

外部 Elasticsearch の例:

apiVersion: jaegertracing.io/v1
kind: Jaeger
metadata:
  name: simple-prod
spec:
  strategy: production
  storage:
    type: elasticsearch
    options:
      es:
        server-urls: https://quickstart-es-http.default.svc:9200 
        index-prefix: my-prefix
        tls: 
          ca: /es/certificates/ca.crt
    secretName: tracing-secret 
  volumeMounts: 
    - name: certificates
      mountPath: /es/certificates/
      readOnly: true
  volumes:
    - name: certificates
      secret:
        secretName: quickstart-es-http-certs-public

apiVersion: jaegertracing.io/v1
kind: Jaeger
metadata:
  name: simple-prod
spec:
  strategy: production
  storage:
    type: elasticsearch
    options:
      es:
        server-urls: https://quickstart-es-http.default.svc:9200


        index-prefix: my-prefix
        tls:


          ca: /es/certificates/ca.crt
    secretName: tracing-secret


  volumeMounts:


    - name: certificates
      mountPath: /es/certificates/
      readOnly: true
  volumes:
    - name: certificates
      secret:
        secretName: quickstart-es-http-certs-public

Copy to Clipboard

Toggle word wrap

1: デフォルト namespace で実行されている Elasticsearch サービスへの URL。
2: TLS 設定。この場合は、CA 証明書のみを使用できますが、相互 TLS を使用する場合に es.tls.key および es.tls.cert を含めることもできます。
3: 環境変数 ES_PASSWORD および ES_USERNAME を定義するシークレット。kubectl create secret generic tracing-secret --from-literal=ES_PASSWORD=changeme --from-literal=ES_USERNAME=elastic により作成されます
4: すべてのストレージコンポーネントにマウントされるボリュームのマウントとボリューム。

1.26.4.7. Elasticsearch を使用した証明書の管理
リンクのコピー

Red Hat Elasticsearch Operator を使用して、証明書を作成および管理できます。Red Hat Elasticsearch Operator を使用して証明書を管理すると、複数の Jaeger Collector で単一の Elasticsearch クラスターを使用することもできます。

重要

Elasticsearch を使用した証明書の管理は、テクノロジープレビュー機能のみです。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行いフィードバックを提供していただくことを目的としています。

Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲を参照してください。

バージョン 2.4 以降、Red Hat OpenShift 分散トレースプラットフォーム Operator は、Elasticsearch カスタムリソースで次のアノテーションを使用して、証明書の作成を Red Hat Elasticsearch Operator に委譲します。

logging.openshift.io/elasticsearch-cert-management: "true"
logging.openshift.io/elasticsearch-cert.jaeger-<shared-es-node-name>: "user.jaeger"
logging.openshift.io/elasticsearch-cert.curator- <shared-es-node-name>: "system.logging.curator"

ここで、<shared-es-node-name> は Elasticsearch ノードの名前です。たとえば、custom-es という名前の Elasticsearch ノードを作成する場合に、カスタムリソースは次の例のようになります。

アノテーションを表示する Elasticsearch CR の例

apiVersion: logging.openshift.io/v1
kind: Elasticsearch
metadata:
  annotations:
    logging.openshift.io/elasticsearch-cert-management: "true"
    logging.openshift.io/elasticsearch-cert.jaeger-custom-es: "user.jaeger"
    logging.openshift.io/elasticsearch-cert.curator-custom-es: "system.logging.curator"
  name: custom-es
spec:
  managementState: Managed
  nodeSpec:
    resources:
      limits:
        memory: 16Gi
      requests:
        cpu: 1
        memory: 16Gi
  nodes:
    - nodeCount: 3
      proxyResources: {}
      resources: {}
      roles:
        - master
        - client
        - data
      storage: {}
  redundancyPolicy: ZeroRedundancy

apiVersion: logging.openshift.io/v1
kind: Elasticsearch
metadata:
  annotations:
    logging.openshift.io/elasticsearch-cert-management: "true"
    logging.openshift.io/elasticsearch-cert.jaeger-custom-es: "user.jaeger"
    logging.openshift.io/elasticsearch-cert.curator-custom-es: "system.logging.curator"
  name: custom-es
spec:
  managementState: Managed
  nodeSpec:
    resources:
      limits:
        memory: 16Gi
      requests:
        cpu: 1
        memory: 16Gi
  nodes:
    - nodeCount: 3
      proxyResources: {}
      resources: {}
      roles:
        - master
        - client
        - data
      storage: {}
  redundancyPolicy: ZeroRedundancy

Copy to Clipboard

Toggle word wrap

前提条件

OpenShift Container Platform 4.7
Red Hat OpenShift のロギングサブシステム: 5.2
Elasticsearch ノードと Jaeger インスタンスは同じ namespace にデプロイする必要があります。(例: traceing-system)。

Jaeger カスタムリソースで spec.storage.elasticsearch.useCertManagement を true に設定して、証明書管理を有効にします。

useCertManagement を示す例

apiVersion: jaegertracing.io/v1
kind: Jaeger
metadata:
  name: jaeger-prod
spec:
  strategy: production
  storage:
    type: elasticsearch
    elasticsearch:
      name: custom-es
      doNotProvision: true
      useCertManagement: true

apiVersion: jaegertracing.io/v1
kind: Jaeger
metadata:
  name: jaeger-prod
spec:
  strategy: production
  storage:
    type: elasticsearch
    elasticsearch:
      name: custom-es
      doNotProvision: true
      useCertManagement: true

Copy to Clipboard

Toggle word wrap

Red Hat OpenShift 分散トレースプラットフォーム Operator は、Elasticsearch カスタムリソース 名 を Jaeger カスタムリソースの spec.storage.elasticsearch.name の値に設定します。

証明書は Red Hat Operator によってプロビジョニングされ、Red Hat 分散トレースプラットフォーム Operator が証明書を挿入します。

Elasticsearch を OpenShift Container Platform で設定する方法の詳細は、ログストアの設定または分散トレースの設定およびデプロイを参照してください。

1.26.4.8. クエリー設定オプション
リンクのコピー

Query とは、ストレージからトレースを取得し、ユーザーインターフェイスをホストしてそれらを表示するサービスです。

Expand

表1.52 Query を定義するために Red Hat OpenShift 分散トレースプラットフォーム Operator によって使用されるパラメーター
パラメーター	説明	値	デフォルト値
`spec: query: replicas:` Copy to Clipboard Toggle word wrap	作成する Query レプリカの数を指定します。	整数 (例: `2`)

Expand

表1.53 Query に渡される設定パラメーター
パラメーター	説明	値
`spec: query: options: {}` Copy to Clipboard Toggle word wrap	Query サービスを定義する設定オプション。
`options: log-level:` Copy to Clipboard Toggle word wrap	Query のロギングレベル。	使用できる値は、`debug`、`info`、`warn`、`error`、`fatal`、`panic` です。
`options: query: base-path:` Copy to Clipboard Toggle word wrap	すべての jaeger-query HTTP ルートのベースパスは、root 以外の値に設定できます。たとえば、`/jaeger` ではすべての UI URL が `/jaeger` で開始するようになります。これは、リバースプロキシーの背後で jaeger-query を実行する場合に役立ちます。	/<path>

Query 設定の例

apiVersion: jaegertracing.io/v1
kind: "Jaeger"
metadata:
  name: "my-jaeger"
spec:
  strategy: allInOne
  allInOne:
    options:
      log-level: debug
      query:
        base-path: /jaeger

apiVersion: jaegertracing.io/v1
kind: "Jaeger"
metadata:
  name: "my-jaeger"
spec:
  strategy: allInOne
  allInOne:
    options:
      log-level: debug
      query:
        base-path: /jaeger

Copy to Clipboard

Toggle word wrap

1.26.4.9. Ingester 設定オプション
リンクのコピー

Ingester は、Kafka トピックから読み取り、Elasticsearch ストレージバックエンドに書き込むサービスです。allInOne または production デプロイメントストラテジーを使用している場合は、Ingester サービスを設定する必要はありません。

Expand

表1.54 Ingester に渡される Jaeger パラメーター
パラメーター	説明	値
`spec: ingester: options: {}` Copy to Clipboard Toggle word wrap	Ingester サービスを定義する設定オプション。
`options: deadlockInterval:` Copy to Clipboard Toggle word wrap	Ingester が終了するまでメッセージを待機する間隔 (秒単位または分単位) を指定します。システムの初期化中にメッセージが到達されない場合に Ingester が終了しないように、デッドロックの間隔はデフォルトで無効に (`0`に設定) されます。	分と秒 (例: `1m0s`)デフォルト値は `0` です。
`options: kafka: consumer: topic:` Copy to Clipboard Toggle word wrap	`topic` パラメーターは、コレクターによってメッセージを生成するために使用され、Ingester によってメッセージを消費するために使用される Kafka 設定を特定します。	コンシューマーのラベル例: `jaeger-spans`
`options: kafka: consumer: brokers:` Copy to Clipboard Toggle word wrap	メッセージを消費するために Ingester によって使用される Kafka 設定を特定します。	ブローカーのラベル (例: `my-cluster-kafka-brokers.kafka:9092`)
`options: log-level:` Copy to Clipboard Toggle word wrap	Ingester のロギングレベル。	使用できる値は、`debug`、`info`、`warn`、`error`、`fatal`、`dpanic`、`panic` です。

ストリーミング Collector および Ingester の例

apiVersion: jaegertracing.io/v1
kind: Jaeger
metadata:
  name: simple-streaming
spec:
  strategy: streaming
  collector:
    options:
      kafka:
        producer:
          topic: jaeger-spans
          brokers: my-cluster-kafka-brokers.kafka:9092
  ingester:
    options:
      kafka:
        consumer:
          topic: jaeger-spans
          brokers: my-cluster-kafka-brokers.kafka:9092
      ingester:
        deadlockInterval: 5
  storage:
    type: elasticsearch
    options:
      es:
        server-urls: http://elasticsearch:9200

apiVersion: jaegertracing.io/v1
kind: Jaeger
metadata:
  name: simple-streaming
spec:
  strategy: streaming
  collector:
    options:
      kafka:
        producer:
          topic: jaeger-spans
          brokers: my-cluster-kafka-brokers.kafka:9092
  ingester:
    options:
      kafka:
        consumer:
          topic: jaeger-spans
          brokers: my-cluster-kafka-brokers.kafka:9092
      ingester:
        deadlockInterval: 5
  storage:
    type: elasticsearch
    options:
      es:
        server-urls: http://elasticsearch:9200

Copy to Clipboard

Toggle word wrap

トップに戻る

1.26. Jaeger 設定リファレンス

1.26.1. トレースの有効化および無効化
リンクのコピー

1.26.2. SMCP での Jaeger 設定の指定
リンクのコピー

1.26.3. 分散トレースプラットフォームのデプロイ
リンクのコピー

1.26.3.1. デフォルトの分散トレースプラットフォームのデプロイ
リンクのコピー

1.26.3.2. 分散トレースプラットフォームの実稼働デプロイメント (最小)
リンクのコピー

1.26.3.3. 分散トレースプラットフォームの実稼働デプロイメント (完全にカスタマイズ)
リンクのコピー

1.26.3.4. Jaeger デプロイメントのストリーミング
リンクのコピー

1.26.4. Jaeger カスタムリソースでの Jaeger 設定の指定
リンクのコピー

1.26.4.1. デプロイメントのベストプラクティス
リンクのコピー

1.26.4.2. サービスメッシュの分散トレースセキュリティーの設定
リンクのコピー

1.26.4.2.1. OpenShift コンソールからのサービスメッシュの分散トレースセキュリティー設定
リンクのコピー

1.26.4.2.2. コマンドラインからのサービスメッシュの分散トレースセキュリティーの設定
リンクのコピー

1.26.4.3. 分散トレースのデフォルト設定オプション
リンクのコピー

1.26.4.4. Jaeger Collector 設定オプション
リンクのコピー

1.26.4.5. 分散トレースのサンプリング設定オプション
リンクのコピー

1.26.4.6. 分散トレースのストレージ設定オプション
リンクのコピー

1.26.4.6.1. Elasticsearch インスタンスの自動プロビジョニング
リンクのコピー

1.26.4.6.2. 既存の Elasticsearch インスタンスへの接続
リンクのコピー

1.26.4.7. Elasticsearch を使用した証明書の管理
リンクのコピー

1.26.4.8. クエリー設定オプション
リンクのコピー

1.26.4.9. Ingester 設定オプション
リンクのコピー

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

多様性を受け入れるオープンソースの強化

会社概要

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

1.26. Jaeger 設定リファレンス

1.26.1. トレースの有効化および無効化リンクのコピーリンクがクリップボードにコピーされました!

1.26.2. SMCP での Jaeger 設定の指定リンクのコピーリンクがクリップボードにコピーされました!

1.26.3. 分散トレースプラットフォームのデプロイリンクのコピーリンクがクリップボードにコピーされました!

1.26.3.1. デフォルトの分散トレースプラットフォームのデプロイリンクのコピーリンクがクリップボードにコピーされました!

1.26.3.2. 分散トレースプラットフォームの実稼働デプロイメント (最小)リンクのコピーリンクがクリップボードにコピーされました!

1.26.3.3. 分散トレースプラットフォームの実稼働デプロイメント (完全にカスタマイズ)リンクのコピーリンクがクリップボードにコピーされました!

1.26.3.4. Jaeger デプロイメントのストリーミングリンクのコピーリンクがクリップボードにコピーされました!

1.26.4. Jaeger カスタムリソースでの Jaeger 設定の指定リンクのコピーリンクがクリップボードにコピーされました!

1.26.4.1. デプロイメントのベストプラクティスリンクのコピーリンクがクリップボードにコピーされました!

1.26.4.2. サービスメッシュの分散トレースセキュリティーの設定リンクのコピーリンクがクリップボードにコピーされました!

1.26.4.2.1. OpenShift コンソールからのサービスメッシュの分散トレースセキュリティー設定リンクのコピーリンクがクリップボードにコピーされました!

1.26.4.2.2. コマンドラインからのサービスメッシュの分散トレースセキュリティーの設定リンクのコピーリンクがクリップボードにコピーされました!

1.26.4.3. 分散トレースのデフォルト設定オプションリンクのコピーリンクがクリップボードにコピーされました!

1.26.4.4. Jaeger Collector 設定オプションリンクのコピーリンクがクリップボードにコピーされました!

1.26.4.5. 分散トレースのサンプリング設定オプションリンクのコピーリンクがクリップボードにコピーされました!

1.26.4.6. 分散トレースのストレージ設定オプションリンクのコピーリンクがクリップボードにコピーされました!

1.26.4.6.1. Elasticsearch インスタンスの自動プロビジョニングリンクのコピーリンクがクリップボードにコピーされました!

1.26.4.6.2. 既存の Elasticsearch インスタンスへの接続リンクのコピーリンクがクリップボードにコピーされました!

1.26.4.7. Elasticsearch を使用した証明書の管理リンクのコピーリンクがクリップボードにコピーされました!

1.26.4.8. クエリー設定オプションリンクのコピーリンクがクリップボードにコピーされました!

1.26.4.9. Ingester 設定オプションリンクのコピーリンクがクリップボードにコピーされました!

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

多様性を受け入れるオープンソースの強化

会社概要

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

1.26.1. トレースの有効化および無効化
リンクのコピー

1.26.2. SMCP での Jaeger 設定の指定
リンクのコピー

1.26.3. 分散トレースプラットフォームのデプロイ
リンクのコピー

1.26.3.1. デフォルトの分散トレースプラットフォームのデプロイ
リンクのコピー

1.26.3.2. 分散トレースプラットフォームの実稼働デプロイメント (最小)
リンクのコピー

1.26.3.3. 分散トレースプラットフォームの実稼働デプロイメント (完全にカスタマイズ)
リンクのコピー

1.26.3.4. Jaeger デプロイメントのストリーミング
リンクのコピー

1.26.4. Jaeger カスタムリソースでの Jaeger 設定の指定
リンクのコピー

1.26.4.1. デプロイメントのベストプラクティス
リンクのコピー

1.26.4.2. サービスメッシュの分散トレースセキュリティーの設定
リンクのコピー

1.26.4.2.1. OpenShift コンソールからのサービスメッシュの分散トレースセキュリティー設定
リンクのコピー

1.26.4.2.2. コマンドラインからのサービスメッシュの分散トレースセキュリティーの設定
リンクのコピー

1.26.4.3. 分散トレースのデフォルト設定オプション
リンクのコピー

1.26.4.4. Jaeger Collector 設定オプション
リンクのコピー

1.26.4.5. 分散トレースのサンプリング設定オプション
リンクのコピー

1.26.4.6. 分散トレースのストレージ設定オプション
リンクのコピー

1.26.4.6.1. Elasticsearch インスタンスの自動プロビジョニング
リンクのコピー

1.26.4.6.2. 既存の Elasticsearch インスタンスへの接続
リンクのコピー

1.26.4.7. Elasticsearch を使用した証明書の管理
リンクのコピー

1.26.4.8. クエリー設定オプション
リンクのコピー

1.26.4.9. Ingester 設定オプション
リンクのコピー