doca-collectx-deployment

DOCA CollectX テレメトリーのデプロイ

例

• 「Prometheus にエクスポートする CollectX コレクターを立ち上げてください。」 — リーダー／パブリッシャーライブラリの API や製品化された DTS コンテナーではなく、コレクターのランタイムとエクスポーターを指します。
• 「コレクターは起動していますが、プロバイダーの行が表示されません。」 — 設定を書き換える前に、プロバイダーの サポート状況を確認してください。

手順

以下の読み込み順に従ってください。コレクターの起動と 復旧についてはタスク用の補足ファイルを開いてください。 4 つのサーフェスへの分割とエクスポートバックエンドの分類については、 機能の補足ファイルを開いてください。補足ファイルをすべて開く必要はありません。

まず確認する場所： このスキルは、バンドル内で CollectX（clx）ベースのテレメトリーコレクターを運用するための中心的な場所です。プロバイダーカウンターを収集して スキーマにまとめ、1 つ以上のエクスポーターを通じて送信する 収集フレームワークを扱います。これはデプロイ／運用スキルであり、 doca-bare-metal-deployment/SKILL.md および doca-container-deployment/SKILL.md と並ぶものです。オペレーターのホストまたは BlueField 上でのテレメトリーコレクターの ランタイム構成を扱うものであり、オペレーター自身のプログラムが呼び出す ライブラリ API は対象ではありません。ユーザーがコレクターとそのエクスポーターを立ち上げ、 接続、またはデバッグしたい場合は、タスク用の補足ファイルを開き、 ## configure から始めてください。コレクターにどのようなサーフェスがあり、 スコープの境界がどこにあるのかが質問の内容であれば、 機能の補足ファイルから始めてください。 ユーザーがまだ DOCA をインストールしていない場合は、 まず doca-setup/SKILL.md を案内してください。

スコープ境界（何よりも先にお読みください）

ルーティングとは、まず回答するのではなく、依頼を引き継ぐことです。 以下の境界によって別のスキルに割り当てられる内容については、担当先を示して、そこで止めてください。 担当先を示したうえで、API 呼び出しや計測手順、コードの例まで提示してしまうのは、避けるべき失敗パターンです。部分的な回答も回答であり、せっかく行ったルーティングを無効にしてしまいます。スコープ外の作業については、要約、例示用スニペット、注意事項としてであっても説明しないでください。

CollectX（clx）は、NVIDIA のテレメトリー収集フレームワークです。DOCA Telemetry Service（DTS）を支えていますが、DTS のデプロイ済み形態（製品化され、NGC で提供され、kubelet によって起動されるサービスコンテナー）は、AGENTS.md の非目標 #7 により、このバンドルの対象外です（バンドルの AGENTS.md#non-goals-questions-the-agent-should-recognize-and-refuse-politely）。 したがって、このスキルでは明確な境界を設け、エージェントは必ず最初にそれを伝えなければなりません。

• ここで扱う内容： CollectX の収集メカニズムというクラス（プロバイダー／カウンター → スキーマ → コレクターデーモン → エクスポーター）、オペレーターが管理するコレクターのデプロイ、実行、デバッグ、およびコレクターへのデータ供給やコレクターからのデータ取得に使用する、バンドル内の 2 つのテレメトリーライブラリのオペレーター自身による利用。
• DOCA テレメトリーライブラリへルーティングする内容： ハードウェアカウンターの読み取り API は doca-telemetry/SKILL.md の担当です。アプリケーション側の発行 API（DOCA プログラムからカウンター／イベントを出力するもの）は doca-telemetry-exporter/SKILL.md の担当です。このスキルでは、どちらの API についても再説明しません。
• 公開ドキュメントへルーティングする内容（非目標 #7）： 製品化されたDTS コンテナー（パッケージ済みの設定スキーマ、組み込みのプロバイダーセット、kubelet マニフェスト、NGC イメージ）は、外部向けに製品化されています。「DTS サービスを運用する」すべての質問は、doca-public-knowledge-map の外部製品化ソフトウェア向けルーティング項目（doca-public-knowledge-map/SKILL.md#externally-productized-doca-software--not-in-this-bundle-but-here-is-where-to-route）と、そこから案内される公開 DTS ガイドにルーティングしてください。エージェントは、記憶を頼りに DTS の設定ファイル名、プロバイダーの設定項目名、パスを作り出してはなりません。

このスキルが防ごうとしている、最初の対応時に起きる重大な失敗は、次の 4 つの対象を「DOCA テレメトリー」にひとまとめにしてしまうことです。すなわち、clx の収集メカニズム、doca-telemetry 読み取りライブラリ、doca-telemetry-exporter 発行ライブラリ、製品化された DTS コンテナーは、それぞれ異なる担当者が管理する、別々のものです。エージェントは、設定レベルの案内に入る前に、この区分を明示します。

対象読者

このスキルは、自ら管理するホストまたは BlueField 上で、CollectX ベースのテレメトリーコレクターを立ち上げたり実行したりする外部オペレーターを対象としています。対象者は、すでに以下を満たしています。

• 収集元となる側（ホスト x86 または BlueField Arm）に DOCA がインストールされており、doca-setup ## test に従って確認済みであること。
• リーダー／パブリッシャーライブラリのコードを書くのではなく（それらは上記の libs/ のスキルが担当）、コレクターとエクスポーターを通じてカウンターをマシンの外へ取り出すことを目指していること。
• 具体的なプロバイダー名、スキーマフィールド、フラグ、設定パスについて、信頼できる情報源として docs.nvidia.com の公開 DOCA Telemetry ガイドおよび DTS ガイドを参照できること。

以下は対象ではありません。

• ハードウェアカウンターの読み取り API を実装する開発者（doca-telemetry/SKILL.md にルーティング）や、発行 API を実装する開発者（doca-telemetry-exporter/SKILL.md にルーティング）。
• ターンキーサービスとして製品化された DTS コンテナーをデプロイ／設定するオペレーター。これは外部向けに製品化されています（非目標 #7）。公開 DTS ガイドにルーティングしてください。
• 新規インストールを伴わないユーザー。該当する案内は doca-setup ## no-install です。

このスキルがエージェントに教えるのは、手順とスコープ境界です。clx のシンボル名、プロバイダー名、スキーマフィールド名、エクスポーターのフラグ名、設定パスを記憶から作り出すことはありません。これらの情報は、実際にインストールされている環境と、doca-public-knowledge-map/SKILL.md 経由で参照する公開ドキュメントから取得します。

このスキルを読み込むタイミング

ユーザーがCollectX ベースのテレメトリーコレクターのデプロイまたは運用を実際に行っており、質問がライブラリー API ではなく、コレクターの実行時構成に関する場合にこのスキルを読み込みます。具体的には、次のような場合です。

• プロバイダーのカウンターを収集してスキーマにまとめ、外部へ送信するコレクターを立ち上げ、下流のコンシューマーに適したエクスポートバックエンド（Prometheus pull、Fluent Bit push、NetFlow、file / IPC）を決定する。
• プロバイダー／カウンターファミリーをコレクターに接続し、設定をコミットする前にデバイスが実際にそれを公開していることを確認する（doca-telemetry-utils/SKILL.md と共有されている、コミット前にゲートを設けるルール）。
• エクスポーターを有効化または調整してメトリクスが実際にホスト外へ送信されるようにし、下流のコンシューマーがエンドツーエンドでデータを受信することを確認する（「デーモンが稼働している」だけでは不十分です）。
• 起動はするもののスキーマ行が生成されない、下流へ何も送信しない、またはエクスポーターのエンドポイントが応答しないコレクターを診断し、推測するのではなく、段階的な調査手順に沿って確認する。
• ユーザーの質問が、実際には製品化された DTS コンテナーに関するもの（公開ドキュメントに案内。非対象 #7）、リーダーライブラリーに関するもの（doca-telemetry に案内）、またはパブリッシャーライブラリーに関するものであり（doca-telemetry-exporter に案内）、このスキルが扱う収集メカニズムの範囲外であると見極める。

次の場合はこのスキルを読み込まないでください。ハードウェアカウンターのリーダー API を扱う場合（doca-telemetry/SKILL.md を使用）、パブリッシャー API を扱う場合（doca-telemetry-exporter/SKILL.md を使用）、製品化された DTS コンテナーを運用する場合（doca-public-knowledge-map/SKILL.md の非対象 #7 を通じて案内）、DOCA のインストールまたは環境の準備を行う場合（doca-setup/SKILL.md を使用）、またはハードウェアの状態を変更する場合（doca-hardware-safety/SKILL.md を使用）。

このスキルの内容

このスキルは薄いローダーです。実質的な内容は、次の 2 つの補助ファイルに記載されています。

• 機能補助ファイル — クラスとしてのコレクターのデプロイ契約。4 つの領域の区分（clx 収集メカニズムと、リーダーライブラリー、パブリッシャーライブラリー、製品化された DTS の違い）、収集パイプラインの構成（プロバイダー／カウンター → スキーマ → コレクターデーモン → エクスポーター）、クラスレベルでのエクスポートバックエンドの範囲（Prometheus pull、Fluent Bit push、NetFlow、file / IPC）、doca-version/SKILL.md に対するバージョンの重ね合わせ、エラー分類（コレクターが起動しない → プロバイダー行がない → スキーマの不一致 → エクスポーターが応答しない → 下流とのずれ → トランスポート）、可観測性の範囲、安全ポリシー（コミット前にプロバイダーのサポートを確認する。コレクターはデバイスに対して読み取り専用である。変更を伴う手順はすべて doca-hardware-safety/SKILL.md に案内する。clx の名前やパスをでっち上げない）。
• タスク補助ファイル — デプロイに関する動詞ごとの手順付きワークフロー：configure、build（案内用スタブ）、modify、run、test、debug。また、対象外の質問（2 つのライブラリー、製品化された DTS コンテナー、環境の準備、ハードウェア状態の変更）をそれぞれの担当先へ案内する Deferred task verbs ブロックもあります。

このスキルでは、DOCA がすでにインストールされ、正常に動作しているホストまたは BlueField（doca-setup ## test に準拠）で、オペレーターがコレクターを実行でき、そのエクスポーターの送信先に到達できることを前提とします。DOCA のインストールは対象外です。この手順については doca-setup/SKILL.md を参照してください。また、リーダー／パブリッシャーライブラリー API および製品化された DTS コンテナーも対象外です。

読み込み順

1. このスキルを最初に読んで、ユーザーの質問が対象範囲内であることを確認します（CollectX ベースのコレクターとそのエクスポーターの操作です。リーダー／パブリッシャーライブラリの API や、製品化された DTS コンテナーは対象外です）。
2. 4 つの領域への分解、収集パイプラインの構成、エクスポートバックエンドのクラスの範囲、バージョンの適用、エラーの分類、可観測性の範囲、安全性ポリシーについては、機能のコンパニオンを参照してください。
3. 手順ごとのワークフロー（configure、build（ルーティング用スタブ）、modify、run、test、debug、および Deferred task verbs ブロック）については、タスクのコンパニオンを参照してください。

どちらのコンパニオンファイルも、相互にリンクしています。また、正規のバージョン処理ルールについては doca-version/SKILL.md に、答えがコレクター固有のガイダンスではなく「ライブ設定／公開ドキュメントを参照する」である場合は、 doca-public-knowledge-map/SKILL.md にリンクしています。

関連スキル

• doca-telemetry/SKILL.md — ハードウェアカウンターのリーダー API。
• doca-telemetry-exporter/SKILL.md — アプリケーション側のパブリッシャー API。
• doca-telemetry-utils/SKILL.md — スキーマ／Data ID／サポート確認用 CLI。
• doca-setup/SKILL.md — インストールと環境の前提条件。
• doca-version/SKILL.md — 4 方向のバージョン一致。
• doca-hardware-safety/SKILL.md — ハードウェアを変更する操作全般。
• doca-bare-metal-deployment/SKILL.md — ベアメタルでのコレクター起動。
• doca-container-deployment/SKILL.md — コンテナーとしてのコレクター起動。
• doca-public-knowledge-map/SKILL.md — 公開テレメトリー／DTS のルーティング。