collect-snapshot.sh(スナップショットログ収集)
形式
collect-snapshot.sh [--help] [--port=<port>|--endpoint=<endpoint>] [--threaddumpnum=<number>] [--watchcommand=<boolean>] [--timeout-sec=<timeout>] [--file=<file>]
機能
スナップショットログを収集し,指定したパスに出力します。また,標準出力または標準エラー出力にメッセージを出力します。
引数
collect-snapshot.shコマンドのオプションを次の表に示します。
オプション |
説明 |
省略の可否 |
省略時の動作 |
---|---|---|---|
--help |
使用方法(Usage)を出力します。 |
省略可 |
使用方法(Usage)を出力しません。 |
--port=<port> |
スナップショットログ収集REST APIのポート番号を指定します。1〜65535の範囲で指定します。
|
省略可 |
「28081」を使用します。 |
--endpoint=<endpoint> |
スナップショットログ収集REST APIのエンドポイントを指定します。
|
省略可 |
「http://localhost:28081/api/v1/snapshot」を使用します。 |
--threaddumpnum=<number> |
スレッドダンプの取得回数を指定します。0〜60の範囲で指定します。 |
省略可 |
収集対象のプロセスモニタに設定されている<snapshot.rest.default.threaddumpnum※の指定値>の値を使用します。 |
--watchcommand=<boolean> |
マシンリソースの使用状況を取得するかどうかを,trueまたはfalseで指定します。 |
省略可 |
収集対象のプロセスモニタに設定されている<snapshot.rest.default.watchcommand.enabled※の指定値>の値を使用します。 |
--timeout-sec=<timeout> |
コマンドを実行後,指定した時間を経過しても収集処理が終わらない場合のタイムアウト時間を指定します。単位は秒です。1〜2147483647の範囲で指定します。 |
省略可 |
タイムアウトしません。 |
--file=<file> |
出力先パスを指定します。 |
省略可 |
「./snapshot.zip」を使用します。 |
- 注※
-
config.properties(本製品の設定ファイル)のプロパティです。
monitor.rest.port,およびmonitor.rest.bindaddressについては,「18.2.4(2) プロセスモニタに関するプロパティ」を参照してください。
snapshot.rest.default.threaddumpnumおよびsnapshot.rest.default.watchcommand.enabledについては,「18.2.4(4) スナップショットログ収集機能に関するプロパティ」を参照してください。
出力形式
-
標準出力に処理中のメッセージを出力します。
-
標準エラー出力にエラーメッセージを出力します。
-
--fileオプションのパス(省略時はカレントディレクトリのsnapshot.zip)にスナップショットログを出力します。
入力例
-
カレントディレクトリのsnapshot.zipにスナップショットログを出力します。
$ collect-snapshot.sh
-
オプションを指定してsnapshot1.zipにスナップショットログを出力します。
$ collect-snapshot.sh --port=28082 --threaddumpnum=3 --watchcommand=true --timeout-sec=60 --file=snapshot1.zip
戻り値
- 0:
-
正常終了しました。
- 1:
-
引数が不正です。
- 2:
-
異常終了しました。