coralogix-docs

Coralogix ドキュメント（cx docs search、cx docs fetch）

これらのコマンドは、coralogix.com/docs にある公式 Coralogix 製品ドキュメントを読み込みます。プラットフォームの仕組みや、設定方法・使用方法について回答します。テナントのログ、スパン、メトリクス、アラートは検索しません。

Coralogix API キーは必要ありません。

CLI コマンド

コマンド	用途
cx docs search <query>	キーワードでドキュメントページを検索します。番号付きのタイトルとパスのサフィックスを返します。
cx docs fetch <suffix>	1 ページを Markdown としてダウンロードします。search の結果に含まれるサフィックスを渡します。

フラグ

フラグ	コマンド	説明
--limit	search	結果の最大数、1～20（デフォルトは 5）
-o json / -o toon	両方	機械可読形式の出力

例

cx docs search "explore spans" --limit 5
cx docs search "OpenTelemetry traces"
cx docs fetch user-guides/data_exploration/spans/
cx docs search "API keys" -o json

これらのコマンドを使用する場面

ユーザーが次のことを知りたい場合は、cx docs search と cx docs fetch を使用します。

トピック	質問の例
UI／ワークフロー	「Coralogix でスパンを表示するにはどうすればよいですか？」「Explore spans はどこにありますか？」
取り込みとインテグレーション	OpenTelemetry のセットアップ、エージェント／コレクターの設定、Send Your Data API キー
プラットフォーム機能	アラート、SLO、ダッシュボード、エンリッチメント、パースルール、保持期間
概念とアーキテクチャ	トレーシングの仕組み、トレースとログの相関、データモデル
アカウントとアクセス	API キー、SSO、ロール、リージョン

回答が現在の Coralogix 製品の動作や UI の操作手順に依存する場合は、推測するよりこれらのコマンドを優先してください。

これらのコマンドを使用しない場面

ユーザーのニーズ	代わりに使用
ライブログのクエリ	cx logs — cx-telemetry-querying
ライブスパン／トレースのクエリ	cx spans — cx-telemetry-querying
DataPrime の構文／コマンド	cx dataprime list / cx dataprime show — cx-telemetry-querying
テナント内のアラートとケース	cx alerts、cx cases — cx-alerts、cx-cases
メトリクス（PromQL）	cx metrics — cx-telemetry-querying
テナントデータ内のフィールドパスの検出	cx search-fields

標準的なワークフロー

1. cx docs search で焦点を絞ったクエリを検索します（文章ではなく、2～4 個のキーワードを使用します）。
2. 結果から最も関連性の高いサフィックスを選びます。
3. そのサフィックスを指定して cx docs fetch を実行します。
4. 取得した内容をもとに回答します。必要な場合に限り、追加のページを取得します。

User: "How do I show spans in the Coralogix website?"

1. cx docs search "explore spans" --limit 5
2. cx docs fetch user-guides/data_exploration/spans/
3. Summarize: Explore → spans dataset → Spans/Traces/Flows tabs → drilldown

ヒント

cx docs search

• 文章ではなく、焦点を絞った用語を 2～4 個指定して検索を始めます。
• 一致する結果がない場合は、類義語やより広い用語を試します（"distributed trace waterfall view" ではなく "tracing" など）。
• 最初の検索結果が曖昧な場合は、--limit を増やします。
• 結果には /docs/ 以下のパスのサフィックスが表示されます（完全な URL ではありません）。そのまま cx docs fetch に渡してください。

cx docs fetch

• cx docs search の結果に含まれるサフィックスを渡します（例：user-guides/data_exploration/spans/）。完全な URL は受け付けられません。
• cx docs fetch は一度に 1 ページ取得します。まず最適なページを選んでください。

トラブルシューティング

問題	対応
検索結果がない	クエリを広げるか言い換えます。機能名とカテゴリを組み合わせて試します（"spans UI"、"OTel ingestion"）。
取得したページの内容が限定的すぎる	親トピックを検索するか、関連する用語でもう一度検索します。
ユーザーが実際のデータについて知りたい	cx logs、cx spans、cx metrics、または alerts に切り替えます。ドキュメントが説明するのは製品であり、テナントの内容ではありません。

関連項目

• テレメトリークエリ： cx-telemetry-querying
• アラート： cx-alerts
• ダッシュボード： cx-dashboards