第4章 インストルメンテーションの設定
Red Hat build of OpenTelemetry Operator は、インストルメンテーションの設定を定義するカスタムリソース定義 (CRD) ファイルを使用します。
4.1. OpenTelemetry インストルメンテーション設定オプション
Red Hat build of OpenTelemetry では、OpenTelemetry 自動インストルメンテーションライブラリーをワークロードに注入して設定できます。現在、プロジェクトは、Go、Java、Node.js、Python、.NET、および Apache HTTP Server (httpd) からのインストルメンテーションライブラリーの注入をサポートしています。
OpenTelemetry の自動インストルメンテーションとは、コードを手動で変更することなく、フレームワークがアプリケーションを自動的にインストルメンテーションする機能を指します。これにより、開発者と管理者は、最小限の労力と既存のコードベースへの変更で、アプリケーションに可観測性を導入できるようになります。
Red Hat build of OpenTelemetry Operator は、インストルメンテーションライブラリーの注入メカニズムのみをサポートしますが、インストルメンテーションライブラリーやアップストリームイメージはサポートしません。お客様は独自のインストルメンテーションイメージをビルドすることも、コミュニティーイメージを使用することもできます。
4.1.1. インストルメンテーションオプション
計装オプションは、Instrumentation カスタムリソース (CR) で指定されます。
サンプル Instrumentation CR
apiVersion: opentelemetry.io/v1alpha1
kind: Instrumentation
metadata:
name: java-instrumentation
spec:
env:
- name: OTEL_EXPORTER_OTLP_TIMEOUT
value: "20"
exporter:
endpoint: http://production-collector.observability.svc.cluster.local:4317
propagators:
- w3c
sampler:
type: parentbased_traceidratio
argument: "0.25"
java:
env:
- name: OTEL_JAVAAGENT_DEBUG
value: "true"
| パラメーター | 説明 | 値 |
|---|---|---|
|
| すべてのインストルメンテーションにわたって定義する共通の環境変数。 | |
|
| エクスポーターの設定。 | |
|
| プロパゲーターは、プロセス間のコンテキスト伝播設定を定義します。 |
|
|
| リソース属性の設定。 | |
|
| サンプリング設定。 | |
|
| Apache HTTP Server インストルメンテーションの設定。 | |
|
| .NET インストルメンテーションの設定。 | |
|
| Go インストルメンテーションの設定。 | |
|
| Java インストルメンテーションの設定。 | |
|
| Node.js インストルメンテーションの設定。 | |
|
| Python インストルメンテーションの設定。 |
| オートインストルメンテーション | デフォルトプロトコル |
|---|---|
| Java 1.x |
|
| Java 2.x |
|
| Python |
|
| .NET |
|
| Go |
|
| Apache HTTP サーバー |
|
4.1.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.1.3. エクスポーターの設定
Instrumentation カスタムリソースはシグナルごとに 1 つ以上のエクスポーターを設定できますが、オートインストルメンテーションでは OTLP Exporter のみが設定されます。したがって、Collector で OTLP Receiver を参照するようにエンドポイントを設定する必要があります。
設定マップを使用したエクスポーター TLS CA 設定の例
apiVersion: opentelemetry.io/v1alpha1
kind: Instrumentation
# ...
spec
# ...
exporter:
endpoint: https://production-collector.observability.svc.cluster.local:4317 1
tls:
configMapName: ca-bundle 2
ca_file: service-ca.crt 3
# ...
シークレットを使用したエクスポーター mTLS 設定の例
apiVersion: opentelemetry.io/v1alpha1
kind: Instrumentation
# ...
spec
# ...
exporter:
endpoint: https://production-collector.observability.svc.cluster.local:4317 1
tls:
secretName: serving-certs 2
ca_file: service-ca.crt 3
cert_file: tls.crt 4
key_file: tls.key 5
# ...
- 1
- HTTPS スキームと TLS を使用して OTLP エンドポイントを指定します。
- 2
ca_file値、cert_file値、およびkey_file値の Secret の名前を指定します。Secret は、自動インストルメンテーションを挿入する Pod の namespace にすでに存在している必要があります。- 3
- 証明書がすでにワークロードファイルシステムに存在する場合、Secret の CA 証明書または証明書への絶対パスを参照します。
- 4
- 証明書がすでにワークロードファイルシステムに存在する場合、Secret のクライアント証明書または証明書への絶対パスを参照します。
- 5
- キーがワークロードファイルシステムにすでに存在する場合は、Secret のクライアントキーまたはキーの絶対パスを参照します。
CA 証明書を config map または Secret に指定できます。両方で指定する場合、config map はシークレットよりも優先されます。
設定マップおよび インストルメンテーション CR を使用した CA バンドル挿入の設定例
apiVersion: v1
kind: ConfigMap
metadata:
name: otelcol-cabundle
namespace: tutorial-application
annotations:
service.beta.openshift.io/inject-cabundle: "true"
# ...
---
apiVersion: opentelemetry.io/v1alpha1
kind: Instrumentation
metadata:
name: my-instrumentation
spec:
exporter:
endpoint: https://simplest-collector.tracing-system.svc.cluster.local:4317
tls:
configMapName: otelcol-cabundle
ca: service-ca.crt
# ...
4.1.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 のバージョン。 | 2.4 |
注入を有効化するための PodSpec アノテーション
instrumentation.opentelemetry.io/inject-apache-httpd: "true"
4.1.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"
4.1.6. Go 自動計装の設定
Go 自動計装はテクノロジープレビュー機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビューの機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行いフィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
デフォルトでは、この機能はサポート対象外のアップストリームの計装ライブラリーを注入します。
| 名前 | 説明 |
|---|---|
|
| Go に固有の環境変数。 |
|
| Go SDK と自動インストルメンテーションを備えたコンテナーイメージ。 |
|
| コンピュートリソースの要件。 |
注入を有効化するための PodSpec アノテーション
instrumentation.opentelemetry.io/inject-go: "true"
OpenShift クラスターの Go 自動インストルメンテーションに必要な追加の権限
apiVersion: security.openshift.io/v1 kind: SecurityContextConstraints metadata: name: otel-go-instrumentation-scc allowHostDirVolumePlugin: true allowPrivilegeEscalation: true allowPrivilegedContainer: true allowedCapabilities: - "SYS_PTRACE" fsGroup: type: RunAsAny runAsUser: type: RunAsAny seLinuxContext: type: RunAsAny seccompProfiles: - '*' supplementalGroups: type: RunAsAny
OpenShift クラスターで Go 自動インストルメンテーションの権限を適用するための CLI コマンドは次のとおりです。
$ oc adm policy add-scc-to-user otel-go-instrumentation-scc -z <service_account>
4.1.7. Java 自動計装の設定
Java 自動計装はテクノロジープレビュー機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビューの機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行いフィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
デフォルトでは、この機能はサポート対象外のアップストリームの計装ライブラリーを注入します。
| 名前 | 説明 |
|---|---|
|
| Java に固有の環境変数。 |
|
| Java SDK と自動インストルメンテーションを備えたコンテナーイメージ。 |
|
| コンピュートリソースの要件。 |
注入を有効化するための PodSpec アノテーション
instrumentation.opentelemetry.io/inject-java: "true"
4.1.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/otel-go-auto-target-exe: "/path/to/container/executable"
instrumentation.opentelemetry.io/otel-go-auto-target-exe アノテーションは、必要な OTEL_GO_AUTO_TARGET_EXE 環境変数の値を設定します。
4.1.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"
4.1.10. マルチコンテナー Pod
インストルメンテーションは、Pod の仕様に従ってデフォルトで利用可能な最初のコンテナー上で実行されます。場合によっては、注入のターゲットコンテナーを指定することもできます。
Pod のアノテーション
instrumentation.opentelemetry.io/container-names: "<container_1>,<container_2>"
Go 自動インストルメンテーションは、複数コンテナーの自動インストルメンテーション注入をサポートしていません。
4.1.11. 複数の計装を使用するマルチコンテナー Pod
マルチコンテナー Pod 内の 1 つ以上のコンテナーにアプリケーション言語の計装を注入するには、次のアノテーションが必要です。
instrumentation.opentelemetry.io/<application_language>-container-names: "<container_1>,<container_2>" 1- 1
- 注入できる計装は、コンテナーごとに 1 つの言語の計装だけです。サポートされている
<application_language>値のリストについては、次の表を参照してください。
| 言語 | <application_language> の値 |
|---|---|
| ApacheHTTPD |
|
| DotNet |
|
| Java |
|
| NGINX |
|
| NodeJS |
|
| Python |
|
| SDK |
|
4.1.12. Service Mesh でのインストルメンテーション CR の使用
Red Hat OpenShift Service Mesh でインストルメンテーションカスタムリソース (CR) を使用する場合は、b3multi プロパゲーターを使用する必要があります。
