--json を使います。
コマンドを実行する前に、山かっこのプレースホルダーをすべて置き換えてください。プロジェクト、課題、トレースの ID には、LogBrew が返した値を使います。
CLI をインストールする
インストール方法を1つ選びます。 macOS または Linux:Cargo には Rust 1.87 以降が必要です。他の方法はネイティブのバイナリをインストールするため、Rust は不要です。
CLI を更新する
CLI は自動では更新されません。インストールしたときと同じ方法で更新します。 Homebrew:ok、name、version、binary、os、arch が含まれます。
サインインしてセッションを確認する
現在のターミナルのアカウントを確認します。whoami に想定どおりのアカウントが表示されたら、次に進みます。表示されない場合はサインインします。プロバイダーへのログインは、人がブラウザーで完了します。コーディングエージェントは、この手順を人に依頼する必要があります。
github（デフォルト）、gitlab、bitbucket のいずれかです。ブラウザーを開かずにログイン URL を表示するには --no-open を使います。--json でも、ブラウザーを開かずにログインの引き継ぎ情報を表示します。
ログイン後に、status と whoami をもう一度実行します。アカウントの認証情報をプロンプト、レポート、ソースファイルに書かないでください。
SDK のセットアップを計画する
アプリのパッケージマニフェストまたはビルドマニフェストがあるディレクトリに移動します。モノレポでは、アプリまたはサービスを1つ選びます。次に、以下を実行します。detected、install_ready、install_plan、next を読みます。プランには、ランタイム、フレームワーク、パッケージマネージャー、インストールコマンドが含まれます。CLI はパッケージのインストールやファイルの変更を行いません。logbrew init、install、configure、sdk も同じプランを返します。
ランタイムごとの手順は、SDK 連携を参照してください。よく使うコマンドの短い一覧は logbrew examples で表示できます。
プロジェクトを読み取り、作成し、設定する
アカウントのアクティブなプロジェクトを一覧表示します。
JSON の結果には
status、project_id、ingest_key、checks、next が含まれます。ingest_key には、キーの id、label、kind、created_at、expires_at が含まれます。キーを置き換えるには、取り込みキーのローテーションを参照してください。
このコマンドは認証情報を作成します。実行する前に、プロジェクトが正しいことを確認してください。結果がはっきりしない場合は、同じコマンドをもう一度実行します。CLI は保留中の試行を再利用します。新しい試行を始めるときだけ --abandon-retry を使います。
新しいプロジェクトを作成するには、クイックスタートの手順に従います。クイックスタートでは logbrew projects create "<name>" --ingest-key-file "<private_key_file>" を使い、最初のキーを同じ方法で保存します。プロジェクト作成のヘルプを読むには logbrew setup --create-project を実行します。このコマンドはプロジェクトを作成しません。
セットアップの手順を終えたら、その手順をプロジェクトに記録できます。--source の値は api、cli、sdk のいずれかです。
0 は、すべてのチェックに合格したことを意味しません。レポートの status と各チェックを読んでください。doctor レポートのリファレンスを参照してください。
アカウントの使用量を確認する
使用量と上限を確認します。アカウントや請求の状態は変わりません。logbrew account usage --json も同じ結果を返します。レスポンスには、プラン、クォータの状態、リセット日、プロジェクト別とテレメトリの種類別の使用量の合計、次の手順が含まれます。フィールドには plan、state、reset_at、by_project、by_stream、next があります。
よく行う調査
それぞれの読み取りをプロジェクトで絞り込みます。コマンドが対応していれば、リリース、環境、時間、重大度のフィルターも追加します。フィルターを参照してください。リリースの課題
失敗した1件のリクエスト
リリースのログ
自分に割り当てられた課題
ライブイベントを監視する
変更をテストしながら新しいイベントを確認するには、watch を使います。停止するには Ctrl+C を押します。--json を付けないと、コマンドはエラーで停止します。1つの種類だけを監視するには、logbrew watch logs --json のように logs、issues、actions を追加します。watch はトレースとスパンに対応していません。
watch には、プロジェクト、リリース、環境のフィルターがありません。1つのプロジェクトに絞るには、上の読み取りコマンドを使います。対応するリソースとフィルターについては、ライブ監視を参照してください。
コードを変更する前に説明を読む
修正を提案する前に、コンテキストを読みます。1
課題を読む
2
トレースを読む
課題にトレース ID がある場合だけ、この手順を行います。トレースのない課題も有効です。
3
説明を読む
logbrew explain log "<log_id>" --json を使います。アクションには logbrew explain action "<action_id>" --json を使います。4
確認してから解決する
JSON 出力
--jsonは、logbrew --json statusやlogbrew status --jsonのように、コマンドの前にも後にも置けます。- 出力を使う前に、終了コードを確認します。
- JSON のエラーには
ok、error、message、nextが含まれます。タイムアウトは、書き込みが失敗したことの証明にはなりません。書き込みを繰り返す前に、その再試行のルールを読んでください。 --jsonなしの出力を自動化に使わないでください。形式が変わることがあります。