5万
概要
OpenTelemetry Collectorのドキュメントの探しにくさに直面した私たちは、作業を円滑に進めるため、検索重視の独自インターフェースを構築しました。これが非常に有用だったため、一般公開することにしました。
otel.fyiは、OpenTelemetry Collectorのドキュメントに特化した検索重視のサイトです。点在するドキュメントを探し回ることなく、receiver、processor、exporter、extensionの設定を素早く見つけて理解できます。
OpenTelemetry は、オブザーバビリティデータの収集とルーティングにおける標準となりました。このエコシステムの中心にあるのが OpenTelemetry Collector です。これは、アーキテクチャ全体のさまざまな役割でデプロイできる、ベンダー中立のサービスです。
ワークロードの近くに常駐するエージェントとして実行し、アプリケーション、コンテナ、インフラストラクチャからログ、トレース、メトリクスを収集できます。また、ゲートウェイとして動作させ、多数のエージェントからテレメトリを受信し、そのデータを処理・強化した上で、1 つ以上のバックエンドにルーティングすることも可能です。この柔軟性こそが、ベンダー間の相互運用性を実現し、システム内をデータがどのように流れるかをチーム自身がコントロールできるようにしています。
残念ながら、実際のところ Collector のドキュメントはナビゲートしやすいとは言えません。
Collector の機能の多くは contrib パッケージに含まれています。これらはコアプロジェクトとは別に保守されており、そのドキュメントは単一の統合サイトではなく、通常は個別のリポジトリにある README.md ファイルとして存在しています。その結果、ユーザーはフォルダ間を行き来したり、GitHub のコード検索を使ったり、手作業で設定の詳細をつなぎ合わせたりせざるを得ず、体験が分断されてしまっています。
社内のフラストレーションから生まれたシンプルなツール
この課題は無視できないものになっていきました。オブザーバビリティ担当のプロダクトリードである Mike は、もっと優れたものが必要だと判断しました。公式ドキュメントに取って代わるものではなく、ドキュメントを使った作業をより迅速に行える手段です。
親友の Claude を味方に付け、彼はあるアイデアの実装に取り掛かりました。それは、核となる部分がきわめてシンプルなアイデアでした。
OpenTelemetry Collector のエコシステム全体に散らばる既存のドキュメントから役立つ部分を抽出し、検索しやすい一貫した形式で提示することです。ユーザーが日々の業務で実際に Collector を設定する方法に合わせて最適化されたツールを目指しました。
具体的には、contrib リポジトリをパースし、設定例を抽出し、レシーバー、プロセッサー、エクスポーター、エクステンションの表示方法を標準化することを意味していました。ここでの目的は、完全性の追求そのものではなく、使いやすさです。README ファイルを隅々まで探し回る時間を減らし、重要な詳細情報にすぐアクセスできるようにすることでした。
> Collector のドキュメントは人間が閲覧するには理想的とは言えませんが、内部的には高度に構造化されており、一貫した構成になっているため、主要なメタデータや設定ブロックを抽出するのは簡単です。
Collector に特化した検索重視のエクスペリエンス
こうして誕生したのが otel.fyi です。
これは、「必要なコンポーネントをすばやく見つける」という 1 つのコアワークフローを中心に設計されたシンプルなサイトです。
レシーバー、プロセッサー、エクスポーター、エクステンションを横断して検索でき、それぞれの構造化されたビューを即座に確認できます。長い README ファイルを読み漁る代わりに、重要な情報があらかじめ表示され、ソースから直接取得した設定例も一緒に確認できます。
すべての情報は一貫した形式に標準化されています。設定ブロックがどこに埋もれているか推測したり、コンポーネントごとの細かな違いに頭を悩ませたりする必要はもうありません。「これを設定したい」と考えてから「実際に動作する設定を用意できる」までの時間を短縮することが狙いです。
OpenTelemetry の実際の使われ方に合わせて構築
私たちが otel.fyi を構築したのは、何よりもまず自分たちのためでした。リポジトリや README ファイルの間を絶えず行き来することなく、Collector の設定を組み立てるという実践的なタスクに集中できる、軽量で高速なツールが必要だったからです。そして日々の業務で活用するようになるにつれ、社内のワークフローにとどまらず広く役立つ可能性があることが明らかになりました。
社内ツールにとどめておくのではなく、広く公開して、OpenTelemetry を扱う他のエンジニアの役にも立つかどうかを確かめるのは自然な流れでした。
今後の展望
検索機能はほんの出発点にすぎません。設定のガイドや質問への回答を支援し、Collector を扱う際に生じるコンテキストスイッチを減らすための AI アシスタントの追加など、現場でさらに役立つツールにするためのアイデアをすでに検討しています。
現時点での焦点は、私たちが日々向き合っているワークフローを踏まえ、OpenTelemetry Collector をシンプルに扱いやすくすることにあります。
このツールは私たちの業務において大いに役立っており、OpenTelemetry の設定に時間を費やしている方にとっても、きっと役立つはずです。otel.fyi をぜひ試してみてください。
