A コマンド・リファレンス

注意:

Java Flight Recorderを本番で使用するには、商用ライセンスが必要です。商用機能の詳細とそれらを有効化する方法については、http://www.oracle.com/technetwork/java/javaseproducts/にアクセスしてください。

この付録は、Java Flight Recorderで使用可能なコマンドの基本リファレンスとして利用できます。次のセクションがあります。

セクションA.1「コマンド行オプション」
セクションA.2「診断コマンド・リファレンス」

A.1 コマンド行オプション

javaコマンドでJavaアプリケーションを起動する際には、Java Flight Recorderを有効にしたり、その設定を構成したり、記録を開始したりするためのオプションを指定できます。次のコマンド行オプションは、Java Flight Recorderに固有です。

-XX:+|-FlightRecorder
-XX:FlightRecorderOptions
-XX:StartFlightRecording

これらのコマンド行オプションは、商用ライセンスのJDKでのみ使用できます。これらを使用するには、-XX:+UnlockCommercialFeaturesオプションを指定するか、アプリケーションの実行後に商用機能をロック解除する必要があります。商用機能をロック解除して実行時に動的にフライト記録を開始する方法の例は、セクション2.1「コマンド行の使用」を参照してください。

注意:

-XXオプションは、システムを完全に理解している場合にのみ使用すべきです。これらのコマンドを不適切に使用すると、システムの安定性やパフォーマンスに影響が及ぶ可能性があります。-XXオプションは試験的なものであり、随時変更される可能性があります。

A.2診断コマンド・リファレンス

ここでは、Java Flight Recorderの制御に使用可能な診断コマンドと、各コマンドで使用可能なパラメータについて説明します。この情報は、プロセス識別子の後にhelpパラメータとコマンド名を指定して、jcmdを実行することで、入手することもできます。たとえば、識別子が5361の実行中のJVMプロセスで、JFR.startコマンドに関するヘルプ情報を取得するには、次のように実行します。

jcmd 5361 help JFR.start

JVMで使用可能な診断コマンドの完全なリストを取得する場合は、コマンド名を指定しないでください。

Java Flight Recorderに関連する診断コマンドです。

JFR.start
JFR.check
JFR.stop
JFR.dump
VM.unlock_commercial_features
VM.check_commercial_features

A.2.1 JFR.start

JFR.start診断コマンドは、フライト記録を開始します。表A-1に、このコマンドで使用可能なパラメータの一覧を示します。

表A-1 JFR.start

パラメータ	説明	値の型	デフォルト
name	記録の名前	String
settings	サーバー側テンプレート	String
defaultrecording	デフォルト記録を開始します	Boolean	False
delay	記録の開始を遅らせます	Time	0s
duration	記録の期間	Time	0s (「永遠」を意味する)
filename	結果の記録ファイル名	String
compress	GZipが結果の記録ファイルを圧縮します	Boolean	False
maxage	バッファ・データの最大有効期間	Time	0s (「有効期間の制限なし」を意味する)
maxsize	バッファの最大サイズ(バイト数)	Long	0 (「最大サイズなし」を意味する)

A.2.2 JFR.check

JFR.checkコマンドは、実行中の記録に関する情報を表示します。表A-2に、このコマンドで使用可能なパラメータの一覧を示します。

表A-2 JFR.check

パラメータ	説明	値の型	デフォルト
name	記録の名前	String
recording	記録のID	Long	1
verbose	冗長データを出力します	Boolean	False

A.2.3 JFR.stop

JFR.stop診断コマンドは、実行中のフライト記録を停止します。表A-3に、このコマンドで使用可能なパラメータの一覧を示します。

表A-3 JFR.stop

パラメータ	説明	値の型	デフォルト
name	記録の名前	String
recording	記録のID	Long	1
discard	記録データを破棄します	Boolean
copy_to_file	記録データをファイルにコピーします	String
compress_copy	GZipが「copy_to_file」先を圧縮します	Boolean	False

A.2.4 JFR.dump

JFR.dump診断コマンドは、実行中のフライト記録を停止します。表A-4に、このコマンドで使用可能なパラメータの一覧を示します。

表A-4 JFR.dump

パラメータ	説明	値の型	デフォルト
name	記録の名前	String
recording	記録のID	Long	1
copy_to_file	記録データをファイルにコピーします	String
compress_copy	GZipが「copy_to_file」先を圧縮します	Boolean	False

A.2.5 VM.unlock_commercial_features

VM.unlock_commercial_featuresコマンドは、すでに実行されているJVMで商用機能をロック解除するために使用します。このコマンドにパラメータはありません。

A.2.6 VM.check_commercial_features

VM.check_commercial_featuresコマンドは、すでに実行されているJVMで商用機能がロックされているか、ロック解除されているかを確認するために使用します。このコマンドにパラメータはありません。