Cluster API ログ¶
Cluster API 解説書
ロガー¶
ロガーを使用することで、ロガーごとにログレベルを設定できます。ロガーは、プロジェクト内のログ要素の名前です。ログレベルは、ログの情報量に影響します。ログレベルには、debug、info、warning、error、fatal 、panic があります。
-
GET
/log/defaults
¶ デフォルトのロガー設定を所得する
応答 JSON オブジェクト: - [key] (string) – ロガーレベル。
応答例 :
{ "leaf": "info" }
-
POST
/log/defaults/{loggerID}
¶ デフォルトのロガーを更新する
パラメータ: - loggerID – ロガー ID
リクエスト JSON オブジェクト: - [key] (string) – ロガーレベル。
クエリ例 :
{ "leaf": "info" }
-
GET
/log/allocs/{allocID}
¶ 現在割り当てられているロガーの設定を取得します。値を設定しない場合、デフォルト値を使用していることを意味します。割り当てはタスクのインスタンスです。
パラメータ: - allocID – 割り当て ID
応答 JSON オブジェクト: - [key] (string) – ロガーレベル。
応答例 :
{ "leaf": "info" }
-
POST
/log/allocs/{allocID}/{loggerID}
¶ 割り当てられているロガーを設定する
パラメータ: - allocID – 割り当て ID
- loggerID – ロガー ID
リクエスト JSON オブジェクト: - [key] (string) – ロガーレベル。
応答 JSON オブジェクト: - [key] (string) – ロガーレベル。
クエリ例 :
{ "leaf": "info" }
応答例 :
{ "leaf": "info" }
ログ¶
-
GET
/log/logs
¶ ログを取得する
応答 JSON オブジェクト: - [] (object) –
- [].id (string) – ログ名。
- [].fileName (string) – ファイル名。例: stderr、stdout。
- [].group (string) – ロググループ。
- [].job (string) – ログジョブ。
- [].logLevel (boolean) – ログが動的ログレベルをサポートするかどうか。
- [].task (string) – タスク。
応答例 :
[ { "id": "web", "fileName": "stdout", "group": "web", "job": "web", "logLevel": false, "task": "web" } ]
-
POST
/log/logs
¶ ログを設定する
リクエスト JSON オブジェクト: - [] (object) –
- [].id (string) – ログ名。
- [].fileName (string) – ファイル名。例: stderr、stdout。
- [].group (string) – ロググループ。
- [].job (string) – ログジョブ。
- [].logLevel (boolean) – ログが動的ログレベルをサポートするかどうか。
- [].task (string) – タスク。
クエリ例 :
[ { "id": "web", "fileName": "stdout", "group": "web", "job": "web", "logLevel": false, "task": "web" } ]
-
DELETE
/log/logs
¶ すべてのログを削除する
-
POST
/log/log/{logID}
¶ ログを作成する
パラメータ: - logID – ログ ID
リクエスト JSON オブジェクト: - id (string) – ログ名。
- fileName (string) – ファイル名。例: stderr、stdout。
- group (string) – ロググループ。
- job (string) – ログジョブ。
- logLevel (boolean) – ログが動的ログレベルをサポートするかどうか。
- task (string) – タスク。
クエリ例 :
{ "id": "web", "fileName": "stdout", "group": "web", "job": "web", "logLevel": false, "task": "web" }
-
PUT
/log/log/{logID}
¶ ログを更新する
パラメータ: - logID – ログ ID
リクエスト JSON オブジェクト: - id (string) – ログ名。
- fileName (string) – ファイル名。例: stderr、stdout。
- group (string) – ロググループ。
- job (string) – ログジョブ。
- logLevel (boolean) – ログが動的ログレベルをサポートするかどうか。
- task (string) – タスク。
クエリ例 :
{ "id": "web", "fileName": "stdout", "group": "web", "job": "web", "logLevel": false, "task": "web" }
-
DELETE
/log/log/{logID}
¶ ログを削除する
パラメータ: - logID – ログ ID
-
GET
/log/meta/{logID}
¶ ログのメタデータを取得する
パラメータ: - logID – 未定義
応答 JSON オブジェクト: - [] (object) –
- [].allocID (string) – ログの割り当て ID。
- [].status (string) – タスクステータス。
- [].logLevel (boolean) – プロセスがログレベルをサポートするかどうか。
- [].jobName (string) – ジョブ名。
- [].taskName (string) – タスク名。
- [].fileName (string) – ファイル名。
- [].createTime (string) – ログの作成日付。
応答例 :
[ { "allocID": "8e8c53da-b60f-c3c7-1d63-2243507fee1a", "status": "running", "logLevel": true, "jobName": "tutorial", "taskName": "tutorial", "fileName": "stderr", "createTime": 1549982869888 } ]
-
GET
/log/fs/{alloc}/{task}/{fs}
¶ ログデータを取得する
パラメータ: - alloc – 割り当て ID
- task – タスク名
- fs – ファイルシステム ID。stdout または stderr
クエリパラメータ: - origin – ログの起点。start または end
- offset – 起点からのオフセット
応答 JSON オブジェクト: - Offset (integer) – 起点からのオフセット。
- Data (string) – ログデータ。
- File (string) – ファイル。
- FileEvent (string) –
応答例 :
{ "Offset": 0, "Data": "logData", "File": "", "FileEvent": "" }