公開 Docs

CLI から始め、同じ文脈を Web 作業環境で読み取ります。

LogBrew の Docs は、セットアップ、テレメトリー読み取り、ダッシュボード状態、エージェントが読める Markdown ミラーを、予測しやすい公開パスにまとめます。

ダッシュボードを開くMarkdown を読む
最初のコマンド
logbrew status --json

status はローカルで動作し、トークンを安全に扱い、プロジェクトデータを読む前にエージェントが解析できる復旧手順を返します。

コマンドマップ

Status

private 読み取りの前に、ローカル auth、API 到達性、復旧手順を確認します。

logbrew status --json

コマンドマップ

ログ

リリース、プロジェクト、トレースの文脈が必要なときは、直近のエラーから始めます。

logbrew logs --level error --json

コマンドマップ

課題

解決、クローズ、無視、再オープンを決める前に、未解決の失敗グループを一覧します。

logbrew issues open --json

コマンドマップ

トレース詳細

ログや課題が一つの失敗リクエストを指すとき、既知の trace id を読みます。

logbrew trace <trace_id> --json

コマンドマップ

アクション

重要な文脈がプロダクト操作の場合、ユーザーイベントを名前で絞り込みます。

logbrew actions --name checkout_failed --json

コマンドマップ

リリース

ログ、課題、トレース span、アクション数でロールアウト文脈を比較します。

logbrew releases --json

まず CLI

ローカル認証と API 到達性を確認する

最初の読み取りでは、トークン情報を出さずに、CLI が LogBrew API へ到達できるかを人とエージェントへ示す必要があります。

  • エージェントが安定したフィールドを必要とするときは JSON モードを使います。
  • 開発者が次のコマンドを必要とするときは人向け出力を使います。
  • auth の復旧は login と status へ戻すようにします。

観測

本番シグナルをリソースごとに読む

ログ、課題、アクション、トレース、リリース、プロジェクトは、すばやく確認できる程度に分け、文脈を戻せる程度につなげます。

  • ログはレベル、リリース、環境、プロジェクト、トレース、検索フィルターを保持します。
  • 課題は状態、トレース文脈、変更語彙を保持します。
  • トレースは span 名、リリース文脈、環境文脈、プロジェクト範囲を保持します。

エージェント

公開 Docs をブラウザー状態なしで読めるように保つ

すべての公開ページには Markdown ミラーを用意し、JavaScript、Cookie、ログイン、CAPTCHA、チャレンジページなしで到達できる状態を保ちます。

  • 公開エージェントリソースは llms.txt に一覧化します。
  • 公開読み取りを許可し、private ルートを守るために robots.txt を使います。
  • ダッシュボードデータは backend auth と noindex メタデータの後ろに置きます。

API マップ

ダッシュボードを backend ルートに合わせる

Web 作業環境は、dashboard-only の保存先や別契約を作らず、既存の Rust API ルートグループを読む必要があります。

  • ログは /api/logs から、レベル、リリース、環境、プロジェクト、トレース、検索フィルターで読み取ります。
  • 課題は /api/telemetry/issues と /api/telemetry/issues/{issue_id} から読み取り、変更します。
  • アクション、リリース、トレース詳細は /api/telemetry/actions、/api/telemetry/releases、/api/telemetry/traces/{trace_id} から読み取ります。
  • プロジェクトと auth 状態は /api/projects、/api/auth、CLI status コマンドから取得します。