DockerコンテナとしてOBIを実行する
OBIは、スタンドアロンのDockerコンテナとして実行し、別のコンテナで実行されているプロセスを計装できます。
OBIの最新イメージは、Docker Hubで次の名前で見つけられます。
ebpf-instrument:main
OBIコンテナは、次のように構成する必要があります。
- 特権コンテナとして実行するか、
SYS_ADMINケーパビリティを持つコンテナとして実行します(ただし、この最後のオプションは一部のコンテナ環境では機能しない場合があります)。 hostPID名前空間を使用して、他のコンテナ内のプロセスにアクセスできるようにします。
Docker CLIの例
この例では、HTTP/SまたはgRPCサービスを実行しているコンテナが必要です。 コンテナがない場合は、Goで書かれたシンプルなブログエンジンサービスを使用できます。
docker run -p 18443:8443 --name goblog mariomac/goblog:dev
上記のコマンドは、シンプルなHTTPSアプリケーションを実行します。
このプロセスはコンテナの内部ポート8443を開き、ホストレベルではポート18443として公開されます。
環境変数を設定し、OBIが標準出力に出力し、実行可能ファイルを検査するようにポート(コンテナ)をリッスンするように構成します。
export OTEL_EBPF_TRACE_PRINTER=text
export OTEL_EBPF_OPEN_PORT=8443
OBIは次の設定で実行する必要があります。
--privilegedモード、またはSYS_ADMINケーパビリティ(ただし、一部のコンテナ環境ではSYS_ADMINだけでは特権が不十分な場合があります)--pid=hostオプションを使用したホストのPID名前空間を使用
docker run --rm \
-e OTEL_EBPF_OPEN_PORT=8443 \
-e OTEL_EBPF_TRACE_PRINTER=text \
--pid=host \
--privileged \
docker.io/otel/ebpf-instrument:main
OBIの実行後、ブラウザで https://localhost:18443 を開き、アプリを使用してテストデータを生成し、OBIが標準出力に次のようなトレースリクエストを出力することを確認します。
time=2023-05-22T14:03:42.402Z level=INFO msg="creating instrumentation pipeline"
time=2023-05-22T14:03:42.526Z level=INFO msg="Starting main node"
2023-05-22 14:03:53.5222353 (19.066625ms[942.583µs]) 200 GET / [172.17.0.1]->[localhost:18443] size:0B
2023-05-22 14:03:53.5222353 (355.792µs[321.75µs]) 200 GET /static/style.css [172.17.0.1]->[localhost:18443] size:0B
2023-05-22 14:03:53.5222353 (170.958µs[142.916µs]) 200 GET /static/img.png [172.17.0.1]->[localhost:18443] size:0B
2023-05-22 14:13:47.52221347 (7.243667ms[295.292µs]) 200 GET /entry/201710281345_instructions.md [172.17.0.1]->[localhost:18443] size:0B
2023-05-22 14:13:47.52221347 (115µs[75.625µs]) 200 GET /static/style.css [172.17.0.1]->[localhost:18443] size:0B
これで、OBIがターゲットのHTTPサービスをトレースするようになったので、OpenTelemetryエンドポイントにメトリクスとトレースを送信するか、Prometheusでメトリクスをスクレイプするように構成します。
トレースとメトリクスをエクスポートする方法については、構成オプションのドキュメントを参照してください。
Docker Composeの例
次のDocker composeファイルは、Docker CLIの例と同じ機能を再現します。
version: '3.8'
services:
# 計装するサービス。
# 計装したい他のコンテナに変更してください。
goblog:
image: mariomac/goblog:dev
ports:
# 18843ポートを公開し、コンテナポート8443に転送します
- '18443:8443'
autoinstrumenter:
image: docker.io/otel/ebpf-instrument:main
pid: 'host'
privileged: true
environment:
OTEL_EBPF_TRACE_PRINTER: text
OTEL_EBPF_OPEN_PORT: 8443
次のコマンドでDocker composeファイルを実行し、アプリを使用してトレースを生成します。
docker compose -f compose-example.yml up
フィードバック
このページは役に立ちましたか?
Thank you. Your feedback is appreciated!
Please let us know how we can improve this page. Your feedback is appreciated!