Red Hat SummitRed Hat build of OpenTelemetry
OpenShift Container Platform での Red Hat build of OpenTelemetry の設定と使用
概要
第1章 Red Hat build of OpenTelemetry のリリースノート
1.1. Red Hat build of OpenTelemetry の概要
Red Hat build of OpenTelemetry は、オープンソースの OpenTelemetry プロジェクト に基づいており、クラウドネイティブソフトウェア用に統合かつ標準化された、ベンダー中立のテレメトリーデータ収集を提供することを目的としています。Red Hat build of OpenTelemetry 製品では、OpenTelemetry Collector をデプロイして管理し、ワークロード計装を簡素化することができます。
OpenTelemetry Collector は、テレメトリーデータを複数の形式で受信、処理、転送できます。そのため、テレメトリーを処理し、テレメトリーシステム間の相互運用性を確保するのに最適なコンポーネントです。Collector は、メトリクス、トレース、ログを収集および処理するための統合ソリューションを提供します。
OpenTelemetry Collector には、次のような多くの機能があります。
- データ収集および処理ハブ
- これは、さまざまなソースからメトリクスやトレースなどのテレメトリーデータを収集する中心的なコンポーネントとして機能します。このデータは、計装されたアプリケーションとインフラストラクチャーから作成できます。
- カスタマイズ可能なテレメトリーデータパイプライン
- OpenTelemetry Collector はカスタマイズできるように設計されています。さまざまなプロセッサー、エクスポーター、レシーバーをサポートします。
- 自動計装機能
- 自動計装により、アプリケーションに可観測性を追加するプロセスが簡素化されます。開発者が、基本的なテレメトリーデータ用にコードを手動で計装せずに済みます。
OpenTelemetry Collector の使用例の一部を次に示します。
- 一元的なデータ収集
- マイクロサービスアーキテクチャーでは、Collector をデプロイして、複数のサービスからデータを集約できます。
- データの補完と処理
- データを分析ツールに転送する前に、Collector はこのデータを強化、フィルタリング、および処理できます。
- マルチバックエンドの受信とエクスポート
- Collector は、複数の監視および分析プラットフォームに同時にデータを送受信できます。
Red Hat build of OpenTelemetry は、Red Hat OpenShift Distributed Tracing Platform と 組み合わせて 使用できます。
サポートされている機能のみが文書化されています。文書化されていない機能は現在サポートされていません。機能に関してサポートが必要な場合は、Red Hat のサポートにお問い合わせください。
1.2. Red Hat ビルドの OpenTelemetry 3.6.1 のリリースノート
OpenTelemetry 3.6.1 の Red Hat ビルドは、Red Hat build of OpenTelemetry Operator 0.127.0 を通じて提供されます。
OpenTelemetry 3.6.1 の Red Hat ビルドは、オープンソースの OpenTelemetry リリース 0.127.0 に基づいています。
1.2.1. CVE
このリリースでは、以下の CVE が修正されました。
1.2.2. 既知の問題
現在、次のエクスポーターに既知の問題があります。
- AWS CloudWatch Logs Exporter
- AWS EMF Exporter
- AWS X-Ray Exporter
この既知の問題は、OpenTelemetryCollector カスタムリソースのエクスポーター設定のオプションの endpoint フィールドを使用するデプロイメントに影響します。エンドポイント値の一部として https:// などのプロトコルを指定しないと、unsupported protocol scheme エラーが発生します。
回避策: エンドポイント値の一部として、https:// などのプロトコルを含めます。
1.3. Red Hat build of OpenTelemetry 2.0 のリリースノート
Red Hat build of OpenTelemetry 3.4 は、Red Hat build of OpenTelemetry Operator 0.113.0 を通じて提供されます。
Red Hat build of OpenTelemetry 3.3 は、オープンソースの OpenTelemetry リリース 0.107.0 に基づいています。
1.3.1. CVE
このリリースでは、以下の CVE が修正されました。
1.3.2. テクノロジープレビュー機能
この更新では、次のテクノロジープレビュー機能が導入されています。
- Tail Sampling Processor
- Cumulative-to-Delta Processor
これらの機能は、いずれもテクノロジープレビューのみの機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
1.3.3. 新機能および機能拡張
この更新では、次の機能拡張が導入されています。
以下の テクノロジープレビュー 機能が一般提供になりました。
- Kafka Exporter
- Attributes Processor
- Resource Processor
- Prometheus Receiver
-
この更新により、OpenTelemetry Collector は、Trusted Computing Group (TCG) による Trusted Platform Module (TPM) 2.0 ライブラリーの TPM Software Stack 仕様 (TSS) 2.0 に従って、
tss2形式の TLS 証明書を読み取ることができるようになりました。 -
この更新により、Red Hat build of OpenTelemetry Operator が、起動時にすべての
OpenTelemetryCollectorカスタムリソースを自動的にアップグレードするようになりました。この Operator は起動時にすべての管理対象インスタンスを調整します。エラーが発生した場合、Operator は指数バックオフを使用してアップグレードを再試行します。アップグレードが失敗した場合、Operator は再起動時にアップグレードを再試行します。
1.3.4. 削除通知
Red Hat build of OpenTelemetry 3.6 で、一時的なテクノロジープレビュー機能である Loki Exporter が削除されました。現在、Loki 3.0 以降で Loki Exporter を使用している場合は、Loki Exporter を OTLP HTTP Exporter に置き換えてください。
Loki Exporter はテクノロジープレビュー機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
1.3.5. 既知の問題
現在、次のエクスポーターに既知の問題があります。
- AWS CloudWatch Logs Exporter
- AWS EMF Exporter
- AWS X-Ray Exporter
この既知の問題は、OpenTelemetryCollector カスタムリソースのエクスポーター設定のオプションの endpoint フィールドを使用するデプロイメントに影響します。エンドポイント値の一部として https:// などのプロトコルを指定しないと、unsupported protocol scheme エラーが発生します。
回避策: エンドポイント値の一部として、https:// などのプロトコルを含めます。
1.4. Red Hat build of OpenTelemetry 3.5.1 のリリースノート
Red Hat build of OpenTelemetry 3.5.1 は、Red Hat build of OpenTelemetry Operator 0.119.0 を通じて提供されます。
Red Hat build of OpenTelemetry 3.5.1 は、オープンソースの OpenTelemetry リリース 0.119.0 に基づいています。
1.4.1. CVE
このリリースでは、以下の CVE が修正されました。
1.5. Red Hat build of OpenTelemetry 3.5 のリリースノート
Red Hat build of OpenTelemetry 3.5 は、Red Hat build of OpenTelemetry Operator 0.119.0 を通じて提供されます。
Red Hat build of OpenTelemetry 3.5 は、オープンソースの OpenTelemetry リリース 0.119.0 に基づいています。
1.5.1. テクノロジープレビュー機能
この更新では、次のテクノロジープレビュー機能が導入されています。
- AWS CloudWatch Exporter
- AWS EMF Exporter
- AWS X-Ray Exporter
これらの機能は、いずれもテクノロジープレビューのみの機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
1.5.2. 新機能および機能拡張
この更新では、次の機能拡張が導入されています。
以下の テクノロジープレビュー 機能が一般提供になりました。
- Host Metrics Receiver
- Kubelet Stats Receiver
- この更新により、OpenTelemetry Collector が OTLP HTTP Exporter を使用してログを LokiStack インスタンスにプッシュするようになりました。
-
この更新により、Operator に十分な権限がある場合、Operator によって、Kubernetes Events Receiver (
k8sevents)、Kubernetes Cluster Receiver (k8scluster)、および Kubernetes Objects Receiver (k8sobjects) の RBAC ルールが自動的に作成されます。詳細は、Collector の設定 の「必要な RBAC リソースの自動作成」を参照してください。
1.5.3. 非推奨の機能
Red Hat build of OpenTelemetry 3.5 で、一時的なテクノロジープレビュー機能である Loki Exporter が非推奨になりました。Loki Exporter は、Red Hat build of OpenTelemetry 3.6 で削除される予定です。現在、OpenShift Logging 6.1 以降で Loki Exporter を使用している場合は、Loki Exporter を OTLP HTTP Exporter に置き換えてください。
Loki Exporter はテクノロジープレビュー機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
1.5.4. バグ修正
この更新では、次のバグ修正が導入されています。
- この更新前は、Operator Pod が再起動したときに、Collector サービス用に手動で作成されたルートが意図せず削除されていました。この更新により、Operator Pod を再起動しても、手動で作成されたルートが削除されなくなりました。
1.6. Red Hat build of OpenTelemetry 3.4 のリリースノート
Red Hat build of OpenTelemetry 3.4 は、Red Hat build of OpenTelemetry Operator 0.113.0 を通じて提供されます。
Red Hat build of OpenTelemetry 3.4 は、オープンソースの OpenTelemetry リリース 0.113.0 に基づいています。
1.6.1. テクノロジープレビュー機能
この更新では、次のテクノロジープレビュー機能が導入されています。
- OpenTelemetry Protocol (OTLP) JSON File Receiver
- Count Connector
これらの機能は、いずれもテクノロジープレビューのみの機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
1.6.2. 新機能および機能拡張
この更新では、次の機能拡張が導入されています。
以下の テクノロジープレビュー 機能が一般提供になりました。
- BearerTokenAuth Extension
- Kubernetes Attributes Processor
- Spanmetrics Connector
-
instrumentation.opentelemetry.io/inject-sdkアノテーションをInstrumentationカスタムリソースで使用すると、OpenTelemetry SDK 環境変数をマルチコンテナー Pod に注入できます。
1.6.3. 削除通知
Red Hat build of OpenTelemetry 3.4 では、Logging Exporter が Collector から削除されました。代わりに、Debug Exporter を使用する必要があります。
警告Logging Exporter が設定されている場合、Red Hat build of OpenTelemetry 3.4 にアップグレードするとクラッシュループが発生します。この問題を回避するには、Red Hat build of OpenTelemetry にアップグレードする前に、Logging Exporter の代わりに Debug Exporter を使用するように Red Hat build of OpenTelemetry 3.4 を設定する必要があります。
-
Red Hat build of OpenTelemetry 3.4 では、テクノロジープレビュー の Memory Ballast Extension が削除されました。代わりに、
GOMEMLIMIT環境変数を使用できます。
1.7. Red Hat build of OpenTelemetry 3.3.1 のリリースノート
Red Hat build of OpenTelemetry は、Red Hat build of OpenTelemetry Operator を通じて提供されます。
Red Hat build of OpenTelemetry 3.3.1 は、オープンソースの OpenTelemetry リリース 0.107.0 に基づいています。
1.7.1. バグ修正
この更新では、次のバグ修正が導入されています。
- この更新前は、計装ライブラリーをアプリケーションコンテナーにコピーするときに、NGINX 自動計装の注入が失敗していました。この更新によりコピーコマンドが正しく設定され、問題は解決されました。(TRACING-4673)
1.8. Red Hat build of OpenTelemetry 3.3 のリリースノート
Red Hat build of OpenTelemetry は、Red Hat build of OpenTelemetry Operator を通じて提供されます。
Red Hat build of OpenTelemetry 3.3 は、オープンソースの OpenTelemetry リリース 0.107.0 に基づいています。
1.8.1. CVE
このリリースでは、以下の CVE が修正されました。
1.8.2. テクノロジープレビュー機能
この更新では、次のテクノロジープレビュー機能が導入されています。
- Group-by-Attributes Processor
- Transform Processor
- Routing Connector
- Prometheus Remote Write Exporter
- LokiStack ログストアへのログのエクスポート
これらの機能は、いずれもテクノロジープレビューのみの機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
1.8.3. 新機能および機能拡張
この更新では、次の機能拡張が導入されています。
- Collector の内部メトリクスを表示し、Collector の健全性とパフォーマンスを分析するための Collector ダッシュボード。(TRACING-3768)
- OpenTelemetry Collector と計装の両方で証明書を自動的に再ロードするためのサポート。(TRACING-4186)
1.8.4. バグ修正
この更新では、次のバグ修正が導入されています。
-
この更新前は、メトリクスエンドポイントにアクセスするための権限がなかったため、
ServiceMonitorオブジェクトが Operator メトリクスを取得できませんでした。この更新により、Operator 監視が有効な場合にServiceMonitorカスタムリソースが作成されるようになり、この問題が修正されました。(TRACING-4288) -
この更新前は、Collector サービスとヘッドレスサービスの両方が同じエンドポイントを監視していたため、メトリクス収集と
ServiceMonitorオブジェクトの重複が発生していました。この更新により、ヘッドレスサービスが作成されなくなり、この問題が修正されました。(OBSDA-773)
1.9. Red Hat build of OpenTelemetry 3.2.2 のリリースノート
Red Hat build of OpenTelemetry は、Red Hat build of OpenTelemetry Operator を通じて提供されます。
1.9.1. CVE
このリリースでは、以下の CVE が修正されました。
1.9.2. バグ修正
この更新では、次のバグ修正が導入されています。
-
この更新前は、Operator がサービスアカウントに対して新規の
openshift.io/internal-registry-pull-secret-refアノテーションの調整を試み、ループが発生するため、シークレットは OpenShift Container Platform 4.16 で永続的に生成されていました。この更新により、Operator はこの新しいアノテーションを無視するようになりました。(TRACING-4435)
1.10. Red Hat build of OpenTelemetry 3.2.1 のリリースノート
Red Hat build of OpenTelemetry は、Red Hat build of OpenTelemetry Operator を通じて提供されます。
1.10.1. CVE
このリリースでは、以下の CVE が修正されました。
1.10.2. 新機能および機能拡張
この更新では、次の機能拡張が導入されています。
- Red Hat build of OpenTelemetry 3.2.1 は、オープンソースの OpenTelemetry リリース 0.102.1 に基づいています。
1.11. Red Hat build of OpenTelemetry 3.2 のリリースノート
Red Hat build of OpenTelemetry は、Red Hat build of OpenTelemetry Operator を通じて提供されます。
1.11.1. テクノロジープレビュー機能
この更新では、次のテクノロジープレビュー機能が導入されています。
- Host Metrics Receiver
- OIDC Auth Extension
- Kubernetes Cluster Receiver
- Kubernetes Events Receiver
- Kubernetes Objects Receiver
- Load-Balancing Exporter
- Kubelet Stats Receiver
- Cumulative to Delta Processor
- Forward Connector
- Journald Receiver
- Filelog Receiver
- File Storage Extension
これらの機能は、いずれもテクノロジープレビューのみの機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
1.11.2. 新機能および機能拡張
この更新では、次の機能拡張が導入されています。
- Red Hat build of OpenTelemetry 3.2 は、オープンソースの OpenTelemetry リリース 0.100.0 に基づいています。
1.11.3. 非推奨の機能
Red Hat build of OpenTelemetry 3.2 で、OpenTelemetry Collector カスタムリソースでの空の値と null キーワードの使用が非推奨になりました。今後のリリースでサポートされなくなる予定です。現在のリリースライフサイクル中はこの構文のバグ修正とサポートが提供されますが、この構文はサポートされなくなる予定です。空の値と null キーワードの代わりに、OpenTelemetry Collector カスタムリソースを更新して、空の JSON オブジェクト (開き中括弧と閉じ中括弧 {}) を含めることができます。
1.11.4. バグ修正
この更新では、次のバグ修正が導入されています。
-
この更新前は、Red Hat build of OpenTelemetry をインストールするときに、Operator モニタリングを有効にするチェックボックスが Web コンソールで使用できませんでした。その結果、
openshift-opentelemetry-Operatornamespace に ServiceMonitor リソースが作成されませんでした。この更新により、Web コンソールに Red Hat build of OpenTelemetry Operator のチェックボックスが表示され、インストール中に Operator モニタリングを有効にできるようになります。(TRACING-3761)
1.12. Red Hat build of OpenTelemetry 3.1.1 のリリースノート
Red Hat build of OpenTelemetry は、Red Hat build of OpenTelemetry Operator を通じて提供されます。
1.12.1. CVE
このリリースでは、CVE-2023-39326 が修正されています。
1.13. Red Hat build of OpenTelemetry 3.1 のリリースノート
Red Hat build of OpenTelemetry は、Red Hat build of OpenTelemetry Operator を通じて提供されます。
1.13.1. テクノロジープレビュー機能
この更新では、次のテクノロジープレビュー機能が導入されています。
-
Target Allocator は、OpenTelemetry Operator のオプションのコンポーネントです。デプロイされた OpenTelemetry Collector インスタンスのフリート全体の Prometheus Receiver スクレイプターゲットをシャード化します。Target Allocator は、Prometheus
PodMonitorおよびServiceMonitorカスタムリソースと統合します。
Target Allocator はテクノロジープレビュー機能のみです。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
1.13.2. 新機能および機能拡張
この更新では、次の機能拡張が導入されています。
- Red Hat build of OpenTelemetry 3.1 は、オープンソースの OpenTelemetry リリース 0.93.0 に基づいています。
1.14. Red Hat build of OpenTelemetry 3.0 のリリースノート
1.14.1. 新機能および機能拡張
この更新では、次の機能拡張が導入されています。
- Red Hat build of OpenTelemetry 3.0 は、オープンソースの OpenTelemetry リリース 0.89.0 に基づいています。
- OpenShift distributed tracing data collection Operator は、Red Hat build of OpenTelemetry Operator という名前に変更されました。
- ARM アーキテクチャーのサポート。
- メトリクス収集用の Prometheus Receiver のサポート。
- トレースとメトリクスを Kafka に送信するための Kafka レシーバーおよびエクスポーターのサポート。
- クラスター全体のプロキシー環境のサポート。
-
Prometheus エクスポーターが有効になっている場合、Red Hat build of OpenTelemetry Operator は Prometheus
ServiceMonitorカスタムリソースを作成します。 -
この Operator は、アップストリームの OpenTelemetry 自動計装ライブラリーを注入できる
Instrumentationカスタムリソースを有効にします。
1.14.2. 削除通知
Red Hat build of OpenTelemetry 3.0 では、Jaeger エクスポーターが削除されました。バグ修正とサポートは、2.9 ライフサイクルの終了までのみ提供されます。Jaeger Collector にデータを送信するための Jaeger エクスポーターの代わりに、OTLP エクスポーターを使用できます。
1.14.3. バグ修正
この更新では、次のバグ修正が導入されています。
-
oc adm catalog mirrorCLI コマンドを使用する場合の、非接続環境のサポートが修正されました。
1.14.4. 既知の問題
現在、次のような既知の問題があります。
現在、Red Hat build of OpenTelemetry Operator のクラスターモニタリングは、バグ (TRACING-3761) により無効になっています。このバグにより、クラスター監視およびサービスモニターオブジェクトに必要なラベル
openshift.io/cluster-monitoring=trueが欠落しているため、クラスター監視が Red Hat build of OpenTelemetry Operator からメトリクスをスクレイピングできなくなっています。回避策
次のようにクラスター監視を有効にできます。
-
Operator namespace に次のラベルを追加します:
oc label namespace openshift-opentelemetry-operator openshift.io/cluster-monitoring=true サービスモニター、ロール、およびロールバインディングを作成します。
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
-
Operator namespace に次のラベルを追加します:
1.15. Red Hat build of OpenTelemetry 2.9.2 のリリースノート
Red Hat build of OpenTelemetry はテクノロジープレビュー機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
Red Hat build of OpenTelemetry 2.9.2 は、オープンソースの OpenTelemetry リリース 0.81.0 に基づいています。
1.15.1. CVE
- このリリースでは、CVE-2023-46234 が修正されています。
1.15.2. 既知の問題
現在、次のような既知の問題があります。
- 現在は、Operator の成熟度 を Level IV の Deep Insights に手動で設定する必要があります。(TRACING-3431)
1.16. Red Hat build of OpenTelemetry 2.9.1 のリリースノート
Red Hat build of OpenTelemetry はテクノロジープレビュー機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
Red Hat build of OpenTelemetry 2.9.1 は、オープンソースの OpenTelemetry リリース 0.81.0 に基づいています。
1.16.1. CVE
- このリリースでは、CVE-2023-44487 が修正されています。
1.16.2. 既知の問題
現在、次のような既知の問題があります。
- 現在は、Operator の成熟度 を Level IV の Deep Insights に手動で設定する必要があります。(TRACING-3431)
1.17. Red Hat build of OpenTelemetry 2.9 のリリースノート
Red Hat build of OpenTelemetry はテクノロジープレビュー機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
Red Hat build of OpenTelemetry 2.9 は、オープンソースの OpenTelemetry リリース 0.81.0 に基づいています。
1.17.1. 新機能および機能拡張
このリリースでは、Red Hat build of OpenTelemetry に次の機能拡張が導入されています。
-
OTLP メトリクスの取り込みをサポートします。メトリクスは、Prometheus エクスポーターを使用して
user-workload-monitoringに転送し、保存できます。 -
Operator 成熟度 レベル IV、Deep Insights をサポートします。これにより、
OpenTelemetry Collectorインスタンスおよび Red Hat build of OpenTelemetry Operator のアップグレードと監視が可能になります。 - OTLP、または HTTP および HTTPS を使用して、リモートクラスターからトレースとメトリクスを報告します。
-
resourcedetectionプロセッサー経由で、OpenShift Container Platform リソース属性を収集します。 -
OpenTelemetryCollectorカスタムリソースのmanagedおよびunmanagedの状態をサポートします。
1.17.2. 既知の問題
現在、次のような既知の問題があります。
- 現在は、Operator の成熟度 を Level IV の Deep Insights に手動で設定する必要があります。(TRACING-3431)
1.18. Red Hat build of OpenTelemetry 2.8 のリリースノート
Red Hat build of OpenTelemetry はテクノロジープレビュー機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
Red Hat build of OpenTelemetry 2.8 は、オープンソースの OpenTelemetry リリース 0.74.0 に基づいています。
1.18.1. バグ修正
このリリースでは、、CVE (Common Vulnerabilities and Exposures) およびバグ修正に対応しています。
1.19. Red Hat build of OpenTelemetry 2.7 のリリースノート
Red Hat build of OpenTelemetry はテクノロジープレビュー機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
Red Hat build of OpenTelemetry 2.7 は、オープンソースの OpenTelemetry リリース 0.63.1 に基づいています。
1.19.1. バグ修正
このリリースでは、、CVE (Common Vulnerabilities and Exposures) およびバグ修正に対応しています。
1.20. Red Hat build of OpenTelemetry 2.6 のリリースノート
Red Hat build of OpenTelemetry はテクノロジープレビュー機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
Red Hat build of OpenTelemetry 2.6 は、オープンソースの OpenTelemetry リリース 0.60 に基づいています。
1.20.1. バグ修正
このリリースでは、、CVE (Common Vulnerabilities and Exposures) およびバグ修正に対応しています。
1.21. Red Hat build of OpenTelemetry 2.5 のリリースノート
Red Hat build of OpenTelemetry はテクノロジープレビュー機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
Red Hat build of OpenTelemetry 2.5 は、オープンソースの OpenTelemetry リリース 0.56 に基づいています。
1.21.1. 新機能および機能拡張
この更新では、次の機能拡張が導入されています。
- Red Hat build of OpenTelemetry Operator に Kubernetes リソース属性を収集するためのサポート
1.21.2. バグ修正
このリリースでは、、CVE (Common Vulnerabilities and Exposures) およびバグ修正に対応しています。
1.22. Red Hat build of OpenTelemetry 2.4 のリリースノート
Red Hat build of OpenTelemetry はテクノロジープレビュー機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
Red Hat build of OpenTelemetry 2.4 はオープンソースの OpenTelemetry リリース 0.49 に基づいています。
1.22.1. バグ修正
このリリースでは、、CVE (Common Vulnerabilities and Exposures) およびバグ修正に対応しています。
1.23. Red Hat build of OpenTelemetry 2.3 のリリースノート
Red Hat build of OpenTelemetry はテクノロジープレビュー機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
Red Hat build of OpenTelemetry 2.3.1 は、オープンソースの OpenTelemetry リリース 0.44.1 に基づいています。
Red Hat build of OpenTelemetry 2.3.0 は、オープンソースの OpenTelemetry リリース 0.44.0 に基づいています。
1.23.1. バグ修正
このリリースでは、、CVE (Common Vulnerabilities and Exposures) およびバグ修正に対応しています。
1.24. Red Hat build of OpenTelemetry 2.2 のリリースノート
Red Hat build of OpenTelemetry はテクノロジープレビュー機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
Red Hat build of OpenTelemetry 2.2 は、オープンソースの OpenTelemetry リリース 0.42.0 に基づいています。
1.24.1. テクノロジープレビュー機能
2.1 リリースに含まれるサポート対象外の OpenTelemetry Collector コンポーネントが削除されました。
1.24.2. バグ修正
このリリースでは、、CVE (Common Vulnerabilities and Exposures) およびバグ修正に対応しています。
1.25. Red Hat build of OpenTelemetry 2.1 のリリースノート
Red Hat build of OpenTelemetry はテクノロジープレビュー機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
Red Hat build of OpenTelemetry 2.1 は、オープンソースの OpenTelemetry リリース 0.41.1 に基づいています。
1.25.1. テクノロジープレビュー機能
このリリースでは、OpenTelemetry カスタムリソースファイルで証明書を設定する方法に重大な変更が加えられました。次の例に示すように、今回の更新では ca_file がカスタムリソースの tls の下に移動しました。
OpenTelemetry バージョン 0.33 の CA ファイル設定
OpenTelemetry バージョン 0.41.1 の CA ファイル設定
1.25.2. バグ修正
このリリースでは、、CVE (Common Vulnerabilities and Exposures) およびバグ修正に対応しています。
1.26. Red Hat build of OpenTelemetry 2.0 のリリースノート
Red Hat build of OpenTelemetry はテクノロジープレビュー機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
Red Hat build of OpenTelemetry 2.0 は、オープンソースの OpenTelemetry リリース 0.33.0 に基づいています。
このリリースでは、Red Hat build of OpenTelemetry Operator を使用してインストールする Red Hat build of OpenTelemetry が、テクノロジープレビュー機能 として追加されます。Red Hat build of OpenTelemetry は、OpenTelemetry の API と計装に基づいています。Red Hat build of OpenTelemetry には、OpenTelemetry Operator と Collector が含まれています。Collector を使用すると、OpenTelemetry または Jaeger プロトコルでトレースを受信し、そのトレースデータを Red Hat build of OpenTelemetry に送信できます。現時点では、Collector のその他の機能はサポートされていません。OpenTelemetry Collector を使用すると、開発者はベンダーに依存しない API でコードを計装できます。これにより、ベンダーのロックインを回避して、成長を続ける可観測性ツールのエコシステムを利用できます。
1.27. サポートを受ける
このドキュメントで説明されている手順、または OpenShift Container Platform 全般で問題が発生した場合は、Red Hat カスタマーポータル にアクセスしてください。
カスタマーポータルでは、次のことができます。
- Red Hat 製品に関するアーティクルおよびソリューションを対象とした Red Hat ナレッジベースの検索またはブラウズ。
- Red Hat サポートに対するサポートケースの送信。
- その他の製品ドキュメントへのアクセス。
クラスターの問題を特定するには、OpenShift Cluster Manager で Insights を使用できます。Insights により、問題の詳細と、利用可能な場合は問題の解決方法に関する情報が提供されます。
このドキュメントの改善への提案がある場合、またはエラーを見つけた場合は、最も関連性の高いドキュメントコンポーネントの Jira Issue を送信してください。セクション名や OpenShift Container Platform バージョンなどの具体的な情報を提供してください。
第2章 インストール
Red Hat build of OpenTelemetry をインストールするには、次の手順を実行します。
- Red Hat build of OpenTelemetry Operator をインストールします。
- OpenTelemetry Collector インスタンスの namespace を作成します。
-
OpenTelemetryCollectorカスタムリソースを作成して、OpenTelemetry Collector インスタンスをデプロイします。
2.1. Web コンソールからの Red Hat build of OpenTelemetry のインストール
Red Hat build of OpenTelemetry は、Web コンソールの Administrator ビューからインストールできます。
前提条件
-
cluster-adminロールを持つクラスター管理者として Web コンソールにログインしている。 -
Red Hat OpenShift Dedicated の場合、
dedicated-adminロールを持つアカウントを使用してログインしている。
手順
Red Hat build of OpenTelemetry Operator をインストールします。
-
Operators → OperatorHub に移動し、
Red Hat build of OpenTelemetry Operatorを検索します。 Red Hat が提供する Red Hat build of OpenTelemetry Operator を選択し、Install → Install → View Operator と進みます。
重要デフォルトのプリセットで Operator がインストールされます。
- Update channel → stable
- Installation mode → All namespaces on the cluster
- Installed Namespace → openshift-opentelemetry-operator
- Update approval → Automatic
- インストール済み Operator ページの Details タブの ClusterServiceVersion details で、インストールの Status が Succeeded であることを確認します。
-
Operators → OperatorHub に移動し、
-
Home → Projects → Create Project に移動して、次のステップで作成する OpenTelemetry Collector インスタンスの任意の許可されたプロジェクトを作成します。
openshift-で始まるプロジェクト名は許可されません。 OpenTelemetry Collector インスタンスを作成します。
- Operators → Installed Operators に移動します。
- OpenTelemetry Collector → Create OpenTelemetry Collector → YAML view を選択します。
YAML view で、
OpenTelemetryCollectorカスタムリソース (CR) をカスタマイズします。OpenTelemetryCollectorCR の例Copy to Clipboard Copied! Toggle word wrap Toggle overflow - Create を選択します。
検証
- Project: ドロップダウンリストを使用して、OpenTelemetry Collector インスタンスのプロジェクトを選択します。
- Operators → Installed Operators に移動して、OpenTelemetry Collector インスタンスの ステータス が Condition: Ready であることを確認します。
- Workloads → Pods に移動して、OpenTelemetry Collector インスタンスのすべてのコンポーネント Pod が実行されていることを確認します。
2.2. CLI を使用した Red Hat build of OpenTelemetry のインストール
Red Hat build of OpenTelemetry はコマンドラインからインストールできます。
前提条件
cluster-adminロールを持つクラスター管理者によるアクティブな OpenShift CLI (oc) セッション。ヒント-
OpenShift CLI (
oc) のバージョンが最新であり、OpenShift Container Platform バージョンと一致していることを確認してください。 oc loginを実行します。oc login --username=<your_username>
$ oc login --username=<your_username>Copy to Clipboard Copied! Toggle word wrap Toggle overflow
-
OpenShift CLI (
手順
Red Hat build of OpenTelemetry Operator をインストールします。
次のコマンドを実行して、Red Hat build of OpenTelemetry Operator のプロジェクトを作成します。
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 以下のコマンドを実行して、Operator グループを作成します。
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 以下のコマンドを実行して、サブスクリプションを作成します。
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 次のコマンドを実行して、Operator のステータスを確認します。
oc get csv -n openshift-opentelemetry-operator
$ oc get csv -n openshift-opentelemetry-operatorCopy to Clipboard Copied! Toggle word wrap Toggle overflow
後続のステップで作成する OpenTelemetry Collector インスタンスの任意の許可されたプロジェクトを作成します。
メタデータなしで許可されたプロジェクトを作成するには、以下のコマンドを実行します。
oc new-project <permitted_project_of_opentelemetry_collector_instance>
$ oc new-project <permitted_project_of_opentelemetry_collector_instance>1 Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
openshift-で始まるプロジェクト名は許可されません。
メタデータで許可されたプロジェクトを作成するには、以下のコマンドを実行します。
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
openshift-で始まるプロジェクト名は許可されません。
OpenTelemetry Collector 用に作成したプロジェクトに OpenTelemetry Collector インスタンスを作成します。
注記同じクラスター上の別々のプロジェクトに複数の OpenTelemetry Collector インスタンスを作成できます。
OpenTelemetryCollectorカスタムリソース (CR) をカスタマイズします。OpenTelemetryCollectorCR の例Copy to Clipboard Copied! Toggle word wrap Toggle overflow 次のコマンドを実行して、カスタマイズされた CR を適用します。
oc apply -f - << EOF <OpenTelemetryCollector_custom_resource> EOF
$ oc apply -f - << EOF <OpenTelemetryCollector_custom_resource> EOFCopy to Clipboard Copied! Toggle word wrap Toggle overflow
検証
次のコマンドを実行して、OpenTelemetry Collector Pod の
status.phaseがRunningで、conditionsがtype: Readyであることを確認します。oc get pod -l app.kubernetes.io/managed-by=opentelemetry-operator,app.kubernetes.io/instance=<namespace>.<instance_name> -o yaml
$ oc get pod -l app.kubernetes.io/managed-by=opentelemetry-operator,app.kubernetes.io/instance=<namespace>.<instance_name> -o yamlCopy to Clipboard Copied! Toggle word wrap Toggle overflow 次のコマンドを実行して、OpenTelemetry Collector サービスを取得します。
oc get service -l app.kubernetes.io/managed-by=opentelemetry-operator,app.kubernetes.io/instance=<namespace>.<instance_name>
$ oc get service -l app.kubernetes.io/managed-by=opentelemetry-operator,app.kubernetes.io/instance=<namespace>.<instance_name>Copy to Clipboard Copied! Toggle word wrap Toggle overflow
2.3. taint および toleration の使用
専用ノードで OpenTelemetry Pod をスケジュールするには、OpenShift 4 で nodeSelector と toleration を使用してインフラノードにさまざまな OpenTelemetry コンポーネントをデプロイする方法 を参照してください。
2.4. 必要な RBAC リソースの自動作成
一部の Collector コンポーネントは、RBAC リソースの設定を必要とします。
手順
Red Hat build of OpenTelemetry Operator が権限を自動的に作成できるように、
opentelemetry-operator-controller-manageサービスアカウントに次の権限を追加します。Copy to Clipboard Copied! Toggle word wrap Toggle overflow
第3章 Collector の設定
3.1. Collector の設定
Red Hat build of OpenTelemetry Operator は、Red Hat build of OpenTelemetry リソースを作成およびデプロイするときに使用されるアーキテクチャーと設定を定義するカスタムリソース定義 (CRD) ファイルを使用します。デフォルト設定をインストールすることも、ファイルを変更することもできます。
3.1.1. OpenTelemetry Collector 設定オプション
OpenTelemetry Collector は、テレメトリーデータにアクセスする 5 種類のコンポーネントで構成されます。
- レシーバー
- プロセッサー
- エクスポーター
- コネクター
- 拡張機能
カスタムリソース YAML ファイルで、コンポーネントのインスタンスを複数定義できます。コンポーネントは、設定した後に YAML ファイルの spec.config.service セクションで定義されたパイプラインで有効にする必要があります。ベストプラクティスとしては、必要なコンポーネントのみを有効にします。
OpenTelemetry Collector カスタムリソースファイルの例
- 1
- コンポーネントが設定されていても、
serviceセクションで定義されていない場合、そのコンポーネントは有効になりません。
| パラメーター | 説明 | 値 | デフォルト |
|---|---|---|---|
receivers: | レシーバーは、データが Collector に到達する方法です。デフォルトでは、レシーバーは設定されていません。設定が有効とみなされるためには、少なくとも 1 つの有効なレシーバーが必要です。レシーバーは、パイプラインに追加して有効にされます。 |
| なし |
processors: | プロセッサーは、受信したデータをエクスポートする前に処理します。デフォルトでは、プロセッサーは有効になっていません。 |
| なし |
exporters: | エクスポーターは、1 つ以上のバックエンドまたは宛先にデータを送信します。デフォルトでは、エクスポーターは設定されていません。設定が有効とみなされるためには、少なくとも 1 つの有効なエクスポーターが必要です。エクスポーターは、パイプラインに追加して有効にされます。エクスポーターはデフォルト設定で使用できますが、多くの場合、少なくとも宛先およびセキュリティー設定を指定するための設定が必要です。 |
| なし |
connectors: | コネクターはパイプラインのペアを結合します。つまり、パイプラインの終わりのエクスポーターとしてデータを消費し、パイプラインの始まりのレシーバーとしてデータを出力します。コネクターを使用して、消費されたデータを要約、複製、またはルーティングできます。 |
| なし |
extensions: | テレメトリーデータの処理を含まないタスク用のオプションのコンポーネント。 |
| なし |
service: pipelines: |
コンポーネントは、それらを | ||
service:
pipelines:
traces:
receivers:
|
レシーバーは、それらを | なし | |
service:
pipelines:
traces:
processors:
|
プロセッサーは、それらを | なし | |
service:
pipelines:
traces:
exporters:
|
エクスポーターは、それらを | なし | |
service:
pipelines:
metrics:
receivers:
|
メトリクスのレシーバーを有効にするには、 | なし | |
service:
pipelines:
metrics:
processors:
|
メトリクスのプロセッサーを有効にするには、 | なし | |
service:
pipelines:
metrics:
exporters:
|
メトリクスのエクスポーターを有効にするには、 | なし |
3.1.2. 必要な RBAC リソースの自動作成
一部の Collector コンポーネントは、RBAC リソースの設定を必要とします。
手順
Red Hat build of OpenTelemetry Operator が権限を自動的に作成できるように、
opentelemetry-operator-controller-manageサービスアカウントに次の権限を追加します。Copy to Clipboard Copied! Toggle word wrap Toggle overflow
3.2. レシーバー
レシーバーはデータを Collector に入れます。レシーバーはプッシュベースまたはプルベースにすることができます。通常、レシーバーは指定された形式のデータを受け入れて内部形式に変換し、それを適用可能なパイプラインで定義されるプロセッサーおよびエクスポーターに渡します。デフォルトでは、レシーバーは設定されていません。1 つまたは複数のレシーバーを設定する必要があります。レシーバーは 1 つまたは複数のデータソースをサポートする場合があります。
現在、Red Hat build of OpenTelemetry では、次の一般提供およびテクノロジープレビューのレシーバーが利用可能です。
3.2.1. OTLP Receiver
OTLP Receiver は、OpenTelemetry Protocol (OTLP) を使用してトレース、メトリクス、およびログを取り込みます。OTLP Receiver は、OpenTelemetry Protocol (OTLP) を使用してトレースとメトリクスを取り込みます。
OTLP Receiver が有効になっている OpenTelemetry Collector カスタムリソース
- 1
- OTLP gRPC エンドポイント。省略した場合、デフォルトの
0.0.0.0:4317が使用されます。 - 2
- サーバー側の TLS 設定。TLS 証明書へのパスを定義します。省略した場合、TLS は無効になります。
- 3
- サーバーがクライアント証明書を検証する TLS 証明書へのパス。これにより、
TLSConfigでClientCAsおよびClientAuthの値がRequireAndVerifyClientCertに設定されます。詳細は、Configof the Golang TLS package を参照してください。 - 4
- 証明書をリロードする間隔を指定します。この値が設定されていない場合、証明書はリロードされません。
reload_intervalフィールドは、ns、us(またはµs)、ms、s、m、hなどの有効な時間単位を含む文字列を受け入れます。 - 5
- OTLP HTTP エンドポイント。デフォルト値は
0.0.0.0:4318です。 - 6
- サーバー側の TLS 設定。詳細は、
grpcプロトコル設定セクションを参照してください。
3.2.2. Jaeger Receiver
Jaeger Receiver は、Jaeger 形式でトレースを取り込みます。
Jaeger Receiver が有効になっている OpenTelemetry Collector カスタムリソース
- 1
- Jaeger gRPC エンドポイント。省略した場合、デフォルトの
0.0.0.0:14250が使用されます。 - 2
- Jaeger Thrift HTTP エンドポイント。省略した場合、デフォルトの
0.0.0.0:14268が使用されます。 - 3
- Jaeger Thrift Compact エンドポイント。省略した場合、デフォルトの
0.0.0.0:6831が使用されます。 - 4
- Jaeger Thrift Binary エンドポイント。省略した場合、デフォルトの
0.0.0.0:6832が使用されます。 - 5
- サーバー側の TLS 設定。詳細は、OTLP Receiver 設定セクションを参照してください。
3.2.3. Host Metrics Receiver
Host Metrics Receiver は、OTLP 形式でメトリクスを取り込みます。
Host Metrics Receiver が有効になっている OpenTelemetry Collector カスタムリソース
- 1
- ホストメトリクス収集の時間間隔を設定します。省略した場合、デフォルト値は
1mです。 - 2
- ホストメトリクス収集の初期時間遅延を設定します。省略した場合、デフォルト値は
1sです。 - 3
- Host Metrics Receiver がルートファイルシステムの場所を認識できるように、
root_pathを設定します。Host Metrics Receiver のインスタンスを複数実行する場合は、各インスタンスに同じroot_path値を設定します。 - 4
- 有効なホストメトリクススクレーパーをリストします。使用可能なスクレーパーは、
cpu、disk、load、filesystem、memory、network、paging、processes、およびprocessです。
3.2.4. Kubernetes Objects Receiver
Kubernetes Objects Receiver は、Kubernetes API サーバーから収集されるオブジェクトをプルまたは監視します。このレシーバーは、主に Kubernetes イベントを監視しますが、あらゆる種類の Kubernetes オブジェクトを収集できます。このレシーバーはクラスター全体のテレメトリーを収集するため、すべてのデータを収集するにはこのレシーバーのインスタンスが 1 つあれば十分です。
Kubernetes Objects Receiver はテクノロジープレビューのみの機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
Kubernetes Objects Receiver が有効になっている OpenTelemetry Collector カスタムリソース
3.2.5. Kubelet Stats Receiver
Kubelet Stats Receiver は、kubelet の API サーバーからノード、Pod、コンテナー、ボリュームに関連するメトリクスを抽出します。これらのメトリクスは、さらなる分析のためにメトリクス処理パイプラインに送られます。
Kubelet Stats Receiver が有効になっている OpenTelemetry Collector カスタムリソース
- 1
- API に認証するために
K8S_NODE_NAMEを設定します。
Kubelet Stats Receiver には、OpenTelemetry Collector の実行に使用されるサービスアカウントに対する追加の権限が必要です。
サービスアカウントに必要な権限
- 1
extra_metadata_labelsまたはrequest_utilizationまたはlimit_utilizationメトリクスを使用するときに必要な権限。
3.2.6. Prometheus Receiver
Prometheus Receiver はメトリクスエンドポイントをスクレイプします。
Prometheus Receiver が有効になっている OpenTelemetry Collector カスタムリソース
3.2.7. OTLP JSON File Receiver
OTLP JSON File Receiver は、OpenTelemetry Protocol 仕様に準拠した、ProtoJSON 形式のデータを含むファイルからパイプライン情報を抽出します。処理対象ファイルの作成や修正などの変更がないか、指定されたディレクトリーを監視します。
OTLP JSON File Receiver はテクノロジープレビュー機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
OTLP JSON File Receiver が有効になっている OpenTelemetry Collector カスタムリソース
3.2.8. Zipkin Receiver
Zipkin Receiver は、Zipkin v1 および v2 形式でトレースを取り込みます。
Zipkin Receiver が有効になっている OpenTelemetry Collector カスタムリソース
3.2.9. Kafka Receiver
Kafka Receiver は、Kafka からトレース、メトリクス、ログを OTLP 形式で受信します。
Kafka Receiver はテクノロジープレビュー機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
Kafka Receiver が有効になっている OpenTelemetry Collector カスタムリソース
- 1
- Kafka ブローカーのリスト。デフォルトは
localhost:9092です。 - 2
- Kafka プロトコルのバージョン。たとえば、
2.0.0などです。これは必須フィールドです。 - 3
- 読み取り元の Kafka トピックの名前。デフォルトは
otlp_spansです。 - 4
- プレーンテキスト認証設定。省略した場合、プレーンテキスト認証は無効になります。
- 5
- クライアント側の TLS 設定。TLS 証明書へのパスを定義します。省略した場合、TLS 認証は無効になります。
- 6
- サーバーの証明書チェーンとホスト名の検証を無効にします。デフォルトは
falseです。 - 7
- ServerName は、仮想ホスティングをサポートするためにクライアントによって要求されたサーバーの名前を示します。
3.2.10. Kubernetes Cluster Receiver
Kubernetes Cluster Receiver は、Kubernetes API サーバーからクラスターメトリクスとエンティティーイベントを収集します。このレシーバーは、Kubernetes API を使用して更新に関する情報を受信します。このレシーバーの認証は、サービスアカウントを通じてのみサポートされます。
Kubernetes Cluster Receiver はテクノロジープレビューのみの機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
Kubernetes Cluster Receiver が有効になっている OpenTelemetry Collector カスタムリソース
このレシーバーには、設定済みのサービスアカウント、クラスターロールの RBAC ルール、および RBAC をサービスアカウントにバインドするクラスターロールバインディングが必要です。
ServiceAccount オブジェクト
ClusterRole オブジェクトの RBAC ルール
ClusterRoleBinding オブジェクト
3.2.11. OpenCensus Receiver
OpenCensus Receiver は、OpenCensus プロジェクトとの下位互換性を提供し、計装済みのコードベースの移行を容易にします。gRPC または HTTP および Json を介して OpenCensus 形式でメトリクスとトレースを受信します。
OpenCensus Receiver が有効になっている OpenTelemetry Collector カスタムリソース
3.2.12. Filelog Receiver
Filelog Receiver はファイルからログを追跡して解析します。
Filelog Receiver はテクノロジープレビューのみの機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
テキストファイルを追跡する Filelog Receiver が有効になっている OpenTelemetry Collector カスタムリソース
3.2.13. Journald Receiver
Journald Receiver は、systemd ジャーナルから journald イベントを解析し、ログとして送信します。
Journald Receiver はテクノロジープレビューのみの機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
Journald Receiver が有効になっている OpenTelemetry Collector カスタムリソース
- 1
- メッセージの優先度または優先度の範囲で出力をフィルタリングします。デフォルト値は
infoです。 - 2
- エントリーの読み取り元のユニットをリストします。空の場合、すべてのユニットからエントリーが読み取られます。
- 3
- 非常に長いログや出力できない文字を含むログを含めます。デフォルト値は
falseです。 - 4
trueに設定すると、ダウンストリームのコンポーネントからエラーが発生した場合に、レシーバーがファイルの読み取りを一時停止し、現在のログのバッチを再送信しようとします。デフォルト値はfalseです。- 5
- 最初の失敗から再試行するまで待機する時間の間隔。デフォルト値は
1sです。単位はms、s、m、hです。 - 6
- 再試行バックオフ間隔の上限。この値に達すると、その後の再試行間の間隔がこの値で一定に保たれます。デフォルト値は
30sです。サポートされている単位はms、s、m、hです。 - 7
- ログバッチをダウンストリームのコンシューマーに送信する試行の最大時間間隔 (再試行を含む)。この値に達すると、データが破棄されます。設定値が
0の場合、再試行が停止しません。デフォルト値は5mです。サポートされている単位はms、s、m、hです。
3.2.14. Kubernetes Events Receiver
Kubernetes Events Receiver は、Kubernetes API サーバーからイベントを収集します。収集されたイベントはログに変換されます。
Kubernetes Events Receiver はテクノロジープレビュー機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
Kubernetes Events Receiver に必要な OpenShift Container Platform の権限
Kubernetes Event Receiver が有効になっている OpenTelemetry Collector カスタムリソース
3.3. プロセッサー
プロセッサーは、データを受信してからエクスポートするまでにデータを処理します。プロセッサーはオプションです。デフォルトでは、プロセッサーは有効になっていません。プロセッサーは、すべてのデータソースに対して有効にする必要があります。すべてのプロセッサーがすべてのデータソースをサポートするわけではありません。データソースによっては、複数のプロセッサーが有効になっている可能性があります。プロセッサーの順序が重要であることに注意してください。
現在、Red Hat build of OpenTelemetry では、次の一般提供およびテクノロジープレビューのプロセッサーが利用可能です。
3.3.1. Batch Processor
Batch Processor は、トレースとメトリクスをバッチ処理して、テレメトリー情報を転送するために必要な送信接続の数を減らします。
Batch Processor を使用する場合の OpenTelemetry Collector カスタムリソースの例
| パラメーター | 説明 | デフォルト |
|---|---|---|
|
| バッチサイズに関係なく、特定の期間後にバッチを送信します。 |
|
|
| 指定された数のスパンまたはメトリクスの後に、Telemetry データのバッチを送信します。 |
|
|
|
バッチの最大許容サイズ。 |
|
|
|
アクティブにすると、 |
|
|
|
|
|
3.3.2. Memory Limiter Processor
Memory Limiter Processor は、Collector のメモリー使用量を定期的にチェックし、ソフトメモリーリミットに達したときにデータ処理を一時停止します。このプロセッサーは、トレース、メトリクス、およびログをサポートします。先行コンポーネント (通常はレシーバー) は、同じデータの送信を再試行することが想定されており、受信データにバックプレッシャーを適用する場合があります。メモリー使用量がハードリミットを超えると、Memory Limiter Processor によってガベージコレクションが強制的に実行されます。
Memory Limiter Processor を使用する場合の OpenTelemetry Collector カスタムリソースの例
| パラメーター | 説明 | デフォルト |
|---|---|---|
|
|
メモリー使用量の測定間の時間。最適な値は |
|
|
| ハードリミット。ヒープに割り当てられるメモリーの最大量 (MiB 単位)。通常、OpenTelemetry Collector の合計メモリー使用量は、この値より約 50 MiB 大きくなります。 |
|
|
|
スパイクリミット。これは、予想されるメモリー使用量の最大スパイク (MiB 単位) です。最適な値は、 |
|
|
|
|
|
|
|
|
|
3.3.3. Resource Detection Processor
Resource Detection Processor は、OpenTelemetry のリソースセマンティック標準に合わせて、ホストリソースの詳細を識別します。このプロセッサーは、検出された情報を使用して、テレメトリーデータ内のリソース値を追加または置き換えることができます。このプロセッサーはトレースとメトリクスをサポートします。このプロセッサーは、Docket メタデータディテクターや OTEL_RESOURCE_ATTRIBUTES 環境変数ディテクターなど、複数のディテクターで使用できます。
Resource Detection Processor はテクノロジープレビュー機能のみです。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
Resource Detection Processor に必要な OpenShift Container Platform の権限
Resource Detection Processor を使用する OpenTelemetry Collector
環境変数ディテクターを備えた Resource Detection Processor を使用する OpenTelemetry Collector
- 1
- 使用するディテクターを指定します。この例では、環境ディテクターが指定されています。
3.3.4. Attributes Processor
Attributes Processor は、スパン、ログ、またはメトリクスの属性を変更できます。入力データをフィルタリングして照合し、特定のアクションに対してそのようなデータを含めたり除外したりするようにこのプロセッサーを設定できます。
このプロセッサーはアクションのリストを操作し、設定で指定された順序でアクションを実行します。次のアクションがサポートされています。
- Insert
- 指定されたキーがまだ存在しない場合は、入力データに新しい属性を挿入します。
- 更新
- キーがすでに存在する場合は、入力データの属性を更新します。
- Upsert
- 挿入アクションと更新アクションを組み合わせます。キーがまだ存在しない場合は、新しい属性を挿入します。キーがすでに存在する場合は属性を更新します。
- Delete
- 入力データから属性を削除します。
- Hash
- 既存の属性値を SHA1 としてハッシュします。
- Extract
-
正規表現ルールを使用して、ルールで定義された入力キーからターゲットキーまでの値を抽出します。ターゲットキーがすでに存在する場合は、Span Processor の
to_attributes設定と同様に、既存の属性をソースとしてターゲットキーがオーバーライドされます。 - Convert
- 既存の属性を指定された型に変換します。
Attributes Processor を使用する OpenTelemetry Collector
3.3.5. Resource Processor
Resource Processor は、リソース属性に変更を適用します。このプロセッサーは、トレース、メトリクス、およびログをサポートします。
Resource Detection Processor を使用する OpenTelemetry Collector
属性は、属性の削除、属性の挿入、または属性のアップサートなど、リソース属性に適用されるアクションを表します。
3.3.6. Span Processor
Span Processor は、スパン属性に基づいてスパン名を変更するか、スパン名からスパン属性を抽出します。このプロセッサーは、スパンのステータスを変更したり、スパンを追加したり除外したりすることもできます。このプロセッサーはトレースをサポートしています。
スパンの名前変更には、from_attributes 設定を使用して、新しい名前の属性を指定する必要があります。
Span Processor はテクノロジープレビュー機能のみです。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
スパンの名前変更に Span Processor を使用する OpenTelemetry Collector
このプロセッサーを使用して、スパン名から属性を抽出できます。
スパン名からの属性抽出に Span Processor を使用する OpenTelemetry Collector
- 1
- このルールは、抽出の実行方法を定義します。さらにルールを定義できます。たとえば、この場合、正規表現が名前と一致すると、
documentID属性が作成されます。この例では、入力スパン名が/api/v1/document/12345678/updateの場合、出力スパン名は/api/v1/document/{documentId}/updateとなり、新しい"documentId"="12345678"属性がスパンに追加されます。
スパンステータスを変更できます。
ステータス変更に Span Processor を使用する OpenTelemetry Collector
3.3.7. Kubernetes Attributes Processor
Kubernetes Attributes Processor では、Kubernetes メタデータを使用して、スパン、メトリクス、およびログリソース属性を自動的に設定できます。このプロセッサーは、トレース、メトリクス、およびログをサポートします。このプロセッサーは、Kubernetes リソースを自動的に識別し、そこからメタデータを抽出して、この抽出されたメタデータをリソース属性として関連するスパン、メトリクス、ログに組み込みます。Kubernetes API を利用してクラスター内で動作しているすべての Pod を検出し、IP アドレス、Pod UID、およびその他の関連メタデータの記録を維持します。
Kubernetes Attributes Processor に必要な最小限の OpenShift Container Platform 権限
Kubernetes Attributes Processor を使用する OpenTelemetry Collector
3.3.8. Filter Processor
Filter Processor は、OpenTelemetry Transformation Language を活用して、テレメトリーデータを破棄する基準を確立します。これらの条件のいずれかが満たされると、テレメトリーデータは破棄されます。OR 論理演算子を使用すると、条件を組み合わせることができます。このプロセッサーは、トレース、メトリクス、およびログをサポートします。
Filter Processor はテクノロジープレビュー機能のみです。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
OTLP Exporter が有効になっている OpenTelemetry Collector カスタムリソース
3.3.9. Routing Processor
Routing Processor は、ログ、メトリクス、またはトレースを特定のエクスポーターにルーティングします。このプロセッサーは、リソース属性や、受信した gRPC またはプレーン HTTP 要求からヘッダーを読み取り、読み取った値に応じてトレース情報を関連するエクスポーターに送信できます。
Routing Processor はテクノロジープレビュー機能のみです。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
OTLP Exporter が有効になっている OpenTelemetry Collector カスタムリソース
必要に応じて、attribute_source 設定を作成して、from_attribute フィールドで指定した属性を検索する場所を定義することもできます。サポートされる値は、HTTP ヘッダーを含むコンテキストを検索するための context と、リソース属性を検索するための resource です。
3.3.10. Cumulative-to-Delta Processor
Cumulative-to-Delta Processor は、モノトニックな累積合計メトリクスおよびヒストグラムメトリクスをモノトニックなデルタメトリクスに変換します。
include: または exclude: フィールドを使用し、strict メトリクス名一致または regexp メトリクス名一致を指定すると、メトリクスをフィルタリングできます。
このプロセッサーはメトリクスの前の値を保存することで差分を計算します。そのため、複数の Collector のデプロイメントではなく、1 つのステートフルな Collector インスタンスにメトリクスデータを送信するようにメトリクスソースを設定する必要があります。
このプロセッサーは、モノトニック以外の合計と指数ヒストグラムを変換しません。
Cumulative-to-Delta Processor はテクノロジープレビュー機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
Cumulative-to-Delta Processor が有効になっている OpenTelemetry Collector カスタムリソースの例
- 1
- Collector のライフサイクルをメトリクスソースに関連付けるには、累積的な時間的メトリクスを出力するアプリケーションのサイドカーとして Collector を実行できます。
- 2
- オプション: このスタンザで、変換するメトリクスを明示的に定義することにより、プロセッサーが変換するメトリクスを制限できます。このフィールドを省略すると、プロセッサーは
excludeフィールドにリストされているメトリクスを除くすべてのメトリクスを変換します。 - 3
metricsフィールドに指定した値を、strictパラメーターを使用して完全一致として定義するか、regexパラメーターを使用して正規表現として定義します。- 4
- 変換するメトリクスの名前をリストします。プロセッサーは、完全一致または正規表現のマッチを変換します。メトリクスが
includeフィルターとexcludeフィルターの両方に一致する場合、excludeフィルターが優先されます。 - 5
- オプション: ここでメトリクスを明示的に定義することで、特定のメトリクスを変換から除外できます。
3.3.11. Group-by-Attributes Processor
Group-by-Attributes Processor は、同じ属性を共有するすべてのスパン、ログレコード、メトリクスデータポイントを、その属性に一致するリソースに再割り当てすることでグループ化します。
Group-by-Attributes Processor はテクノロジープレビュー機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
少なくとも、このプロセッサーを設定するには、次の例のように、スパン、ログレコード、またはメトリクスデータポイントをグループ化するために使用する属性キーの配列を指定する必要があります。
Group-by-Attributes Processor を使用する場合の OpenTelemetry Collector カスタムリソースの例
3.3.12. Transform Processor
Transform Processor を使用すると、指定したルールに基づいて、OpenTelemetry Transformation Language (OTTL) でテレメトリーデータを変更できます。このプロセッサーは、シグナルタイプごとに、特定の OTTL コンテキストタイプに関連付けられた一連の条件とステートメントを処理し、設定で指定されたとおりに、受信したテレメトリーデータに対して条件とステートメントを順番に実行します。各条件とステートメントで、さまざまな関数を使用してテレメトリーデータにアクセスおよび変更できます。そのため、条件を使用して関数を実行するかどうかを決定できます。
ステートメントは、すべて OTTL で記述します。さまざまなシグナル、トレース、メトリクス、ログに対して複数のコンテキストステートメントを設定できます。context タイプの値で、関連するステートメントを解釈するときにプロセッサーが使用する必要がある OTTL コンテキストを指定します。
Transform Processor はテクノロジープレビュー機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
設定の概要
Transform Processor を使用する場合の OpenTelemetry Collector カスタムリソースの例
| シグナルステートメント | 有効なコンテキスト |
|---|---|
|
|
|
|
|
|
|
|
|
| 値 | 説明 |
|---|---|
|
| ステートメントによって返されたエラーを無視してログに記録し、次のステートメントに進みます。 |
|
| ステートメントによって返されたエラーを無視してログに記録せず、次のステートメントに進みます。 |
|
| パイプラインにエラーを返し、ペイロードをドロップします。暗黙のデフォルト設定です。 |
3.3.13. Tail Sampling Processor
Tail Sampling Processor は、すべてのスパンの完了時に、ユーザー定義のポリシーに従ってトレースをサンプリングします。テールベースのサンプリングを使用すると、関心のあるトレースをフィルタリングし、データの取り込みと保存のコストを削減できます。
Tail Sampling Processor はテクノロジープレビュー機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
このプロセッサーは、スパンを新しいバッチに再構成し、スパンから元のコンテキストを削除します。
- このプロセッサーは、パイプラインにおいて、コンテキストに依存するプロセッサーの下流に配置してください。たとえば、Kubernetes Attributes Processor の後に配置します。
- Collector をスケーリングする場合は、指定されたサンプリングポリシーに基づいてこのプロセッサーがサンプリングに関する決定を正しく行えるように、1 つの Collector インスタンスが同じトレースのすべてのスパンを受信するようにしてください。これを実現するには、2 つの Collector レイヤーをセットアップします。1 つ目の Collector レイヤーには Load Balancing Exporter を設定し、2 つ目の Collector レイヤーには Tail Sampling Processor を設定します。
Tail Sampling Processor を使用する場合の OpenTelemetry Collector カスタムリソースの例
次のリストからポリシーを選択して組み合わせることができます。
次のポリシーはすべてのトレースをサンプリングします。
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 次のポリシーは、指定された範囲内の期間のトレースのみをサンプリングします。
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- 指定されている
5000および10000という値は例です。最も早い開始時刻の値と最も遅い終了時刻の値を確認することで、必要なレイテンシーの値を推定できます。upper_threshold_msフィールドを省略すると、このポリシーは指定されたthreshold_ms値を超えるすべてのレイテンシーをサンプリングします。
次のポリシーは、リソースおよびレコード属性の数値のマッチによってトレースをサンプリングします。
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- 指定されている
50および100という値は例です。
次のポリシーは、トレースの一部のみをサンプリングします。
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- 指定されている
10という値は例です。
次のポリシーは、ステータスコード (
OK、ERROR、またはUNSET) 別にトレースをサンプリングします。Copy to Clipboard Copied! Toggle word wrap Toggle overflow 次のポリシーは、リソースおよびレコード属性の文字列値のマッチによってトレースをサンプリングします。
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- このポリシー定義は、完全一致と正規表現による値のマッチングの両方をサポートしています。
cache_max_sizeフィールドに指定されている10という値は例です。
次のポリシーは、1 秒あたりのスパン数のレートによってトレースをサンプリングします。
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- 指定されている
35という値は例です。
次のポリシーは、スパンの最小数と最大数 (両端の値を含む) によってトレースをサンプリングします。
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- トレース内の全スパンの合計がしきい値の範囲外である場合、トレースはサンプリングされません。指定されている
2および20という値は例です。
次のポリシーは、
TraceState値のマッチによってトレースをサンプリングします。Copy to Clipboard Copied! Toggle word wrap Toggle overflow 次のポリシーは、ブール属性 (リソースとレコード) によってトレースをサンプリングします。
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 次のポリシーは、スパンまたはスパンイベントの特定の OTTL ブール条件によってトレースをサンプリングします。
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 次のポリシーは、複数のポリシーの組み合わせに基づいてトレースをサンプリングする
ANDポリシーです。Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- 指定されている
50および100という値は例です。
次のポリシーは、複数のポリシーの組み合わせに基づいてサンプリングからトレースをドロップする
DROPポリシーです。Copy to Clipboard Copied! Toggle word wrap Toggle overflow 次のポリシーは、上記のサンプラーを組み合わせて、順序付けとサンプラーごとのレート割り当てを使用してトレースをサンプリングします。
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1 2
- 適用されるポリシーの順序に従ってスパンの割合を割り当てます。たとえば、
max_total_spans_per_secondフィールドに100という値を設定した場合、rate_allocationセクションで次のように値を設定できます。policy: <composite_policy_1>セクションで、50パーセントの値を設定して 1 秒あたり 50 スパンを割り当てます。policy: <composite_policy_2>セクションで、25パーセントの値を設定して 1 秒あたり 25 スパンを割り当てます。残りの容量を埋めるには、name: <composite_policy_3>セクションのtypeフィールドにalways_sample値を設定できます。
3.4. エクスポーター
エクスポーターは、1 つ以上のバックエンドまたは宛先にデータを送信します。エクスポーターはプッシュベースまたはプルベースにすることができます。デフォルトでは、エクスポーターは設定されていません。1 つまたは複数のエクスポーターを設定する必要があります。エクスポーターは 1 つ以上のデータソースをサポートできます。エクスポーターはデフォルト設定で使用できますが、多くの場合、少なくとも宛先およびセキュリティー設定を指定するための設定が必要です。
現在、Red Hat build of OpenTelemetry では、次の一般提供およびテクノロジープレビューのエクスポーターが利用可能です。
3.4.1. OTLP Exporter
OTLP gRPC Exporter は、OpenTelemetry Protocol (OTLP) を使用してトレースとメトリクスをエクスポートします。
OTLP Exporter が有効になっている OpenTelemetry Collector カスタムリソース
- 1
- OTLP gRPC エンドポイント。
https://スキームが使用される場合、クライアントトランスポートセキュリティーが有効になり、tlsのinsecure設定をオーバーライドします。 - 2
- クライアント側の TLS 設定。TLS 証明書へのパスを定義します。
- 3
trueに設定すると、クライアントトランスポートセキュリティーは無効になります。デフォルト値はfalseです。- 4
trueに設定されている場合、証明書の検証は省略します。デフォルト値はfalseです。- 5
- 証明書をリロードする間隔を指定します。この値が設定されていない場合、証明書はリロードされません。
reload_intervalは、ns、us(またはµs)、ms、s、m、hなどの有効な時間単位を含む文字列を受け入れます。 - 6
- 要求の authority ヘッダーフィールドなど、認証局の仮想ホスト名をオーバーライドします。これをテストに使用できます。
- 7
- ヘッダーは、接続が確立されている間に実行されるすべての要求に対して送信されます。
3.4.2. OTLP HTTP Exporter
OTLP HTTP Exporter は、OpenTelemetry プロトコル (OTLP) を使用してトレースとメトリクスをエクスポートします。
OTLP Exporter が有効になっている OpenTelemetry Collector カスタムリソース
3.4.3. Debug Exporter
デバッグエクスポーターは、トレースとメトリクスを標準出力に出力します。
Debug Exporter が有効になっている OpenTelemetry Collector カスタムリソース
- 1
- デバッグエクスポートの詳細度:
detailed、normal、またはbasic。detailedに設定すると、パイプラインデータの詳細がログに記録されます。デフォルトはnormalです。 - 2
- 1 秒あたりに記録されるメッセージの初期数。デフォルト値は、1 秒あたり
2メッセージです。 - 3
- 初期のメッセージ数 (
sampling_initialの値) が記録された後のサンプリングレート。デフォルト値は1で、デフォルトで無効になっています。この値が1より大きい場合、サンプリングは有効です。詳細は、Go プロジェクトの Web サイトにあるzapcoreパッケージの sampler 関数 のページを参照してください。 - 4
trueに設定すると、エクスポーターの Collector の内部ロガーから出力できるようになります。
3.4.4. Load Balancing Exporter
Load Balancing Exporter は、routing_key 設定に従って、スパン、メトリクス、およびログを一貫してエクスポートします。
Load Balancing Exporter はテクノロジープレビューの機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
Load Balancing Exporter が有効になっている OpenTelemetry Collector カスタムリソース
- 1
routing_key: serviceは、正確な集計を提供するために、同じサービス名のスパンを同じ Collector インスタンスにエクスポートします。routing_key: traceIDは、traceIDに基づいてスパンをエクスポートします。暗黙のデフォルトは、traceIDベースのルーティングです。- 2
- サポートされている負荷分散プロトコルは、OTLP だけです。OTLP Exporter のオプションはすべてサポートされています。
- 3
- 設定できるリゾルバーは 1 つだけです。
- 4
- 静的リゾルバーは、リストされたエンドポイント全体に負荷を分散します。
- 5
- DNS リゾルバーは、Kubernetes ヘッドレスサービスでのみ使用できます。
- 6
- Kubernetes リゾルバーが推奨されます。
3.4.5. Prometheus Exporter
Prometheus Exporter は、Prometheus または OpenMetrics 形式でメトリクスをエクスポートします。
Prometheus Exporter はテクノロジープレビューのみの機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
Prometheus Exporter が有効になっている OpenTelemetry Collector カスタムリソース
- 1
- メトリクスが公開されるネットワークエンドポイント。Red Hat build of OpenTelemetry Operator は、
endpointフィールドで指定されたポートを<instance_name>-collectorサービスに自動的に公開します。 - 2
- サーバー側の TLS 設定。TLS 証明書へのパスを定義します。
- 3
- 設定されている場合は、提供された値でメトリクスをエクスポートします。
- 4
- エクスポートされたすべてのメトリクスに適用されるキーと値のペアのラベル。
- 5
trueの場合、メトリクスは OpenMetrics 形式を使用してエクスポートされます。エグザンプラーは、OpenMetrics 形式で、ヒストグラムメトリクスおよびモノトニックな合計メトリクス (counterなど) に対してのみエクスポートされます。デフォルトでは無効になっています。- 6
enabledがtrueの場合、すべてのリソース属性はメトリクスラベルに変換されます。デフォルトでは無効になっています。- 7
- 更新なしでメトリクスが公開される期間を定義します。デフォルトは
5mです。 - 8
- メトリクスの型と単位の接尾辞を追加します。Jaeger コンソールの監視タブが有効になっている場合は、無効にする必要があります。デフォルトは
trueです。
OpenTelemetryCollector カスタムリソース (CR) の spec.observability.metrics.enableMetrics フィールドが true に設定されている場合、OpenTelemetryCollector CR は Prometheus ServiceMonitor または PodMonitor CR を自動的に作成し、Prometheus がメトリクスをスクレイピングできるようにします。
3.4.6. Prometheus Remote Write Exporter
Prometheus Remote Write Exporter は、互換性のあるバックエンドにメトリクスをエクスポートします。
Prometheus Remote Write Exporter はテクノロジープレビュー機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
Prometheus Remote Write Exporter が有効になっている OpenTelemetry Collector カスタムリソース
- このエクスポーターは、非累積モノトニックメトリクス、ヒストグラムメトリクス、およびサマリー OTLP メトリクスをドロップします。
-
リモートの Prometheus インスタンスで、
--web.enable-remote-write-receiver機能フラグを有効にする必要があります。有効にしないと、このエクスポーターを使用してメトリクスをインスタンスにプッシュすることができません。
3.4.7. Kafka Exporter
Kafka Exporter は、ログ、メトリクス、およびトレースを Kafka にエクスポートします。このエクスポーターは、メッセージをブロックしてバッチ処理しない同期プロデューサーを使用します。スループットと回復力を高めるには、バッチ再試行プロセッサーおよびキュー再試行プロセッサーと一緒に使用する必要があります。
Kafka Exporter が有効になっている OpenTelemetry Collector カスタムリソース
- 1
- Kafka ブローカーのリスト。デフォルトは
localhost:9092です。 - 2
- Kafka プロトコルのバージョン。たとえば、
2.0.0などです。これは必須フィールドです。 - 3
- 読み取り元の Kafka トピックの名前。デフォルトは次のとおりです。トレースの場合は
otlp_spans、メトリクスの場合はotlp_metrics、ログの場合はotlp_logsです。 - 4
- プレーンテキスト認証設定。省略した場合、プレーンテキスト認証は無効になります。
- 5
- クライアント側の TLS 設定。TLS 証明書へのパスを定義します。省略した場合、TLS 認証は無効になります。
- 6
- サーバーの証明書チェーンとホスト名の検証を無効にします。デフォルトは
falseです。 - 7
- ServerName は、仮想ホスティングをサポートするためにクライアントによって要求されたサーバーの名前を示します。
3.4.8. AWS CloudWatch Logs Exporter
AWS CloudWatch Logs Exporter は、ログデータを Amazon CloudWatch Logs サービスに送信し、AWS SDK for Go とデフォルトの認証情報プロバイダーチェーンを使用してリクエストに署名します。
AWS CloudWatch Logs Exporter はテクノロジープレビュー機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
AWS CloudWatch Logs Exporter が有効になっている OpenTelemetry Collector カスタムリソース
- 1
- 必須。ロググループがまだ存在しない場合は、自動的に作成されます。
- 2
- 必須。ログストリームがまだ存在しない場合は、自動的に作成されます。
- 3
- オプション: デフォルトの認証情報チェーンに AWS リージョンがまだ設定されていない場合は、リージョンを指定する必要があります。
- 4
- オプション: リクエストが転送されるデフォルトの Amazon CloudWatch Logs サービスエンドポイントをオーバーライドできます。エンドポイント値の一部として、
https://などのプロトコルを含める必要があります。リージョン別のサービスエンドポイントのリストについては、Amazon CloudWatch Logs endpoints and quotas (AWS General Reference) を参照してください。 - 5
- オプション: このパラメーターを使用すると、新しい Amazon CloudWatch ロググループのログ保持ポリシーを設定できます。このパラメーターを省略するか
0に設定すると、ログはデフォルトで期限切れになりません。保持期間 (日数) としてサポートされている値は、1、3、5、7、14、30、60、90、120、150、180、365、400、545、731、1827、2192、2557、2922、3288、または3653です。
3.4.9. AWS EMF Exporter
AWS EMF Exporter は、次の OpenTelemetry メトリクスデータポイントを AWS CloudWatch Embedded Metric Format (EMF) に変換します。
-
Int64DataPoints -
DoubleDataPoints -
SummaryDataPoints
EMF メトリクスは、PutLogEvents API を使用して Amazon CloudWatch Logs サービスに直接送信されます。
このエクスポーターを使用する利点の 1 つは、https://console.aws.amazon.com/cloudwatch/ にある Amazon CloudWatch コンソールでログとメトリクスを表示できることです。
AWS EMF Exporter はテクノロジープレビュー機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
AWS EMF Exporter が有効になっている OpenTelemetry Collector カスタムリソース
- 1
- カスタマイズしたロググループ名。
- 2
- カスタマイズしたログストリーム名。
- 3
- オプション: リソース属性をメトリクスラベルなどのテレメトリー属性に変換します。デフォルトでは無効になっています。
- 4
- ログストリームの AWS リージョン。デフォルトの認証情報プロバイダーチェーンにリージョンがまだ設定されていない場合は、リージョンを指定する必要があります。
- 5
- オプション: リクエストが転送されるデフォルトの Amazon CloudWatch Logs サービスエンドポイントをオーバーライドできます。エンドポイント値の一部として、
https://などのプロトコルを含める必要があります。リージョン別のサービスエンドポイントのリストについては、Amazon CloudWatch Logs endpoints and quotas (AWS General Reference) を参照してください。 - 6
- オプション: このパラメーターを使用すると、新しい Amazon CloudWatch ロググループのログ保持ポリシーを設定できます。このパラメーターを省略するか
0に設定すると、ログはデフォルトで期限切れになりません。保持期間 (日数) としてサポートされている値は、1、3、5、7、14、30、60、90、120、150、180、365、400、545、731、1827、2192、2557、2922、3288、または3653です。 - 7
- オプション: Amazon CloudWatch メトリクスのカスタム名前空間。
ロググループ名
log_group_name パラメーターを使用すると、ロググループ名をカスタマイズできます。このパラメーターでは、デフォルトの /metrics/default 値または次のプレースホルダーを使用できます。
/aws/metrics/{ClusterName}-
このプレースホルダーは、メトリクスデータ内の
ClusterNameまたはaws.ecs.cluster.nameリソース属性を検索し、実際のクラスター名に置き換えるために使用します。 {NodeName}-
このプレースホルダーは、
NodeNameまたはk8s.node.nameリソース属性を検索するために使用します。 {TaskId}-
このプレースホルダーは、
TaskIdまたはaws.ecs.task.idリソース属性を検索するために使用します。
リソース属性マップ内にリソース属性が見つからない場合、プレースホルダーは undefined 値に置き換えられます。
ログストリーム名
log_stream_name パラメーターを使用すると、ログストリーム名をカスタマイズできます。このパラメーターでは、デフォルトの otel-stream 値または次のプレースホルダーを使用できます。
{ClusterName}-
このプレースホルダーは、
ClusterNameまたはaws.ecs.cluster.nameリソース属性を検索するために使用します。 {ContainerInstanceId}-
このプレースホルダーは、
ContainerInstanceIdまたはaws.ecs.container.instance.idリソース属性を検索するために使用します。このリソース属性は、AWS ECS EC2 起動タイプに対してのみ有効です。 {NodeName}-
このプレースホルダーは、
NodeNameまたはk8s.node.nameリソース属性を検索するために使用します。 {TaskDefinitionFamily}-
このプレースホルダーは、
TaskDefinitionFamilyまたはaws.ecs.task.familyリソース属性を検索するために使用します。 {TaskId}-
このプレースホルダーは、メトリクスデータ内の
TaskIdまたはaws.ecs.task.idリソース属性を検索し、実際のタスク ID に置き換えるために使用します。
リソース属性マップ内にリソース属性が見つからない場合、プレースホルダーは undefined 値に置き換えられます。
3.4.10. AWS X-Ray Exporter
AWS X-Ray Exporter は、OpenTelemetry スパンを AWS X-Ray セグメントドキュメントに変換し、それを AWS X-Ray サービスに直接送信します。AWS X-Ray Exporter は、PutTraceSegments API を使用し、AWS SDK for Go とデフォルトの認証情報プロバイダーチェーンを使用してリクエストに署名します。
AWS X-Ray Exporter はテクノロジープレビュー機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
AWS X-Ray Exporter が有効になっている OpenTelemetry Collector カスタムリソース
- 1
- AWS X-Ray サービスに送信される X-Ray セグメントの送信先リージョン。たとえば、
eu-west-1です。 - 2
- オプション: リクエストが転送されるデフォルトの Amazon CloudWatch Logs サービスエンドポイントをオーバーライドできます。エンドポイント値の一部として、
https://などのプロトコルを含める必要があります。リージョン別のサービスエンドポイントのリストについては、Amazon CloudWatch Logs endpoints and quotas (AWS General Reference) を参照してください。 - 3
- Collector を実行している AWS リソースの Amazon Resource Name (ARN)。
- 4
- X-Ray セグメントを別のアカウントにアップロードするための AWS Identity and Access Management (IAM) ロール。
- 5
- X-Ray アノテーションに変換される属性名のリスト。
- 6
- Amazon CloudWatch Logs のロググループ名のリスト。
- 7
- リクエストがタイムアウトするまでの秒数。省略した場合、デフォルト値は
30です。
3.4.11. File Exporter
File Exporter は、テレメトリーデータを永続ストレージ内のファイルに書き込みます。ローテーション、圧縮、複数のファイルへの書き込みなどのファイル操作に対応しています。このエクスポーターを使用すると、リソース属性を使用してファイル名を制御することもできます。必要な設定は path だけです。これは永続ボリュームファイルシステム内のテレメトリーファイルの保存先パスを指定するものです。
File Exporter はテクノロジープレビュー機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
File Exporter が有効になっている OpenTelemetry Collector カスタムリソース
- 1
- データを書き込むファイルシステムパス。デフォルトはありません。
- 2
- ファイルのローテーションはこのエクスポーターのオプション機能です。デフォルトでは、テレメトリーデータは 1 つのファイルにエクスポートされます。ファイルのローテーションを有効にするには、
rotation設定を追加します。 - 3
max_megabytes設定は、ファイルがローテーションされるまでに許可される最大サイズです。デフォルトは100です。- 4
max_days設定は、ファイルを保持する日数を指定します。日数はファイル名のタイムスタンプから起算されます。デフォルトはありません。- 5
max_backups設定は、複数の古いファイルを保持するためのものです。デフォルトは100です。- 6
localtime設定は、ファイルがローテーションされるときにファイル名の拡張子の前に追加するタイムスタンプのローカル時間形式を指定します。デフォルトは協定世界時 (UTC) です。- 7
- テレメトリーデータをファイルに書き込む前にエンコードする形式。デフォルトの形式は
jsonです。proto形式もサポートされています。 - 8
- ファイル圧縮は任意であり、デフォルトでは設定されていません。この設定は、ファイルにエクスポートするデータの圧縮アルゴリズムを定義します。現在、
zstd圧縮アルゴリズムのみがサポートされています。デフォルトはありません。 - 9
- フラッシュ間の時間間隔。単位のない値はナノ秒単位で設定されます。
rotation設定によってファイルのローテーションが有効になっている場合、この設定は無視されます。
3.5. コネクター
コネクターは 2 つのパイプラインを接続します。1 つのパイプラインの終了時にエクスポーターとしてデータを消費し、別のパイプラインの開始時にレシーバーとしてデータを出力します。同じまたは異なるデータ型のデータを消費および出力できます。データを生成および出力して、消費されたデータを要約することも、単にデータを複製またはルーティングすることもできます。
現在、Red Hat build of OpenTelemetry では、次の一般提供およびテクノロジープレビューのコネクターが利用可能です。
3.5.1. Count Connector
Count Connector は、エクスポーターパイプライン内のトレーススパン、トレーススパンイベント、メトリクス、メトリクスデータポイント、およびログレコードをカウントします。
Count Connector はテクノロジープレビュー機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
デフォルトのメトリクス名は次のとおりです。
-
trace.span.count -
trace.span.event.count -
metric.count -
metric.datapoint.count -
log.record.count
カスタムメトリクス名を公開することもできます。
Count Connector が有効になっている OpenTelemetry Collector カスタムリソース (CR)
- 1
- パイプライン内のエクスポーターまたはレシーバーとして Count Connector を正しく設定し、生成されたメトリクスを正しいエクスポーターにエクスポートすることが重要です。
- 2
- スパンをエクスポーターとして受信するように Count Connector を設定します。
- 3
- 生成されたメトリクスをレシーバーとして送信するように Count Connector を設定します。ヒント
Count Connector が期待どおりのメトリクスを生成していない場合は、OpenTelemetry Collector が期待どおりのスパン、メトリクス、およびログを受信しているかどうか、またテレメトリーデータが期待どおりに Count Connector を介して流れているかどうかを確認してください。Debug Exporter を使用して、受信したテレメトリーデータを検査することもできます。
Count Connector は、spans、spanevents、metrics、datapoints、logs などのフィールドを使用して設定されている場合に、定義された条件に従ってテレメトリーデータをカウントし、それらのデータをメトリクスとして公開できます。次の例を参照してください。
条件によってスパンをカウントする Count Connector の OpenTelemetry Collector CR の例
Count Connector は、spans、spanevents、metrics、datapoints、logs などのフィールドを使用して設定されている場合に、定義された属性に従ってテレメトリーデータをカウントできます。次の例を参照してください。属性のキーはテレメトリーデータに注入されます。欠落している属性については、default_value フィールドに値を定義する必要があります。
属性によってログをカウントする Count Connector の OpenTelemetry Collector CR の例
3.5.2. Routing Connector
Routing Connector は、OpenTelemetry Transformation Language (OTTL) ステートメントとして記述されたリソース属性とルーティング条件に従って、ログ、メトリクス、およびトレースを指定されたパイプラインにルーティングします。
Routing Connector はテクノロジープレビュー機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
Routing Connector が有効になっている OpenTelemetry Collector カスタムリソース
- 1
- コネクターのルーティングテーブル。
- 2
- OTTL ステートメントとして記述されたルーティング条件。
- 3
- 一致するテレメトリーデータをルーティングするための宛先パイプライン。
- 4
- どのルーティング条件も満たさないテレメトリーデータをルーティングするための宛先パイプライン。
- 5
- エラー処理モード:
propagate値は、エラーをログに記録し、ペイロードをドロップするためのものです。ignore値は、条件を無視して次の条件との一致を試行するためのものです。silent値はignoreと同じですが、エラーがログに記録されません。デフォルトはpropagateです。 - 6
trueに設定すると、ルーティング条件が満たされた最初のパイプラインにのみペイロードがルーティングされます。デフォルトはfalseです。
3.5.3. Forward Connector
Forward Connector は、同じタイプの 2 つのパイプラインを結合します。
Forward Connector はテクノロジープレビューのみの機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
Forward Connector が有効になっている OpenTelemetry Collector カスタムリソース
3.5.4. Spanmetrics Connector
Spanmetrics Connector は、スパンデータから Request, Error, and Duration (R.E.D) OpenTelemetry メトリクスを集計します。
Spanmetrics Collector が有効になっている OpenTelemetry Collector カスタムリソース
- 1
- 生成されたメトリクスのフラッシュ間隔を定義します。デフォルトは
15sです。
3.6. 拡張機能
エクステンションにより、Collector に機能が追加されます。たとえば、認証をレシーバーとエクスポーターに自動的に追加できます。
現在、Red Hat build of OpenTelemetry では、次の一般提供およびテクノロジープレビューの拡張機能が利用可能です。
3.6.1. BearerTokenAuth Extension
BearerTokenAuth Extension は、HTTP および gRPC プロトコルに基づくレシーバーとエクスポーター用のオーセンティケーターです。OpenTelemetry Collector カスタムリソースを使用して、レシーバーおよびエクスポーター側で BearerTokenAuth Extension のクライアント認証とサーバー認証を設定できます。このエクステンションは、トレース、メトリクス、およびログをサポートします。
BearerTokenAuth Extension 用にクライアント認証とサーバー認証が設定された OpenTelemetry Collector カスタムリソース
3.6.2. OAuth2Client Extension
OAuth2Client Extension は、HTTP および gRPC プロトコルに基づくエクスポーター用のオーセンティケーターです。OAuth2Client Extension のクライアント認証は、OpenTelemetry Collector カスタムリソースの別のセクションで設定されます。このエクステンションは、トレース、メトリクス、およびログをサポートします。
OAuth2Client Extension はテクノロジープレビュー機能のみです。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
OAuth2Client Extension 用にクライアント認証が設定された OpenTelemetry Collector カスタムリソース
- 1
- アイデンティティープロバイダーによって提供されるクライアント ID。
- 2
- アイデンティティープロバイダーに対してクライアントを認証するために使用される機密キー。
- 3
- キーと値のペア形式の追加のメタデータ。認証中に転送されます。たとえば
audienceは、アクセストークンの対象者を指定し、トークンの受信者を示します。 - 4
- Collector がアクセストークンを要求する OAuth2 トークンエンドポイントの URL。
- 5
- スコープは、クライアントによって要求された特定の権限またはアクセスレベルを定義します。
- 6
- トークンクライアントの Transport Layer Security (TLS) 設定。トークンを要求するときに安全な接続を確立するために使用されます。
- 7
trueに設定すると、安全でないまたは検証されていない TLS 接続を使用して、設定されたトークンエンドポイントを呼び出すように Collector が設定されます。- 8
- TLS ハンドシェイク中にサーバーの証明書を検証するために使用される認証局 (CA) ファイルへのパス。
- 9
- クライアントが必要に応じて OAuth2 サーバーに対して自身を認証するために使用する必要があるクライアント証明書ファイルへのパス。
- 10
- 認証に必要な場合にクライアント証明書と併用されるクライアントの秘密キーファイルへのパス。
- 11
- トークンクライアントのリクエストのタイムアウトを設定します。
- 12
- オーセンティケーター設定を OTLP エクスポーターに割り当てることができます。
3.6.3. File Storage Extension
File Storage Extension は、トレース、メトリクス、およびログをサポートします。このエクステンションは、状態をローカルファイルシステムに保持できます。この拡張機能は、HTTP プロトコルおよび gRPC プロトコルに基づく OpenTelemetry Protocol (OTLP) エクスポーターの送信キューを保持します。このエクステンションには、ディレクトリーへの読み取りおよび書き込みアクセスが必要です。このエクステンションはデフォルトのディレクトリーを使用できますが、デフォルトのディレクトリーがすでに存在している必要があります。
File Storage Extension はテクノロジープレビューのみの機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
OTLP 送信キューを保持する File Storage Extension が設定された OpenTelemetry Collector カスタムリソース
- 1
- テレメトリーデータを保存するディレクトリーを指定します。
- 2
- 保存されたファイルを開く際のタイムアウト期間を指定します。
- 3
- Collector が起動すると圧縮を開始します。省略した場合、デフォルトは
falseです。 - 4
- コンパクターがテレメトリーデータを保存するディレクトリーを指定します。
- 5
- 圧縮トランザクションの最大サイズを定義します。トランザクションサイズを無視するには、ゼロに設定します。省略した場合、デフォルトは
65536バイトです。 - 6
- 設定すると、各書き込み操作の後にデータベースよる
fsync呼び出しが強制的に実行されます。これにより、データベースプロセスが中断された場合にデータベースの整合性を確保できますが、パフォーマンスが低下します。 - 7
- OTLP エクスポーターデータをローカルファイルシステムにバッファーリングします。
- 8
- Collector による File Storage Extension を起動します。
3.6.4. OIDC Auth Extension
OIDC Auth Extension は、OpenID Connect (OIDC) プロトコルを使用して、レシーバーが受信した要求を認証します。認証ヘッダー内の ID トークンを発行者に対して検証し、受信した要求の認証コンテキストを更新します。
OIDC Auth Extension はテクノロジープレビューのみの機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
OIDC Auth Extension が設定された OpenTelemetry Collector カスタムリソース
3.6.5. Jaeger Remote Sampling Extension
Jaeger Remote Sampling Extension を使用すると、Jaeger のリモートサンプリング API の後にサンプリングストラテジーを提供できるようになります。このエクステンションを設定して、パイプラインの Jaeger Collector などのバッキングリモートサンプリングサーバーに、またはローカルファイルシステムから静的 JSON ファイルにリクエストをプロキシーできます。
Jaeger Remote Sampling Extension はテクノロジープレビューのみ機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
Jaeger Remote Sampling Extension が設定された OpenTelemetry Collector カスタムリソース
Jaeger Remote Sampling ストラテジーファイルの例
3.6.6. Performance Profiler Extension
Performance Profiler Extension により、Go net/http/pprof エンドポイントが有効になります。このエクステンションは、開発者がパフォーマンスプロファイルを収集し、サービスの問題を調査するために使用します。
Performance Profiler Extension はテクノロジープレビューのみの機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
Performance Profiler Extension が設定された OpenTelemetry Collector カスタムリソース
- 1
- このエクステンションがリッスンするエンドポイント。
localhost:を使用してローカルでのみ使用できるようにするか、":"を使用してすべてのネットワークインターフェイスで使用できるようにします。デフォルト値はlocalhost:1777です。 - 2
- ブロッキングイベントの一部がプロファイリングされるように設定します。プロファイリングを無効にするには、これを
0または負の整数に設定します。runtimeパッケージについては、ドキュメント を参照してください。デフォルト値は0です。 - 3
- プロファイリングされるミューテックス競合イベントの一部を設定します。プロファイリングを無効にするには、これを
0または負の整数に設定します。runtimeパッケージについては、ドキュメント を参照してください。デフォルト値は0です。 - 4
- CPU プロファイルを保存するファイルの名前。Collector が起動すると、プロファイリングが開始されます。プロファイリングは、Collector の終了時にファイルに保存されます。
3.6.7. Health Check Extension
Health Check Extension は、OpenTelemetry Collector のステータスをチェックするための HTTP URL を提供します。このエクステンションは、OpenShift の liveness および readiness プローブとして使用できます。
Health Check Extension はテクノロジープレビューのみの機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
Health Check Extension が設定された OpenTelemetry Collector カスタムリソース
3.6.8. zPages エクステンション
zPages エクステンションは、計装されたコンポーネントをリアルタイムでデバッグするためのライブデータを提供する HTTP エンドポイントを提供します。このエクステンションを使用すると、外部のバックエンドに依存せずに、プロセス内の診断やトレースとメトリクスの分析を行うことができます。このエクステンションを使用すると、提供されたエンドポイントで診断情報を監視することで、OpenTelemetry Collector と関連コンポーネントの動作を監視およびトラブルシューティングできます。
zPages エクステンションはテクノロジープレビューのみ機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
zPages エクステンションが設定された OpenTelemetry Collector カスタムリソース
- 1
- zPages エクステンションを提供するための HTTP エンドポイントを指定します。デフォルトは
localhost:55679です。
Red Hat build of OpenTelemetry Operator はこのルートを公開しないため、HTTP エンドポイントにアクセスするにはポート転送が必要です。
次の oc コマンドを実行すると、ポート転送を有効にできます。
oc port-forward pod/$(oc get pod -l app.kubernetes.io/name=instance-collector -o=jsonpath='{.items[0].metadata.name}') 55679
$ oc port-forward pod/$(oc get pod -l app.kubernetes.io/name=instance-collector -o=jsonpath='{.items[0].metadata.name}') 55679Collector は診断用に次の zPages を提供します。
- ServiceZ
-
Collector サービスの概要と、PipelineZ、ExtensionZ、FeatureZ の zPages へのリンクが表示されます。このページには、ビルドバージョンとランタイムに関する情報も表示されます。このページの URL の例は、
http://localhost:55679/debug/servicezです。 - PipelineZ
-
Collector 内のアクティブなパイプラインに関する詳細情報を表示します。このページには、パイプラインの種類、データ変更の有無、および各パイプラインに関連付けられているレシーバー、プロセッサー、エクスポーターが表示されます。このページの URL の例は、
http://localhost:55679/debug/pipelinezです。 - ExtensionZ
-
Collector 内の現在アクティブなエクステンションを表示します。このページの URL の例は、
http://localhost:55679/debug/extensionzです。 - FeatureZ
-
Collector 内で有効になっているフィーチャーゲートと、そのステータスおよび説明を表示します。このページの URL の例は、
http://localhost:55679/debug/featurezです。 - TraceZ
-
レイテンシー別に分類されたスパンを表示します。使用可能な時間範囲には、0 µs、10 µs、100 µs、1 ms、10 ms、100 ms、1 s、10 s、1 m が含まれます。このページでは、エラーサンプルをすばやく検査することもできます。このページの URL の例は、
http://localhost:55679/debug/tracezです。
3.7. Target Allocator
Target Allocator は、OpenTelemetry Operator のオプションのコンポーネントです。デプロイされた OpenTelemetry Collector インスタンスのフリート全体のスクレイプターゲットをシャード化します。Target Allocator は、Prometheus PodMonitor および ServiceMonitor カスタムリソース (CR) と統合します。Target Allocator が有効な場合、OpenTelemetry Operator が、Target Allocator サービスに接続する有効な Prometheus レシーバーに http_sd_config フィールドを追加します。
Target Allocator はテクノロジープレビュー機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
Target Allocator が有効な OpenTelemetryCollector CR の例
- 1
- Target Allocator が有効な場合、デプロイメントモードを
statefulsetに設定する必要があります。 - 2
- Target Allocator を有効にします。デフォルトは
falseです。 - 3
- Target Allocator デプロイメントのサービスアカウント名。サービスアカウントには、収集されたメトリクスにラベルを適切に設定するために、
ServiceMonitor、PodMonitorカスタムリソース、およびその他のオブジェクトをクラスターから取得するための RBAC が必要です。デフォルトのサービス名は<collector_name>-targetallocatorです。 - 4
- Prometheus
PodMonitorおよびServiceMonitorカスタムリソースとの統合を有効にします。 - 5
- Prometheus
ServiceMonitorカスタムリソースのラベルセレクター。空のままにすると、すべてのサービスモニターが有効になります。 - 6
- Prometheus
PodMonitorカスタムリソースのラベルセレクター。空のままにすると、すべての Pod モニターが有効になります。 - 7
- 最小限の空の
scrape_config: []設定オプションを指定した Prometheus Receiver。
Target Allocator デプロイメントは、Kubernetes API を使用してクラスターから関連オブジェクトを取得します。そのため、カスタム RBAC 設定が必要です。
Target Allocator のサービスアカウントの RBAC 設定
第4章 計装の設定
Red Hat build of OpenTelemetry Operator は、計装の設定を定義する Instrumentation カスタムリソースを使用します。
4.1. Red Hat build of OpenTelemetry の自動計装
Red Hat build of OpenTelemetry の自動計装を使用すると、手動でコードを変更せずにアプリケーションを自動的に計装できます。開発者と管理者は、最小限の労力と既存のコードベースへの変更でアプリケーションを監視できます。
自動計装は次のように実行されます。
- Red Hat build of OpenTelemetry Operator が、init コンテナー、または Go のサイドカーコンテナーを注入して、計装されたアプリケーションのプログラミング言語用の計装ライブラリーを追加します。
- Red Hat build of OpenTelemetry Operator が、アプリケーションのランタイム環境に必要な環境変数を設定します。この変数は、トレース、メトリクス、およびログを収集し、適切な OpenTelemetry Collector または別のテレメトリーバックエンドに送信するように自動計装ライブラリーを設定するものです。
- 注入されたライブラリーが、テレメトリーデータを収集する既知のフレームワークやライブラリー (Web サーバーやデータベースクライアントなど) に接続することにより、アプリケーションを自動的に計装します。計装されるアプリケーションのソースコードは変更されません。
- 計装が注入されたアプリケーションが実行されると、アプリケーションは自動的にテレメトリーデータを生成します。このデータは、指定された OpenTelemetry Collector または外部 OTLP エンドポイントに送信されてさらに処理されます。
自動計装を使用すると、OpenTelemetry SDK をアプリケーションコードに手動で統合しなくても、テレメトリーデータをすぐに収集できるようになります。ただし、アプリケーションによっては、特定の設定やカスタムの手動計装が必要になる場合があります。
4.2. OpenTelemetry 計装設定オプション
OpenTelemetry の Red Hat ビルドは、OpenTelemetry 自動インストルメンテーションライブラリーをワークロードに挿入して設定します。現在、Red Hat build of OpenTelemetry は、Go、Java、Node.js、Python、.NET、および Apache HTTP Server (httpd)のインストルメンテーションライブラリーの挿入をサポートしています。
Red Hat build of OpenTelemetry Operator は、計装ライブラリーの注入メカニズムのみをサポートしています。計装ライブラリーやアップストリームイメージはサポートしていません。お客様は独自の計装イメージをビルドすることも、コミュニティーイメージを使用することもできます。
4.2.1. 計装オプション
計装オプションは、Instrumentation カスタムリソース (CR) で指定されます。
サンプル Instrumentation CR
- 1
- Python の自動インストルメンテーションは、デフォルトで HTTP (HTTP/proto または HTTP/protobuf)上のプロトコルバッファーを使用します。
- 2
- エンドポイントが
:4317に設定されている場合に必要です。 - 3
- .NET 自動インストルメンテーションは、デフォルトで HTTP/proto または HTTP/protobuf 上のプロトコルバッファーを使用します。
- 4
- エンドポイントが
:4317に設定されている場合に必要です。 - 5
- Go auto-instrumentation は、デフォルトで HTTP (HTTP/proto または HTTP/protobuf)を介したプロトコルバッファーを使用します。
- 6
- エンドポイントが
:4317に設定されている場合に必要です。プロコバッファーの詳細は、概要 （プロトコルバッファードキュメント）を参照してください。
| パラメーター | 説明 | 値 |
|---|---|---|
|
| すべてのインストルメンテーションタイプに対する一般的な環境変数の定義。 | |
|
| エクスポーターの設定。 | |
|
| プロパゲーターは、プロセス間のコンテキスト伝播設定を定義します。 |
|
|
| リソース属性の設定。 | |
|
| サンプリング設定。 | |
|
| Apache HTTP Server 計装の設定。 | |
|
| .NET 計装の設定。 | |
|
| Go 計装の設定。 | |
|
| Java 計装の設定。 | |
|
| Node.js 計装の設定。 | |
|
| Python 計装の設定。 | プログラミング言語によっては、環境変数がテレメトリーの設定で機能しない場合があります。環境変数設定をサポートしない SDK の場合は、同様の設定をコードに直接追加する必要があります。詳細は、環境変数仕様 (OpenTelemetry ドキュメント)を参照してください。 |
| 自動計装 | デフォルトプロトコル |
|---|---|
| Java 1.x |
|
| Java 2.x |
|
| Python |
|
| .NET |
|
| Go |
|
| Apache HTTP サーバー |
|
4.2.2. OpenTelemetry SDK 変数の設定
OpenTelemetry Collector カスタムリソースの instrumentation.opentelemetry.io/inject-sdk アノテーションを使用すると、Instrumentation CR に応じて、次の OpenTelemetry SDK 環境変数を Pod に注入するように Red Hat build of OpenTelemetry に指示できます。
-
OTEL_SERVICE_NAME -
OTEL_TRACES_SAMPLER -
OTEL_TRACES_SAMPLER_ARG -
OTEL_PROPAGATORS -
OTEL_RESOURCE_ATTRIBUTES -
OTEL_EXPORTER_OTLP_ENDPOINT -
OTEL_EXPORTER_OTLP_CERTIFICATE -
OTEL_EXPORTER_OTLP_CLIENT_CERTIFICATE -
OTEL_EXPORTER_OTLP_CLIENT_KEY
| 値 | 説明 |
|---|---|
|
|
現在の namespace からデフォルト名を使用して |
|
|
|
|
|
現在の namespace から注入する |
|
|
別の namespace から注入する |
4.2.3. エクスポーターの設定
Instrumentation カスタムリソースは、シグナルごとに 1 つ以上のエクスポーターの設定をサポートしていますが、自動計装によって設定されるのは OTLP Exporter だけです。したがって、Collector 上の OTLP Receiver を参照するようにエンドポイントを設定する必要があります。
config map を使用したサンプルエクスポーターの TLS CA の設定
シークレットを使用したサンプルエクスポーターの mTLS の設定
- 1
- HTTPS スキームと TLS を使用して OTLP エンドポイントを指定します。
- 2
ca_file、cert_file、およびkey_file値のシークレットの名前を指定します。自動計装を注入する Pod の namespace に、シークレットがすでに存在している必要があります。- 3
- シークレット内の CA 証明書を参照します。証明書がワークロードファイルシステムにすでに存在する場合は、証明書への絶対パスを参照します。
- 4
- シークレット内のクライアント証明書を参照します。証明書がワークロードファイルシステムにすでに存在する場合は、証明書への絶対パスを参照します。
- 5
- シークレット内のクライアント鍵を参照します。鍵がワークロードファイルシステムにすでに存在する場合は、鍵への絶対パスを参照します。
CA 証明書は config map またはシークレットで提供できます。両方で指定した場合、config map がシークレットよりも優先されます。
config map と Instrumentation CR を使用した CA バンドル注入の設定例
4.2.4. Apache HTTP Server の自動計装の設定
Apache HTTP Server の自動計装はテクノロジープレビュー機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
| 名前 | 説明 | デフォルト |
|---|---|---|
|
| Apache HTTP Server に固有の属性。 | |
|
| Apache HTTP Server 設定の場所。 |
|
|
| Apache HTTP Server に固有の環境変数。 | |
|
| Apache SDK と自動計装を含むコンテナーイメージ。 | |
|
| コンピュートリソースの要件。 | |
|
| Apache HTTP Server のバージョン。 |
|
注入を有効化するための PodSpec アノテーション
instrumentation.opentelemetry.io/inject-apache-httpd: "true"
instrumentation.opentelemetry.io/inject-apache-httpd: "true"4.2.5. .NET 自動計装の設定
.NET 自動計装はテクノロジープレビュー機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
デフォルトでは、この機能はサポート対象外のアップストリームの計装ライブラリーを注入します。
| 名前 | 説明 |
|---|---|
|
| .NET に固有の環境変数。 |
|
| .NET SDK と自動計装を含むコンテナーイメージ。 |
|
| コンピュートリソースの要件。 |
.NET 自動計装では、エクスポーターのエンドポイントが 4317 に設定されている場合、必須の OTEL_EXPORTER_OTLP_ENDPOINT 環境変数を設定する必要があります。.NET 自動計装では、デフォルトで http/proto が使用され、テレメトリーデータを 4318 ポートに設定する必要があります。
注入を有効化するための PodSpec アノテーション
instrumentation.opentelemetry.io/inject-dotnet: "true"
instrumentation.opentelemetry.io/inject-dotnet: "true"4.2.6. Go 自動計装の設定
Go 自動計装はテクノロジープレビュー機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
デフォルトでは、この機能はサポート対象外のアップストリームの計装ライブラリーを注入します。
| 名前 | 説明 |
|---|---|
|
| Go に固有の環境変数。 |
|
| Go SDK と自動計装を含むコンテナーイメージ。 |
|
| コンピュートリソースの要件。 |
注入を有効化するための PodSpec アノテーション
instrumentation.opentelemetry.io/inject-go: "true" instrumentation.opentelemetry.io/otel-go-auto-target-exe: "/<path>/<to>/<container>/<executable>"
instrumentation.opentelemetry.io/inject-go: "true"
instrumentation.opentelemetry.io/otel-go-auto-target-exe: "/<path>/<to>/<container>/<executable>" - 1
- 必要な
OTEL_GO_AUTO_TARGET_EXE環境変数の値を設定します。
OpenShift クラスターの Go 自動インストルメンテーションに必要なパーミッション
OpenShift クラスターで Go 自動計装の権限を適用するための CLI コマンドは次のとおりです。
oc adm policy add-scc-to-user otel-go-instrumentation-scc -z <service_account>
$ oc adm policy add-scc-to-user otel-go-instrumentation-scc -z <service_account>4.2.7. Java 自動計装の設定
Java 自動計装はテクノロジープレビュー機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
デフォルトでは、この機能はサポート対象外のアップストリームの計装ライブラリーを注入します。
| 名前 | 説明 |
|---|---|
|
| Java に固有の環境変数。 |
|
| Java SDK と自動計装を含むコンテナーイメージ。 |
|
| コンピュートリソースの要件。 |
注入を有効化するための PodSpec アノテーション
instrumentation.opentelemetry.io/inject-java: "true"
instrumentation.opentelemetry.io/inject-java: "true"4.2.8. Node.js 自動計装の設定
Node.js 自動計装はテクノロジープレビュー機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
デフォルトでは、この機能はサポート対象外のアップストリームの計装ライブラリーを注入します。
| 名前 | 説明 |
|---|---|
|
| Node.js に固有の環境変数。 |
|
| Node.js SDK と自動計装を含むコンテナーイメージ。 |
|
| コンピュートリソースの要件。 |
注入を有効化するための PodSpec アノテーション
instrumentation.opentelemetry.io/inject-nodejs: "true"
instrumentation.opentelemetry.io/inject-nodejs: "true"4.2.9. Python 自動計装の設定
Python 自動計装はテクノロジープレビュー機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
デフォルトでは、この機能はサポート対象外のアップストリームの計装ライブラリーを注入します。
| 名前 | 説明 |
|---|---|
|
| Python に固有の環境変数。 |
|
| Python SDK と自動計装を含むコンテナーイメージ。 |
|
| コンピュートリソースの要件。 |
Python 自動計装では、エクスポーターのエンドポイントが 4317 に設定されている場合、OTEL_EXPORTER_OTLP_ENDPOINT 環境変数を設定する必要があります。Python 自動計装では、デフォルトで http/proto が使用され、テレメトリーデータを 4318 ポートに設定する必要があります。
注入を有効化するための PodSpec アノテーション
instrumentation.opentelemetry.io/inject-python: "true"
instrumentation.opentelemetry.io/inject-python: "true"4.2.10. マルチコンテナー Pod
インストルメント化は、Pod 仕様に従ってデフォルトで利用可能な最初のコンテナーに挿入されます。インジェクションのターゲットコンテナー名を指定することもできます。
Pod のアノテーション
instrumentation.opentelemetry.io/container-names: "<container_1>,<container_2>"
instrumentation.opentelemetry.io/container-names: "<container_1>,<container_2>" - 1
- 複数のコンテナーに単一のインストルメンテーションを挿入する場合は、このアノテーションを使用します。
Go 自動計装は、マルチコンテナーの自動計装注入をサポートしていません。
4.2.11. 複数の計装を使用するマルチコンテナー Pod
マルチコンテナー Pod 内の 1 つ以上のコンテナーにアプリケーション言語の計装を注入するには、次のアノテーションが必要です。
instrumentation.opentelemetry.io/<application_language>-container-names: "<container_1>,<container_2>"
instrumentation.opentelemetry.io/<application_language>-container-names: "<container_1>,<container_2>" - 1
- 注入できる計装は、コンテナーごとに 1 つの言語の計装だけです。サポートされている
<application_language>値のリストについては、次の表を参照してください。
| Language | <application_language> の値 |
|---|---|
| ApacheHTTPD |
|
| DotNet |
|
| Java |
|
| NGINX |
|
| NodeJS |
|
| Python |
|
| SDK |
|
4.2.12. Service Mesh での Instrumentation CR の使用
Red Hat OpenShift Service Mesh で Instrumentation カスタムリソース(CR)を使用する場合は、b3multi プロプターを使用する必要があります。
第5章 トレース、ログ、およびメトリクスを OpenTelemetry Collector に送信する
Red Hat ビルドの OpenTelemetry を設定して使用し、トレース、ログ、メトリクスを OpenTelemetry Collector または TempoStack インスタンスに送信できます。
OpenTelemetry Collector へのトレースとメトリクスの送信は、サイドカー注入の有無にかかわらず可能です。
5.1. サイドカー注入を使用してトレースとメトリクスを OpenTelemetry Collector に送信する
サイドカー注入を使用して、OpenTelemetry Collector インスタンスへのテレメトリーデータの送信をセットアップできます。
Red Hat build of OpenTelemetry Operator では、デプロイメントワークロードへのサイドカー注入と、OpenTelemetry Collector にテレメトリーデータを送信するための計装の自動設定が可能です。
前提条件
- Red Hat OpenShift Distributed Tracing Platform がインストールされ、TempoStack インスタンスがデプロイされている。
Web コンソールまたは OpenShift CLI (
oc) を使用してクラスターにアクセスできる。-
cluster-adminロールを持つクラスター管理者として Web コンソールにログインしている。 -
cluster-adminロールを持つクラスター管理者によるアクティブな OpenShift CLI (oc) セッション。 -
Red Hat OpenShift Dedicated を使用する場合は
dedicated-adminロールを持つアカウント。
-
手順
OpenTelemetry Collector インスタンスのプロジェクトを作成します。
apiVersion: project.openshift.io/v1 kind: Project metadata: name: observability
apiVersion: project.openshift.io/v1 kind: Project metadata: name: observabilityCopy to Clipboard Copied! Toggle word wrap Toggle overflow サービスアカウントを作成します。
apiVersion: v1 kind: ServiceAccount metadata: name: otel-collector-sidecar namespace: observability
apiVersion: v1 kind: ServiceAccount metadata: name: otel-collector-sidecar namespace: observabilityCopy to Clipboard Copied! Toggle word wrap Toggle overflow k8sattributesおよびresourcedetectionプロセッサーの権限をサービスアカウントに付与します。Copy to Clipboard Copied! Toggle word wrap Toggle overflow OpenTelemetry Collector をサイドカーとしてデプロイします。
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- これは、
<example>Tempo Operator を使用してデプロイされた TempoStack インスタンスのゲートウェイを指します。
-
otel-collector-sidecarサービスアカウントを使用してデプロイメントを作成します。 -
sidecar.opentelemetry.io/inject: "true"アノテーションをDeploymentオブジェクトに追加します。これにより、ワークロードから OpenTelemetry Collector インスタンスにデータを送信するために必要なすべての環境変数が注入されます。
5.2. サイドカー注入を使用せずにトレースとメトリクスを OpenTelemetry Collector に送信する
サイドカー注入を使用せずに、テレメトリーデータを OpenTelemetry Collector インスタンスに送信するようにセットアップできます。これには、いくつかの環境変数を手動で設定する必要があります。
前提条件
- Red Hat OpenShift Distributed Tracing Platform がインストールされ、TempoStack インスタンスがデプロイされている。
Web コンソールまたは OpenShift CLI (
oc) を使用してクラスターにアクセスできる。-
cluster-adminロールを持つクラスター管理者として Web コンソールにログインしている。 -
cluster-adminロールを持つクラスター管理者によるアクティブな OpenShift CLI (oc) セッション。 -
Red Hat OpenShift Dedicated を使用する場合は
dedicated-adminロールを持つアカウント。
-
手順
OpenTelemetry Collector インスタンスのプロジェクトを作成します。
apiVersion: project.openshift.io/v1 kind: Project metadata: name: observability
apiVersion: project.openshift.io/v1 kind: Project metadata: name: observabilityCopy to Clipboard Copied! Toggle word wrap Toggle overflow サービスアカウントを作成します。
apiVersion: v1 kind: ServiceAccount metadata: name: otel-collector-deployment namespace: observability
apiVersion: v1 kind: ServiceAccount metadata: name: otel-collector-deployment namespace: observabilityCopy to Clipboard Copied! Toggle word wrap Toggle overflow k8sattributesおよびresourcedetectionプロセッサーの権限をサービスアカウントに付与します。Copy to Clipboard Copied! Toggle word wrap Toggle overflow OpenTelemetryCollectorカスタムリソースを使用して OpenTelemetry Collector インスタンスをデプロイします。Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- これは、
<example>Tempo Operator を使用してデプロイされた TempoStack インスタンスのゲートウェイを指します。
計装されたアプリケーションを使用してコンテナーに環境変数を設定します。
Expand 名前 説明 デフォルト値 OTEL_SERVICE_NAMEservice.nameリソース属性の値を設定します。""OTEL_EXPORTER_OTLP_ENDPOINTオプションで指定したポート番号を持つシグナル型のベースエンドポイント URL。
https://localhost:4317OTEL_EXPORTER_OTLP_CERTIFICATEgRPC クライアントの TLS 認証情報の証明書ファイルへのパス。
https://localhost:4317OTEL_TRACES_SAMPLERトレースに使用されるサンプラー。
parentbased_always_onOTEL_EXPORTER_OTLP_PROTOCOLOTLP エクスポーターのトランスポートプロトコル。
grpcOTEL_EXPORTER_OTLP_TIMEOUTOTLP エクスポーターが各バッチエクスポートを待機する最大時間間隔。
10sOTEL_EXPORTER_OTLP_INSECUREgRPC リクエストのクライアントトランスポートセキュリティーを無効にします。HTTPS スキーマはこれをオーバーライドします。
False
第6章 モニタリングスタックのメトリクスの設定
クラスター管理者は、OpenTelemetry Collector カスタムリソース (CR) を設定して、次のタスクを実行できます。
-
Collector のパイプラインメトリクスと有効な Prometheus エクスポーターをスクレイプするための Prometheus
ServiceMonitorCR を作成します。 - クラスター内モニタリングスタックからメトリクスを取得するように Prometheus Receiver を設定します。
6.1. モニタリングスタックにメトリクスを送信するための設定
OpenTelemetryCollector カスタムリソース (CR) を設定して、サイドカーデプロイメント用の Prometheus ServiceMonitor CR または PodMonitor CR を作成できます。ServiceMonitor は、Collector の内部メトリクスエンドポイントと Prometheus エクスポーターメトリクスエンドポイントをスクレイピングできます。
Prometheus エクスポーターを使用した OpenTelemetry Collector CR の例
- 1
- Red Hat build of OpenTelemetry Operator を設定して Prometheus
ServiceMonitorCR またはPodMonitorCR を作成し、Collector の内部メトリクスエンドポイントと Prometheus エクスポーターメトリクスエンドポイントをスクレイピングします。
enableMetrics を true に設定すると、次の 2 つの ServiceMonitor インスタンスが作成されます。
-
<instance_name>-collector-monitoringサービス用の 1 つのServiceMonitorインスタンス。このServiceMonitorインスタンスは、Collector の内部メトリクスをスクレイピングします。 -
<instance_name>-collectorサービス用の 1 つのServiceMonitorインスタンス。このServiceMonitorインスタンスは、Prometheus エクスポーターインスタンスによって公開されるメトリクスをスクレイピングします。
あるいは、手動で作成した Prometheus PodMonitor CR を使用すると、Prometheus のスクレイピング中に追加された重複ラベルの削除など、細かい制御を行うことができます。
Collector メトリクスをスクレイプするようにモニタリングスタックを設定する PodMonitor CR の例
6.2. モニタリングスタックからメトリクスを受信するための設定
設定された OpenTelemetry Collector カスタムリソース (CR) は、Prometheus Receiver をセットアップして、クラスター内モニタリングスタックからメトリクスをスクレイプできます。
クラスター内のモニタリングスタックからメトリクスをスクレイプするための OpenTelemetry Collector CR の例
- 1
cluster-monitoring-viewクラスターロールを OpenTelemetry Collector のサービスアカウントに割り当て、サービスアカウントからメトリクスデータにアクセスできるようにします。- 2
- Prometheus Receiver で TLS を設定するための OpenShift サービス CA を注入します。
- 3
- クラスター内モニタリングスタックからフェデレートエンドポイントを取得するように Prometheus Receiver を設定します。
- 4
- Prometheus クエリー言語を使用して、スクレイプするメトリクスを選択します。フェデレートエンドポイントの詳細と制限は、クラスター内モニタリングのドキュメントを参照してください。
- 5
- メトリクスを標準出力に出力するように Debug Exporter を設定します。
第7章 テレメトリーデータの転送
テレメトリーデータは、OpenTelemetry Collector を使用して転送できます。
7.1. トレースを TempoStack インスタンスに転送する
TempoStack インスタンスへのトレースの転送を設定するには、OpenTelemetry Collector をデプロイして設定します。指定されたプロセッサー、レシーバー、エクスポーターを使用して、OpenTelemetry Collector をデプロイメントモードでデプロイできます。その他のモードについては、関連情報 に記載されたリンクを使用して、OpenTelemetry Collector ドキュメントを参照してください。
前提条件
- Red Hat build of OpenTelemetry Operator がインストールされている。
- Tempo Operator がインストールされている。
- TempoStack インスタンスがクラスターにデプロイされている。
手順
OpenTelemetry Collector のサービスアカウントを作成します。
ServiceAccount の例
apiVersion: v1 kind: ServiceAccount metadata: name: otel-collector-deployment
apiVersion: v1 kind: ServiceAccount metadata: name: otel-collector-deploymentCopy to Clipboard Copied! Toggle word wrap Toggle overflow サービスアカウントのクラスターロールを作成します。
ClusterRole の例
Copy to Clipboard Copied! Toggle word wrap Toggle overflow クラスターロールをサービスアカウントにバインドします。
ClusterRoleBinding の例
Copy to Clipboard Copied! Toggle word wrap Toggle overflow YAML ファイルを作成して、
OpenTelemetryCollectorカスタムリソース (CR) を定義します。OpenTelemetryCollector の例
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
telemetrygen をテストとしてデプロイできます。
7.2. LokiStack インスタンスへのログの転送
openshift-logging テナントモードを使用して OpenTelemetry Collector をデプロイすると、ログを LokiStack インスタンスに転送できます。
前提条件
- Red Hat build of OpenTelemetry Operator がインストールされている。
- Loki Operator がインストールされている。
-
サポートされている
LokiStackインスタンスがクラスターにデプロイされている。サポートされているLokiStack設定の詳細は、Logging を参照してください。
手順
OpenTelemetry Collector のサービスアカウントを作成します。
ServiceAccountオブジェクトの例apiVersion: v1 kind: ServiceAccount metadata: name: otel-collector-deployment namespace: openshift-logging
apiVersion: v1 kind: ServiceAccount metadata: name: otel-collector-deployment namespace: openshift-loggingCopy to Clipboard Copied! Toggle word wrap Toggle overflow Collector のサービスアカウントに、ログを
LokiStackアプリケーションテナントにプッシュする権限を付与するクラスターロールを作成します。ClusterRoleオブジェクトの例Copy to Clipboard Copied! Toggle word wrap Toggle overflow クラスターロールをサービスアカウントにバインドします。
ClusterRoleBindingオブジェクトの例Copy to Clipboard Copied! Toggle word wrap Toggle overflow OpenTelemetryCollectorカスタムリソース (CR) オブジェクトを作成します。OpenTelemetryCollectorCR オブジェクトの例Copy to Clipboard Copied! Toggle word wrap Toggle overflow
telemetrygen をテストとしてデプロイできます。
第8章 OpenTelemetry Collector メトリクスの設定
次のリストは、メトリクスの一部を示しています。
- Collector のメモリー使用量
- CPU の使用率
- 処理されたアクティブなトレースとスパンの数
- ドロップされたスパン、ログ、またはメトリクス
- エクスポーターとレシーバーの統計情報
Red Hat build of OpenTelemetry Operator は、Collector の内部メトリクスを公開する <instance_name>-collector-monitoring という名前のサービスを自動的に作成します。このサービスは、デフォルトでポート 8888 をリッスンします。
これらのメトリクスを使用して、Collector のパフォーマンス、リソース消費、その他の内部動作を監視できます。Prometheus インスタンスや別の監視ツールを使用して、前述の <instance_name>-collector-monitoring サービスからこれらのメトリクスをスクレイピングすることもできます。
OpenTelemetryCollector カスタムリソース (CR) の spec.observability.metrics.enableMetrics フィールドが true に設定されている場合、OpenTelemetryCollector CR は Prometheus ServiceMonitor または PodMonitor CR を自動的に作成し、Prometheus がメトリクスをスクレイピングできるようにします。
前提条件
- ユーザー定義プロジェクトのモニタリングがクラスターで有効にされている。
手順
OpenTelemetry Collector インスタンスのメトリクスを有効にするには、
spec.observability.metrics.enableMetricsフィールドをtrueに設定します。Copy to Clipboard Copied! Toggle word wrap Toggle overflow
検証
Web コンソールの Administrator ビューを使用して、正常に設定されたことを確認できます。
- Observe → Targets に移動します。
- Source: User でフィルタリングします。
-
opentelemetry-collector-<instance_name>形式の ServiceMonitors または PodMonitors のステータスが Up であることを確認します。
第9章 複数のクラスターからの可観測性データ収集
マルチクラスター設定の場合、リモートクラスターごとに 1 つの OpenTelemetry Collector インスタンスを作成してから、すべてのテレメトリーデータを 1 つの OpenTelemetry Collector インスタンスに転送できます。
前提条件
- Red Hat build of OpenTelemetry Operator がインストールされている。
- Tempo Operator がインストールされている。
- TempoStack インスタンスがクラスターにデプロイされている。
- 証明書 (Issuer、自己署名証明書、CA issuer、クライアントとサーバーの証明書) がマウントされている。これらの証明書のいずれかを作成するには、手順 1 を参照してください。
手順
OpenTelemetry Collector インスタンスに次の証明書をマウントし、すでにマウントされている証明書を省略します。
Red Hat OpenShift の cert-manager Operator を使用して証明書を生成する Issuer
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 自己署名証明書
Copy to Clipboard Copied! Toggle word wrap Toggle overflow CA issuer
Copy to Clipboard Copied! Toggle word wrap Toggle overflow クライアントとサーバーの証明書
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
OpenTelemetry Collector インスタンスのサービスアカウントを作成します。
ServiceAccount の例
apiVersion: v1 kind: ServiceAccount metadata: name: otel-collector-deployment
apiVersion: v1 kind: ServiceAccount metadata: name: otel-collector-deploymentCopy to Clipboard Copied! Toggle word wrap Toggle overflow サービスアカウントのクラスターロールを作成します。
ClusterRole の例
Copy to Clipboard Copied! Toggle word wrap Toggle overflow クラスターロールをサービスアカウントにバインドします。
ClusterRoleBinding の例
Copy to Clipboard Copied! Toggle word wrap Toggle overflow YAML ファイルを作成して、エッジクラスターで
OpenTelemetryCollectorカスタムリソース (CR) を定義します。エッジクラスター用の
OpenTelemetryCollectorカスタムリソースの例Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- Collector エクスポーターは、OTLP HTTP をエクスポートするように設定されており、中央クラスターから OpenTelemetry Collector を指します。
YAML ファイルを作成して、中央クラスターに
OpenTelemetryCollectorカスタムリソース (CR) を定義します。中央クラスターの
OpenTelemetryCollectorカスタムリソースの例Copy to Clipboard Copied! Toggle word wrap Toggle overflow
第10章 トラブルシューティング
OpenTelemetry Collector のヘルスを測定し、データの取り込みに関する問題を調査する方法は複数あります。
10.1. コマンドラインからの診断データの収集
サポートケースを送信するときは、クラスターに関する診断情報を Red Hat サポートに含めると役立ちます。oc adm must-gather ツールを使用すると、OpenTelemetryCollector、Instrumentation などのさまざまなタイプのリソースや、Deployment、Pod、ConfigMap などの作成されたリソースの診断データを収集できます。oc adm must-gather ツールは、このデータを収集する新しい Pod を作成します。
手順
収集したデータを保存するディレクトリーから、
oc adm must-gatherコマンドを実行してデータを収集します。oc adm must-gather --image=ghcr.io/open-telemetry/opentelemetry-operator/must-gather -- \ /usr/bin/must-gather --operator-namespace <operator_namespace>
$ oc adm must-gather --image=ghcr.io/open-telemetry/opentelemetry-operator/must-gather -- \ /usr/bin/must-gather --operator-namespace <operator_namespace>1 Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- Operator がインストールされるデフォルトの namespace は
openshift-opentelemetry-operatorです。
検証
- 新しいディレクトリーが作成され、収集されたデータが含まれていることを確認します。
10.2. OpenTelemetry Collector ログの取得
OpenTelemetry Collector のログを取得するには、以下の手順を実行します。
手順
OpenTelemetryCollectorカスタムリソース (CR) で関連するログレベルを設定します。config: service: telemetry: logs: level: debugconfig: service: telemetry: logs: level: debug1 Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- Collector のログレベル。サポートされている値には、
info、warn、error、またはdebugが含まれます。デフォルトはinfoです。
-
oc logsコマンドまたは Web コンソールを使用してログを取得します。
10.3. メトリクスの公開
OpenTelemetry Collector は、処理したデータボリュームに関する次のメトリクスを公開します。
otelcol_receiver_accepted_spans- パイプラインに正常にプッシュされたスパンの数。
otelcol_receiver_refused_spans- パイプラインにプッシュできなかったスパンの数。
otelcol_exporter_sent_spans- 宛先に正常に送信されたスパンの数。
otelcol_exporter_enqueue_failed_spans- 送信キューに追加できなかったスパンの数。
otelcol_receiver_accepted_logs- パイプラインにプッシュされたログの数。
otelcol_receiver_refused_logs- パイプラインにプッシュできなかったログの数。
otelcol_exporter_sent_logs- 宛先に送信されたログの数。
otelcol_exporter_enqueue_failed_logs- 送信キューに追加できなかったログの数。
otelcol_receiver_accepted_metrics- パイプラインに正常にプッシュされたメトリクスの数。
otelcol_receiver_refused_metrics- パイプラインにプッシュできなかったメトリクスの数。
otelcol_exporter_sent_metrics- 宛先に正常に送信されたメトリクスの数。
otelcol_exporter_enqueue_failed_metrics- 送信キューに追加できなかったメトリクスの数。
これらのメトリクスを使用して、Collector の問題をトラブルシューティングできます。たとえば、otelcol_receiver_refused_spans メトリックの値が高い場合は、Collector が受信スパンを処理できないことを示します。
Operator は、メトリクスエンドポイントのスクレイプに使用できる <cr_name>-collector-monitoring テレメトリーサービスを作成します。
手順
OpenTelemetryCollectorカスタムリソース (CR) に次の行を追加して、テレメトリーサービスを有効にします。Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- 内部 Collector のメトリクスが公開されるポート。デフォルトは
:8888です。
ポート転送 Collector Pod を使用する次のコマンドを実行して、メトリクスを取得します。
oc port-forward <collector_pod>
$ oc port-forward <collector_pod>Copy to Clipboard Copied! Toggle word wrap Toggle overflow OpenTelemetryCollectorCR で、enableMetricsフィールドをtrueに設定して内部メトリクスをスクレイピングします。Copy to Clipboard Copied! Toggle word wrap Toggle overflow OpenTelemetry Collector のデプロイメントモードに応じて、
PodMonitorsまたはServiceMonitorsを使用して内部メトリクスがスクレイピングされます。注記または、
enableMetricsフィールドをtrueに設定しない場合は、http://localhost:8888/metricsでメトリクスエンドポイントにアクセスできます。オプション：Web コンソールで ユーザーワークロード監視 機能が有効になっている場合は、Web コンソールの Observe → Dashboards に移動し、ドロップダウンリストから OpenTelemetry Collector ダッシュボードを選択して表示します。ユーザー ワークロードの監視 機能の詳細については、モニタリングの「ユーザー定義プロジェクトのモニタリングの有効化」を参照してください。
ヒントスパンやメトリクスなどの視覚化されたデータは、Collector インスタンス、namespace、またはプロセッサー、レシーバー、エクスポーターなどの OpenTelemetry コンポーネント別にフィルタリングできます。
10.4. Debug Exporter
収集したデータを標準出力にエクスポートするように Debug Exporter を設定できます。
手順
OpenTelemetryCollectorカスタムリソースを次のように設定します。Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
oc logsコマンドまたは Web コンソールを使用して、ログを標準出力にエクスポートします。
10.5. Network Observability Operator を使用したトラブルシューティング
Network Observability Operator を使用して可観測性コンポーネント間のトラフィックを可視化することで、トラフィックをデバッグできます。
前提条件
- 「Network Observability Operator のインストール」の説明に従って、Network Observability Operator をインストールした。
手順
- OpenShift Container Platform Web コンソールで、Observe → Network Traffic → Topology に移動します。
- Namespace を選択し、OpenTelemetry Collector がデプロイされている namespace でワークロードをフィルタリングします。
- ネットワークトラフィックのビジュアルを使用して、考えられる問題をトラブルシューティングします。詳細は、「トポロジービューからのネットワークトラフィックの観察」を参照してください。
10.6. 計装のトラブルシューティング
計装のトラブルシューティングを行うには、次のいずれかの問題を確認します。
- ワークロードへの計装の注入に関する問題
- 計装ライブラリーによるデータ生成に関する問題
10.6.1. ワークロードへの計装注入のトラブルシューティング
計装注入のトラブルシューティングを行う際には、次の作業を実行できます。
-
Instrumentationオブジェクトが作成されたかどうかを確認する - init-container が起動したかどうかを確認する
- リソースが正しい順序でデプロイされたかどうかを確認する
- Operator ログのエラーを検索する
- Pod アノテーションを再確認する
手順
次のコマンドを実行して、
Instrumentationオブジェクトが正常に作成されたことを確認します。oc get instrumentation -n <workload_project>
$ oc get instrumentation -n <workload_project>1 Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- 計装が作成された namespace。
次のコマンドを実行して、ワークロードへの計装注入の前提条件である
opentelemetry-auto-instrumentationinit-container が正常に起動したことを確認します。oc get events -n <workload_project>
$ oc get events -n <workload_project>1 Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- ワークロードの計装が注入された namespace。
出力例
... Created container opentelemetry-auto-instrumentation ... Started container opentelemetry-auto-instrumentation
... Created container opentelemetry-auto-instrumentation ... Started container opentelemetry-auto-instrumentationCopy to Clipboard Copied! Toggle word wrap Toggle overflow 自動計装が正しく機能するように、リソースが正しい順序でデプロイされたことを確認します。アプリケーションの前に
Instrumentationカスタムリソース (CR) をデプロイするのが正しい順序です。InstrumentationCR の詳細は、「計装の設定」セクションを参照してください。注記Pod が起動すると、Red Hat build of OpenTelemetry Operator が、自動計装を注入するための指示を含むアノテーションが
InstrumentationCR にあるかどうかを確認します。通常、この Operator はアプリケーションの Pod に init コンテナーを追加し、自動計装と環境変数をアプリケーションのコンテナーに注入します。アプリケーションのデプロイ時に Operator がInstrumentationCR を利用できない場合、Operator は自動計装を注入できません。デプロイメントの順序を修正するには、次の手順が必要です。
- 計装の設定を更新します。
- Instrumentation オブジェクトを削除します。
- アプリケーションを再デプロイします。
次のコマンドを実行して、Operator ログで計装のエラーを調べます。
oc logs -l app.kubernetes.io/name=opentelemetry-operator --container manager -n openshift-opentelemetry-operator --follow
$ oc logs -l app.kubernetes.io/name=opentelemetry-operator --container manager -n openshift-opentelemetry-operator --followCopy to Clipboard Copied! Toggle word wrap Toggle overflow 特定プログラミング言語の計装用の Pod アノテーションをトラブルシューティングします。「計装の設定」で必要なアノテーションフィールドと値を参照してください。
計装するアプリケーションの Pod に正しいアノテーションが付けられ、適切な自動計装設定が適用されていることを確認します。
例
instrumentation.opentelemetry.io/inject-python="true"
instrumentation.opentelemetry.io/inject-python="true"Copy to Clipboard Copied! Toggle word wrap Toggle overflow 計装された Python アプリケーションの Pod アノテーションを取得するコマンドの例
oc get pods -n <workload_project> -o jsonpath='{range .items[?(@.metadata.annotations["instrumentation.opentelemetry.io/inject-python"]=="true")]}{.metadata.name}{"\n"}{end}'$ oc get pods -n <workload_project> -o jsonpath='{range .items[?(@.metadata.annotations["instrumentation.opentelemetry.io/inject-python"]=="true")]}{.metadata.name}{"\n"}{end}'Copy to Clipboard Copied! Toggle word wrap Toggle overflow - Instrumentation オブジェクトに適用されたアノテーションが、計装するプログラミング言語に対して正しいことを確認します。
同じ namespace に複数の計装がある場合は、それらのアノテーションに
Instrumentationオブジェクトの名前を指定します。例
instrumentation.opentelemetry.io/inject-nodejs: "<instrumentation_object>"
instrumentation.opentelemetry.io/inject-nodejs: "<instrumentation_object>"Copy to Clipboard Copied! Toggle word wrap Toggle overflow Instrumentationオブジェクトが別の namespace にある場合は、アノテーションでその namespace を指定します。例
instrumentation.opentelemetry.io/inject-nodejs: "<other_namespace>/<instrumentation_object>"
instrumentation.opentelemetry.io/inject-nodejs: "<other_namespace>/<instrumentation_object>"Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
OpenTelemetryCollectorカスタムリソースのspec.template.metadata.annotationsの下に自動計装のアノテーションが指定されていることを確認します。spec.metadata.annotationsに自動計装のアノテーションがある場合は、spec.template.metadata.annotationsに移動します。
10.6.2. 計装ライブラリーによるテレメトリーデータ生成のトラブルシューティング
エンドポイントを確認し、アプリケーションログでエラーを探し、Collector がテレメトリーデータを受信していることを確認することで、計装ライブラリーによるテレメトリーデータ生成のトラブルシューティングを行うことができます。
手順
計装が正しいエンドポイントにデータを送信していることを確認します。
oc get instrumentation <instrumentation_name> -n <workload_project> -o jsonpath='{.spec.endpoint}'$ oc get instrumentation <instrumentation_name> -n <workload_project> -o jsonpath='{.spec.endpoint}'Copy to Clipboard Copied! Toggle word wrap Toggle overflow Instrumentationオブジェクトのデフォルトのエンドポイントhttp://localhost:4317は、アプリケーション Pod にサイドカーとしてデプロイされた Collector インスタンスにのみ適用されます。間違ったエンドポイントを使用している場合は、Instrumentationオブジェクトを編集してアプリケーションを再デプロイすることで修正します。アプリケーションログを調べて、計装が誤動作していることを示すエラーメッセージがないか確認します。
oc logs <application_pod> -n <workload_project>
$ oc logs <application_pod> -n <workload_project>Copy to Clipboard Copied! Toggle word wrap Toggle overflow - アプリケーションログに、計装が誤動作している可能性があることを示すエラーメッセージが含まれている場合は、OpenTelemetry SDK とライブラリーをローカルにインストールします。次に、アプリケーションをローカルで実行し、OpenShift Container Platform を使用せずに、計装ライブラリーとアプリケーション間の問題をトラブルシューティングします。
- Debug Exporter を使用して、テレメトリーデータが宛先の OpenTelemetry Collector インスタンスに到達していることを確認します。詳細は、「Debug Exporter」を参照してください。
第11章 移行
非推奨になった Red Hat OpenShift Distributed Tracing Platform (Jaeger) 3.5 は、Red Hat がサポートする Red Hat OpenShift Distributed Tracing Platform (Jaeger) の最後のリリースでした。
非推奨になった Red Hat OpenShift Distributed Tracing Platform (Jaeger) のサポートは、2025 年 11 月 3 日に終了します。
Red Hat OpenShift Distributed Tracing Platform Operator (Jaeger) は、2025 年 11 月 3 日に redhat-operators カタログから削除されます。詳細は、Red Hat ナレッジベースソリューション Jaeger Deprecation and Removal in OpenShift を参照してください。
分散トレーシングの収集と保存を行うには、Red Hat build of OpenTelemetry Operator と Tempo Operator に移行する必要があります。詳細は、Red Hat build of OpenTelemetry ドキュメントの「移行」、Red Hat build of OpenTelemetry ドキュメントの「インストール」、および Distributed Tracing Platform ドキュメントの「インストール」を参照してください。
アプリケーションに Red Hat OpenShift Distributed Tracing Platform (Jaeger) をすでに使用している場合は、OpenTelemetry オープンソースプロジェクトをベースとする Red Hat build of OpenTelemetry に移行できます。
Red Hat build of OpenTelemetry は、分散システムの可観測性実現に役立つ一連の API、ライブラリー、エージェント、および計装を提供します。Red Hat build of OpenTelemetry に含まれる OpenTelemetry Collector は、Jaeger プロトコルを取り込めるため、アプリケーションの SDK を変更する必要はありません。
Distributed Tracing Platform (Jaeger) から Red Hat build of OpenTelemetry に移行するには、トレースをシームレスに報告できるように、OpenTelemetry Collector とアプリケーションを設定する必要があります。サイドカーおよびサイドカーレスデプロイメントを移行できます。
11.1. サイドカーを使用した移行
Red Hat build of OpenTelemetry Operator は、デプロイメントワークロードへのサイドカー注入をサポートしています。そのため、Distributed Tracing Platform (Jaeger) サイドカーから Red Hat build of OpenTelemetry サイドカーに移行できます。
前提条件
- クラスターで Red Hat OpenShift Distributed Tracing Platform (Jaeger) が使用されている。
- Red Hat build of OpenTelemetry がインストールされている。
手順
OpenTelemetry Collector をサイドカーとして設定します。
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- このエンドポイントは、
<example>Tempo Operator を使用してデプロイされた TempoStack インスタンスのゲートウェイを指します。
アプリケーションを実行するためのサービスアカウントを作成します。
apiVersion: v1 kind: ServiceAccount metadata: name: otel-collector-sidecar
apiVersion: v1 kind: ServiceAccount metadata: name: otel-collector-sidecarCopy to Clipboard Copied! Toggle word wrap Toggle overflow 一部のプロセッサーで必要な権限のためのクラスターロールを作成します。
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
resourcedetectionprocessorには、インフラストラクチャーとインフラストラクチャー/ステータスに対する権限が必要です。
ClusterRoleBindingを作成して、サービスアカウントの権限を設定します。Copy to Clipboard Copied! Toggle word wrap Toggle overflow - OpenTelemetry Collector をサイドカーとしてデプロイします。
-
Deploymentオブジェクトから"sidecar.jaegertracing.io/inject": "true"アノテーションを削除することで、注入された Jaeger Agent をアプリケーションから削除します。 -
sidecar.opentelemetry.io/inject: "true"アノテーションをDeploymentオブジェクトの.spec.template.metadata.annotationsフィールドに追加して、OpenTelemetry サイドカーの自動注入を有効にします。 - 作成したサービスアカウントをアプリケーションのデプロイメントに使用します。そうすることで、プロセッサーは正しい情報を取得してトレースに追加できます。
11.2. サイドカーを使用しない移行
サイドカーをデプロイせずに、Distributed Tracing Platform (Jaeger) から Red Hat build of OpenTelemetry に移行できます。
前提条件
- クラスターで Red Hat OpenShift Distributed Tracing Platform (Jaeger) が使用されている。
- Red Hat build of OpenTelemetry がインストールされている。
手順
- OpenTelemetry Collector デプロイメントを設定します。
OpenTelemetry Collector のデプロイ先となるプロジェクトを作成します。
apiVersion: project.openshift.io/v1 kind: Project metadata: name: observability
apiVersion: project.openshift.io/v1 kind: Project metadata: name: observabilityCopy to Clipboard Copied! Toggle word wrap Toggle overflow OpenTelemetry Collector インスタンスを実行するためのサービスアカウントを作成します。
apiVersion: v1 kind: ServiceAccount metadata: name: otel-collector-deployment namespace: observability
apiVersion: v1 kind: ServiceAccount metadata: name: otel-collector-deployment namespace: observabilityCopy to Clipboard Copied! Toggle word wrap Toggle overflow プロセッサーに必要な権限を設定するためのクラスターロールを作成します。
Copy to Clipboard Copied! Toggle word wrap Toggle overflow ClusterRoleBinding を作成して、サービスアカウントの権限を設定します。
Copy to Clipboard Copied! Toggle word wrap Toggle overflow OpenTelemetry Collector インスタンスを作成します。
注記この Collector は、トレースを TempoStack インスタンスにエクスポートします。Red Hat Tempo Operator を使用して TempoStack インスタンスを作成し、正しいエンドポイントを配置する必要があります。
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - トレースエンドポイントを OpenTelemetry Operator に指定します。
トレースをアプリケーションから Jaeger に直接エクスポートする場合は、API エンドポイントを Jaeger エンドポイントから OpenTelemetry Collector エンドポイントに変更します。
Golang を使用する
jaegerexporterでトレースをエクスポートする場合の例exp, err := jaeger.New(jaeger.WithCollectorEndpoint(jaeger.WithEndpoint(url)))
exp, err := jaeger.New(jaeger.WithCollectorEndpoint(jaeger.WithEndpoint(url)))1 Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- URL は OpenTelemetry Collector API エンドポイントを指します。
第12章 アップグレード
バージョンのアップグレードの場合、Red Hat build of OpenTelemetry Operator は Operator Lifecycle Manager (OLM) を使用します。これは、クラスター内の Operator のインストール、アップグレード、およびロールベースのアクセス制御 (RBAC) を制御します。
OLM は、デフォルトで OpenShift Container Platform で実行されます。OLM は利用可能な Operator のクエリーやインストールされた Operator のアップグレードを実行します。
Red Hat build of OpenTelemetry Operator は、起動時にすべての OpenTelemetryCollector カスタムリソースを自動的にアップグレードします。この Operator は起動時にすべての管理対象インスタンスを調整します。エラーが発生した場合、Operator は指数バックオフを使用してアップグレードを再試行します。アップグレードが失敗した場合、Operator は再起動時にアップグレードを再試行します。
Red Hat build of OpenTelemetry Operator が新しいバージョンにアップグレードされると、管理する実行中の OpenTelemetry Collector インスタンスがスキャンされ、Operator の新しいバージョンに対応するバージョンにアップグレードされます。
第13章 削除
OpenShift Container Platform クラスターから Red Hat build of OpenTelemetry を削除する手順は次のとおりです。
- Red Hat build of OpenTelemetry Pod をすべてシャットダウンします。
- OpenTelemetryCollector インスタンスを削除します。
- Red Hat build of OpenTelemetry Operator を削除します。
13.1. Web コンソールを使用した OpenTelemetry Collector インスタンスの削除
Web コンソールの Administrator ビューで OpenTelemetry Collector インスタンスを削除できます。
前提条件
-
cluster-adminロールを持つクラスター管理者として Web コンソールにログインしている。 -
Red Hat OpenShift Dedicated の場合、
dedicated-adminロールを持つアカウントを使用してログインしている。
手順
- Operators → Installed Operators → Red Hat build of OpenTelemetry Operator → OpenTelemetryInstrumentation または OpenTelemetryCollector に移動します。
-
関連するインスタンスを削除するには、
→ Delete … → Delete を選択します。
- オプション: Red Hat build of OpenTelemetry Operator を削除します。
13.2. CLI を使用した OpenTelemetry Collector インスタンスの削除
コマンドラインで OpenTelemetry Collector インスタンスを削除できます。
前提条件
cluster-adminロールを持つクラスター管理者によるアクティブな OpenShift CLI (oc) セッション。ヒント-
OpenShift CLI (
oc) のバージョンが最新であり、OpenShift Container Platform バージョンと一致していることを確認してください。 oc loginを実行します。oc login --username=<your_username>
$ oc login --username=<your_username>Copy to Clipboard Copied! Toggle word wrap Toggle overflow
-
OpenShift CLI (
手順
次のコマンドを実行して、OpenTelemetry Collector インスタンスの名前を取得します。
oc get deployments -n <project_of_opentelemetry_instance>
$ oc get deployments -n <project_of_opentelemetry_instance>Copy to Clipboard Copied! Toggle word wrap Toggle overflow 次のコマンドを実行して、OpenTelemetry Collector インスタンスを削除します。
oc delete opentelemetrycollectors <opentelemetry_instance_name> -n <project_of_opentelemetry_instance>
$ oc delete opentelemetrycollectors <opentelemetry_instance_name> -n <project_of_opentelemetry_instance>Copy to Clipboard Copied! Toggle word wrap Toggle overflow - オプション: Red Hat build of OpenTelemetry Operator を削除します。
検証
OpenTelemetry Collector インスタンスが正常に削除されたことを確認するには、
oc get deploymentsを再度実行します。oc get deployments -n <project_of_opentelemetry_instance>
$ oc get deployments -n <project_of_opentelemetry_instance>Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Legal Notice
Copyright © 2025 Red Hat
OpenShift documentation is licensed under the Apache License 2.0 (https://www.apache.org/licenses/LICENSE-2.0).
Modified versions must remove all Red Hat trademarks.
Portions adapted from https://github.com/kubernetes-incubator/service-catalog/ with modifications by Red Hat.
Red Hat, Red Hat Enterprise Linux, the Red Hat logo, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation’s permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}