リファレンスAPI
ログ
logs カテゴリの API オペレーションを 1 件カバーします。
| メソッド | パス | 説明 |
|---|---|---|
| GET | /v1/orgs/{orgSlug}/projects/{projectName}/logs | ワーカー出力のライブテール(runlot logs) |
GET /v1/orgs/{orgSlug}/projects/{projectName}/logs
home ノードの node-agent が保持するリングバッファ(docs/phase6.md A1)を、変更を加えずに cp-core 経由でストリーミングします。レスポンスは text/x-ndjson で、1 行につき 1 件の LogEvent を含みます:まずバッファの最後の tail 行、次に follow が設定されている場合はクライアントが切断するまで新しい行が続きます。ping は 15 秒ごとに届きます — これによりプロキシがアイドル接続を閉じるのを防ぎ、クライアントはストリームが生きているかどうかを判断できます。
保存されたログではありません。 ノードメモリ内の直近の行のみです。プロセスが置き換えられた場合、runlot ストリームはその事実を 1 行で記録します(prod-gap)。
member 以上が必要です。読み取り専用のため、監査イベントは残りません。
operationId tailLogs
| パラメーター | 場所 | 必須 | 型 | 説明 |
|---|---|---|---|---|
tail | query | 不可 | integer | 最初に送信するバッファ行数です。上限は 2000 です |
follow | query | 不可 | boolean | バッファの送信が完了した後も新しい行のストリーミングを続けるかどうか |
| ステータスコード | 説明 | レスポンスボディ |
|---|---|---|
| 200 | NDJSON ストリーム — 1 行につき 1 件の LogEvent | LogEvent |
| 403 | — | — |
| 404 | — | — |
| 409 | 現在ストリーミング可能なプロセスがありません。code は no_home_node(コールド、または配置なし)または suspended のいずれかです。 | Error |
| 502 | ノードが応答していません。code は node_unreachable です | Error |