3.1 JDK Flight Recorderの記録

JFRの取得

JFRを取得するには以下のいずれかの方法でJFRの記録を開始する必要があります。

1. GUI(JMC/VisualVM)で記録する
2. CLIで記録する
3. JVMオプションで記録する
4. プログラム上から記録する

実運用として一番利用するのはJVMオプションでの指定だと思いますが他の方法に関しても説明します。

GUI(JMC/VisualVM)で記録する

JDK Mission ControlまたはVisualVMを利用することでJFRの記録をGUIから開始することが出来ます。 GUIから起動でき、結果もそのままJMC等で分析できるので従来的なプロファイラと同様の使い方をすることが出来ます。

CLIで記録する

jcmdコマンドを使ってコマンドラインからJFRの記録を開始することが出来ます。 jcmdコマンドは１章でも説明したとおり主にJFRの操作, プロセスの取得, スレッドダンプの取得等が行えるJavaの診断ツールです。

JFRに関連するオプションは以下となります。

オプションなしのjcmdまたはPSコマンドでターゲットのプロセスIDを確認してJFR.startなどを実行します。 例えばプロセスIDが1234のJavaプロセスで１分感の記録を開始してmyrecording.jfrに保存するには以下のコマンドを実行します。

$ jcmd 1234 JFR.start duration=1m filename=myrecording.jfr

実際にはJFRの起動は後述するJVMオプションで指定して、JFRファイルを取得したい任意のタイミングでdumpを使ってファイル出力をさせるのが実運用では多いでしょう。

$ jcmd 1234 JFR.dump filename=myrecording.jfr

JFR.dumpを使うことでJFRの記録自体はメモリ上に常時しつつ、必要なタイミングでファイルに出力するという運用が出来ます。

JVMオプションで記録する

JFRの記録の開始として最も頻繁に利用するのがJVMオプションでの指定です。

JFRはやはりブラックボックス分析に向いた仕組みなので常時有効にしておくのが基本的な戦略となります。そうなるとGUIやコマンドで必要なときに付けるというよりも、JVMオプションで起動時にしていして常時稼働させておくのがベストプラクティスとなります。

JVMオプションでは-XX:StartFlightRecordingと-XX:FlightRecorderOptionsを使用します。-XX:StartFlightRecordingは時間固定の場合の指定、-XX:FlightRecorderOptionsは継続実行の時のオプションですが組み合わせで使う必要がある認識です。

注意点としてオプションがJDK8の頃とJDK9以降で変わっているということです。

例えば以下のJDK8とJDK11は同じ意味のオプションです。

JDK 8:

-XX:+UnlockCommercialFeatures
-XX:+FlightRecorder
-XX:FlightRecorderOptions=defaultrecording=true,
dumponexit=true, dumponexitpath=/var/log/myapp/myapp.jfr

JDK 11:

-XX:StartFlightRecording=dumponexit=true,
filename=/var/log/myapp/myapp.jfr

JDK11からはOpenJDKに寄贈されたのでJFRの利用にUnlockCommercialFeaturesが不要になったというのもありますが、-XX:+FlightRecorderオプションが廃止されたりdumponexitpathがfilenameになったりと変わった部分も多いです。

そのためWebの資料や既存の運用スクリプトを参考にする時には注意してください。 最新のオプションはJava SE 11 - Advanced Runtime Optionsで確認することができます。

JFRオプションはそれぞれ以下になります。

XX:StartFlightRecording

-XX:StartFlightRecording=parameter=valueはjcmdのJFR.startと等価なJFRを開始するためのオプションです。 カンマ区切りで多くのオプションを指定することが出来ます。

XX:FlightRecorderOptions

-XX:FlightRecorderOptions=parameter=valueはjcmdのJFR parameterと等価なJFRオプションを指定するためのオプションです。 カンマ区切りで多くのオプションを指定することが出来ます。

プログラム上から記録する

JFR APIを使う事でプログラム上からJFRを記録することも可能です。

var jfrConfig = jdk.jfr.Configuration.getConfiguration("default");
var path = Path.of("/tmp/myrecording.jfr");
try (var recording = new jdk.jfr.Recording(jfrConfig)) {
    recording.setName("Hello JFR");
    recording.start();

    // - ここに何か処理を入れる -

    recording.stop();
    recording.dump(path);
}

通常は利用することは少ないと思いますが、マイクロベンチマークの値をJFRに記録したい場合等には便利です。