Cryostat を使用した JFR レコーディングの管理

手順

1. Cryostat インスタンスの Recordings メニューまたは Events メニューに移動します。

   注記

   以降の手順では、例として Recordings メニューを使用しますが、Events メニューでも同様の手順を実行できます。

2. Recordings パネルで、ドロップダウンリストからターゲット JVM を選択します。ターゲット JVM に信頼できる SSL 証明書が含まれていない場合、次の例のようにプロンプトが表示されます。

   図1.1 SSL エラーメッセージ

   

3. Security ボタンをクリックします。Cryostat Web コンソールでウィンドウが開き、Security ダイアログボックスが表示されます。

   図1.2 Security ダイアログボックス

   

4. Upload ボタンをクリックします。Cryostat Web コンソールで Upload SSL certificate ウィンドウが開きます。

   図1.3 Upload SSL certificate ウィンドウ

   

5. Browse ボタンをクリックして、ローカルシステムの SSL 証明書を見つけます。

   重要

   SSL 証明書は、binary または base64 のいずれかの形式を使用して、DER でエンコードされている必要があります。Cryostat は、.der および .cer ファイル拡張子をサポートします。

6. Cryostat インスタンスを再起動します。
7. Cryostat インスタンスの Recordings メニューに移動します。
8. Web コンソールに Authentication Required というメッセージが表示された場合は、認証情報を入力します。一部のターゲット JVM では、監査目的でデータにアクセスする前に認証が必要です。

手順

1. Security メニュー項目をクリックします。

2. Store Credentials ウィンドウで、Add ボタンをクリックします。Store Credentials ウィンドウが開きます。

   図1.5 Store Credentials ウィンドウの例

   

3. Match Expression フィールドに、一致式の詳細を指定します。

   注記

   疑問符アイコンを選択すると、Match Expression Hint スニペットに推奨の構文が表示されます。

4. Save をクリックします。Store Credentials ウィンドウにテーブルエントリーが表示され、ターゲット JVM の Match Expression が示されます。

   図1.6 Store Credentials ペインのテーブルエントリーの例

   
   重要

   セキュリティー上の理由から、テーブルエントリーにはユーザー名やパスワードは表示されません。

5. オプション: ターゲット JVM の保存済み認証情報を削除する場合は、このターゲット JVM のテーブルエントリーの横にあるチェックボックスを選択してから、Delete をクリックします。

手順

1. Active Recordings タブで、JFR レコーディングのチェックボックスを選択します。Archive ボタンは、Active Recordings ツールバーで有効になります。

   図2.1 JFR レコーディング用のアーカイブボタン

   

2. Archive ボタンをクリックします。Cryostat は、JFR レコーディングのアーカイブを作成します。

   選択したターゲット JVM に関連するその他のレコーディングとともに、Archived Recordings タブの下からアーカイブされたレコーディングを表示できます。

   または、All Targets テーブルの下からアーカイブされたレコーディングを表示できます。

   図2.2 All Targets テーブルの下にリストされたターゲット JVM アプリケーションの例

   
   ヒント

   アーカイブされたレコーディングがないターゲット JVM エントリーを削除するには、Hide targets with zero recordings チェックボックスを選択します。

   JVM ターゲットエントリーの横にある下矢印 (v) をクリックすると、フィルター機能にアクセスできます。この機能では、ラベルを編集してフィルターを強化したり、Delete ボタンをクリックしてフィルターを削除したりできます。

3. All Targets テーブルから、確認する各ターゲット JVM アプリケーションの横にあるチェックボックスを選択します。テーブルには、アーカイブされた各レコーディングとそのソースの場所がリスト表示されます。

4. All Archives テーブルに移動します。このテーブルは All Targets テーブルに似ていますが、All Archives テーブルには、Cryostat が Cryostat 内でアーカイブしたファイルからのターゲット JVM アプリケーションがリスト表示されます。

   注記

   アーカイブされたファイルに認識可能な JVM アプリケーションがない場合、そのファイルは引き続き All Archives テーブルにリストされますが、見出し lost の下のネストされたテーブル内で開きます。

5. オプション: アーカイブされたレコーディングを削除するには、特定のアーカイブされた JFR レコーディング項目の横にあるチェックボックスを選択し、プロンプトが表示されたら Delete をクリックします。

   図2.3 アーカイブされた JFR レコーディングの削除

   
   注記

   Cryostat は、ターゲット JVM アプリケーションのアドレス、アクティブなレコーディングの名前、作成されたアーカイブ済みレコーディングのタイムスタンプに基づいて、アーカイブされたレコーディングに名前を割り当てます。

手順

1. Cryostat インスタンスの Recordings メニューまたは Archives メニューに移動します。

   注記

   以降の手順では、例として Recordings メニューを使用しますが、Archives メニューでも同様の手順を実行できます。

2. Active Record タブまたは Archived Recordings タブをクリックして、必要なレコーディングを決定します。

3. リストされた JFR レコーディングを見つけ、そのオーバーフローメニューを選択します。

   図2.4 JFR レコーディングのオーバーフローメニューの表示

   

4. 以下のいずれかのオプションを選択します。

   1. オーバーフローメニューから、Download Recording をクリックします。オペレーティングシステムの設定に応じて、ファイル保存ダイアログが開きます。JFR バイナリーファイルと JSON ファイルを任意の場所に保存します。
   2. All Targets テーブルから、リストされている JFR レコーディングのオーバーフローメニューを選択します。Download をクリックして、アーカイブされたファイルを、メタデータとラベル情報を含む JSON ファイルとともにローカルシステムに保存します。

5. オプション: ダウンロードしたファイルを Java Mission Control (JMC) デスクトップアプリケーションで表示します。

   注記

   .jfr ファイルをダウンロードせずに、Cryostat アプリケーションでレコーディングからのデータを表示する場合は、View in Grafana オプションをクリックします。

手順

1. Cryostat インスタンスの Archives メニューに移動します。

   図2.5 Cryostat Web コンソールの Archives メニュー

   

2. オプション: Uploads テーブルから、アップロードされたすべての JFR レコーディングを表示できます。Uploads テーブルには、All Targets テーブルやその他の出力など、他のテーブルと同様のフィルタリングメカニズムも組み込まれています。Archives メニューのフィルタリングメカニズムを使用して、認識可能なターゲット JVM アプリケーションを持たない可能性があるアーカイブファイルを見つけることもできます。

   図2.6 Archives メニューの Uploads テーブル

   

3. アップロードアイコンをクリックします。Re-Upload Archived Recording ウィンドウが、Cryostat Web インターフェイスに表示されます。

   図2.7 Re-Upload Archived Recording ウィンドウ

   
4. JFR File フィールドで、Upload をクリックします。

5. 拡張子が .jfr のファイルである JFR レコーディングファイルを探し、Submit をクリックします。

   注記

   または、.jfr ファイルを JFR File フィールドにドラッグアンドドロップすることもできます。

手順

1. Cryostat インスタンスの Dashboard パネルで、ドロップダウンリストから Target JVM を選択します。

2. オプション: Topology パネルで、Add to view アイコンを選択してターゲット JVM を定義できます。アイコンを選択すると、カスタムターゲット接続 URL を定義するためのウィンドウが開きます。

   1. Connection URL フィールドに、JVM の Java Management Extension (JMX) エンドポイントの URL を入力します。
   2. オプション: Alias フィールドに、JMX Service URL のエイリアスを入力します。

   3. Create をクリックします。

      図3.1 Create Target ダイアログボックス

      

3. Cryostat Web コンソールのナビゲーションメニューから、Events をクリックします。Web コンソールで Authentication Required ダイアログが開く場合があります。プロンプトが表示されたら、Authentication Required ダイアログボックスに Username と Password を入力し、Save をクリックしてターゲット JVM に認証情報を提供します。

   注記

   選択したターゲット JMX で、JMX 接続に対して SSL/TLS 証明書が有効な場合は、プロンプトが表示されたら証明書を追加する必要があります。

   Cryostat は、ターゲット JVM アプリケーションの認証情報を暗号化し、Red Hat OpenShift の永続ボリューム要求 (PVC) に格納されているデータベースに保存できます。

4. Event Templates タブで、リストされたイベントテンプレートを見つけ、その他のオプションメニューを選択します。

5. その他のオプションメニューから、Download をクリックします。オペレーティングシステムの設定に応じて、ファイル保存ダイアログが開きます。ファイルを任意の場所に保存します。

   図3.2 イベントテンプレートのその他のオプションメニューの例

   

6. デフォルトのファイルエディターでファイルを開き、必要に応じてファイルを編集します。設定の変更を保持するには、ファイルを保存する必要があります。

   注記

   後の段階でファイルの特定に役立つ description および provider 属性に値を追加できます。

7. Events メニューから Event Templates タブに移動し、Upload アイコンをクリックします。Cryostat Web コンソールで Create Custom Event Template 開きます。

   図3.3 Create Custom Event Template ウィンドウ

   
8. Upload をクリックし、デフォルトのファイルエディターを使用して、1 つ以上の設定済みイベントテンプレートファイルを Cryostat Web コンソールにアップロードします。ファイルを Template XML ウィンドウにドラッグアンドドロップすることもできます。
9. Submit ボタンをクリックします。Cryostat Web コンソールで Event Templates タブが開き、カスタムイベントテンプレートが表示されます。

10. オプション: イベントテンプレートを作成すると、次のいずれかのオプションを選択し、テンプレートを使用して JFR レコーディングを作成できます。

    • Automated Rules メニューから Create をクリックし、Template リストからイベントテンプレートを選択します。
    • Events メニューから、リストされたイベントテンプレートを見つけ、その他のオプションメニューから Create Recording を選択します。
    • Recordings メニューの Active Recordings タブで、Create をクリックします。

手順

1. Cryostat インスタンスの Recordings メニューまたは Archives メニューに移動します。
2. 必要に応じて、Active Recordings タブまたは Archived Recordings タブをクリックします。

3. JFR レコーディングを見つけ、オーバーフローメニューを選択します。

   図4.1 JFR レコーディングの例で利用可能なオーバーフローメニュー項目

   
4. オーバーフローメニューから View in Grafana オプションをクリックします。新しい Web ブラウザーウィンドウで Grafana アプリケーションが開きます。
5. Grafana ダッシュボードのサインインアイコンをクリックします。

6. ターミナルで以下のコマンドを実行し、認証情報を確認します。

   <cryostat_name>=$(kubectl get cryostat -o jsonpath='{$.items[0].metadata.name}')
   
   oc get secret $<cryostat_name>-grafana-basic -o jsonpath='{$.data.GF_SECURITY_ADMIN_USER}' | base64 -d
   
   oc get secret $<cryostat_name>-grafana-basic -o jsonpath='{$.data.GF_SECURITY_ADMIN_PASSWORD}' | base64 -d

   また、Red Hat OpenShift の Cryostat details ページにある Grafana Secret カスタムリソース (CR) から認証情報を見つけることもできます。

   図4.2 OpenShift における Cryostat details ページの Grafana Secret CR

   
7. Grafana Web コンソールのログインページに認証情報を入力します。ダッシュボードウィンドウが開き、JFR レコーディングのデータがさまざまな時系列プロットで表示されます。

8. オプション: プロットの時系列セグメントを選択して、プロットを操作します。画面上のデータが拡大され、その期間のデータのみが表示されます。

   図4.3 プロットグラフありの Grafana ダッシュボード例