プロジェクト、サービス、環境
プロジェクトを設定する
CLI をインストールします。logbrew status --json を実行して、アカウントのアクセス権を確認します。アクセス権が有効でない場合は、人が logbrew login を実行します。プロジェクトの取り込みキーではサインインできません。
1
プロジェクトを作成または選択する
まずプロジェクトの一覧を表示します。プロジェクトは、まだ存在しない場合にだけ作成します。CLI は、取り込みキーを所有者だけが読める新しいファイルに書き込みます。キーやファイルのパスは表示しません。結果がはっきりしない場合は、同じコマンドをそのままもう一度実行します。プロジェクト名やキーのファイルは変更しないでください。CLI は保留中のリクエストの識別情報を再利用します。結果からプロジェクト ID を読む方法は、クイックスタートで説明しています。既存のプロジェクトの場合は、設定状況を記録します。既存のプロジェクトに別の取り込みキーを作成するには、
logbrew projects keys create を使います。コマンドは取り込みキーのローテーションにあります。logbrew setup --create-project はヘルプを表示するだけです。プロジェクトは作成しません。2
SDK でサービス名を設定する
api、worker、web、ios、checkout-api など、リポジトリやデプロイで使っている名前を使います。サービス名はラベルであり、プロジェクトを選ぶものではありません。プロジェクトは取り込みキーで決まります。サービス名を変えても、保存済みのイベントは移動しません。イベントが見つからない場合は、別のプロジェクトを作成する前に、アプリケーションが使っているプロジェクトと取り込みキーを確認してください。3
標準の環境名を使う
production、staging、preview、local を使います。デプロイで別の名前を使っている場合は、その名前を一貫して使います。環境名には、スペース、/、バックスラッシュを含められません。4
テストイベントを送信して読む
SDK 連携の説明に従い、プロジェクトの取り込みキーで SDK を設定します。プロジェクトを作成しても、アプリケーションに SDK はインストールされません。キーはソース管理に含めないでください。サービス、環境、リリースはアプリケーションで設定します。安全なイベントを1件送信し、読み取ります。シグナルごとに一覧は別です。ログの一覧が空でも、プロジェクトに課題やトレースがないとは限りません。ダッシュボードでは、同じプロジェクトと、テストイベントを含む期間を選択します。サービス、環境、リリースのフィルターがイベントと一致していることを確認してください。
プロジェクトの設定を診断する
設定状況はプロジェクトの doctor で読みます。ローカルのファイルや、空のログクエリから設定状況を推測しないでください。status、checks、next を含むレポートを返します。終了コード 0 は、すべてのチェックに合格したことを示すものではありません。checks の各項目を読んでください。プロジェクトの doctor レポートを読むを参照してください。
API を直接呼び出したときのレスポンス
API クライアントは、アカウントの認証でGET /api/projects/{project_id}/doctor を呼び出します。このエンドポイントには、クエリパラメーターもリクエストボディもありません。この読み取りには、プロジェクトの取り込みキーを決して使わないでください。
200 のレスポンスには、project_id、state、setup_status、setup_acknowledged、has_active_ingest_key、first_telemetry_seen_at、last_seen_at、last_signal、next、next_action のキーがあります。タイムスタンプは RFC3339 または null です。last_signal は表示しても安全な要約で、生のシグナルではありません。
doctor は最初に取り込みキーを確認します。有効な取り込みキーがないプロジェクトは、設定状況にかかわらず
needs_ingest_key になります。
setup_status は created、setup_started、sdk_seen、first_telemetry_seen、active のいずれかです。setup_acknowledged が true になるのは、最後の3つの値の場合だけです。created は needs_setup になります。setup_started と sdk_seen は needs_telemetry になります。first_telemetry_seen と active は ready になります。
それでも読み取りに失敗する場合は、問題を報告してください。認証情報、ヘッダー、シグナルの本文、顧客データ、ローカルのパス、ソースコードは含めないでください。
プロジェクトをアーカイブまたは削除する
プロジェクトをアーカイブすると、有効なプロジェクトの一覧から外れます。--yes が必要です。アーカイブ後、そのプロジェクトの取り込みキーは新しいテレメトリを受け付けなくなります。API のルートは DELETE /api/projects/{project_id} です。ボディなしで 204 を返します。アーカイブ済みのプロジェクトは GET /api/projects/archived で一覧表示できます。復元するには POST /api/projects/{project_id}/restore を使います。これも 204 を返します。
プロジェクトを完全に削除するのは、確信がある場合だけにしてください。
--confirm の後に、同じプロジェクト ID をもう一度指定します。リクエストが受け付けられると、プロジェクトはすぐに無効になり、完全な削除が予定されます。その後はプロジェクトを復元できません。