はじめに
OpenTelemetryは、CNCF（Cloud Native Computing Foundation）が主導する観測（Observability）のためのオープンソースプロジェクトであり、ログ、メトリクス、トレースなどのテレメトリデータを収集・処理するためのフレームワークとして注目されています。OpenTelemetry Collectorは、このフレームワークの核となるツールで、データの受信、処理、出力を行う中間層として機能します。しかし、標準的なコレクターでは必要に応じたカスタマイズが難しい場合があります。この記事では、OpenTelemetry Collector Builder（OCB）を用いたカスタムコレクターの構築方法を解説し、実踐的な導入手順とその利點を紹介します。
OCBの概要と特徴
OpenTelemetry Collectorの基本構造
OpenTelemetry Collectorは、以下のようなモジュールで構成されています。
- 受信器（Receivers）：OTLP、Prometheus、Logsなどのデータ形式を受信します。
- 処理器（Processors）：データの変換、フィルタリング、ブラックリストなどの操作を行います。
- 導出器（Exporters）：データを後端（OTLP、Prometheus、Jaegerなど）に送出します。
- 拡張（Extensions）：認証や接続などの外部操作をサポートします。
これらのモジュールは、獨立して開発・組み合わせ可能であり、最小化されたバイナリサイズを実現するモジュール化設計が特徴です。
OCBの役割と構築フロー
OCBは、カスタムコレクターの自動生成を可能にするツールです。以下のような手順で動作します。
- Manifestファイル：必要なモジュール（受信器、処理器、導出器など）を指定します。
- OCBバイナリ：Collector APIバージョンに応じたGoテンプレートを生成します。
- Goコンパイル：標準的なGoコンパイルプロセスで最終バイナリを生成します。
OCBは、Manifestファイルを指定することで、カスタムコレクターの構築を簡素化します。また、--configフラグでManifestのパスを指定し、--skip-compilationフラグでソースコードのみを生成するオプションも提供しています。
カスタムコレクターの実裝手順
モジュールの選択とバージョン管理
- 上流のモジュール（OpenTelemetry Core、Contribution Distributionなど）またはカスタムモジュールを選択します。
- カスタムモジュールはGoモジュール形式で実裝され、
newFactory関數を実裝する必要があります。
- バージョン指定は
github.com/open-telemetry/[email protected]などの形式で行います。
モジュールの置き換え
replaces構文を使用して、不具合のあるモジュールをフォーク版などに置き換え可能です。- 例えば、受信器や導出器の実裝をカスタマイズして置き換えることができます。
ディストリビューションの構築と発行
- Dockerイメージ：空のベースイメージを使用し、コレクターのバイナリと証明書バンドルのみを含めます。非rootユーザーとして実行する（
USER nonroot）ことでセキュリティを強化します。
- その他のパッケージ形式：Debian/RPMパッケージ、GitHub Releases、AWS ECRなどに対応しています。
- マルチプラットフォーム構築：
GOOSとGOARCH環境変數を設定することで、Linux/Windows/macOS/Plan9/BSDなどに対応可能です。GitHub Actions（例：deel/dist-builder）を活用して自動化発行も可能です。
実踐例：TLS終了プロキシコレクターの構築
モジュールの選定
- OTLP受信器と導出器を組み合わせ、TLS終了プロキシ機能を実現します。
- 設定はファイルや環境変數で指定可能です。
構築フロー
- Manifestファイルでモジュールバージョンと置き換え戦略を指定します。
- GitHub Actionsを活用してDockerイメージの自動生成と発行を行います。
アプリケーションシナリオ
- TLS終了プロキシとして動作し、暗號化されたテレメトリデータを処理します。
性能最適化とセキュリティ
パフォーマンスの考慮
- 現在は動的モジュールロードがサポートされていないため、靜的組み合わせによる最適化が求められます。
- 不要なモジュール（受信器、処理器、導出器など）を削除し、バイナリサイズとメモリ使用量を最小化します。
- Goコンパイラのデフォルト最適化により、効率的なバイナリが生成されます。
セキュリティとメンテナンス
- 自己管理モジュールのセキュリティチェックを実施し、脆弱性を防ぎます。
- 上流モジュールの定期的な更新により、互換性とセキュリティを確保します。
まとめ
OCBは、OpenTelemetry Collectorのカスタマイズを効率化するための強力なツールです。Manifestファイルを用いたモジュール管理により、柔軟な構築が可能となり、Dockerイメージやその他のパッケージ形式への発行もサポートされています。ただし、バージョンの互換性やパフォーマンスの最適化に注意が必要です。実際の運用では、テストと自動化ツールの活用により、安定したプロダクション環境を構築することが重要です。