4.3. JFR レコーディングのラベル
Cryostat 2.4 で JDK Flight Recorder (JFR) レコーディングを作成する場合、一連のキーと値のラベルのペアを指定することで、記録にメタデータを追加できます。
さらに、ターゲット JVM 内にある JFR レコーディングにカスタムラベルを割り当てることができるため、JFR レコーディングを簡単に識別してより適切に管理できます。
一般的なレコーディングラベルの使用例を以下に示します。
- JFR レコーディングにメタデータを割り当てる。
- 同一のラベルを含むレコーディングに対してバッチ操作を実行する。
- レコーディングに対してクエリーを実行するときにラベルを使用する。
Cryostat を使用すると、コンテナー化されたアプリケーションで JVM のパフォーマンスを監視する JFR レコーディングを作成できます。さらに、アクティブな JFR レコーディングのスナップショットを作成して、ターゲット JVM アプリケーションの特定の時点までの収集データをキャプチャーできます。
4.3.1. JFR レコーディングへのラベルの追加 リンクのコピーリンクがクリップボードにコピーされました!
Cryostat 2.4 で JFR レコーディングを作成する場合、ラベルを使用して、キーと値のラベルペアを含むメタデータをレコーディングに追加できます。
Cryostat は、作成された JFR レコーディングにデフォルトのレコーディングラベルを適用します。これらのデフォルトラベルは、Cryostat が JFR レコーディングの作成に使用したイベントテンプレートに関する情報を取得します。
カスタムラベルを JFR レコーディングに追加すると、特定の JFR レコーディングを識別したり、同じラベルが適用されたレコーディングでバッチ操作を実行したりするなど、ニーズを満たす特定のクエリーを実行できます。
前提条件
- Cryostat Web コンソールにログインしている。
- Cryostat インスタンスのターゲット JVM を作成または選択している。
手順
- Cryostat Web コンソールから、Recordings をクリックします。
- Active Recordings タブで、Create をクリックします。
Custom Flight Recording タブで、Show metadata options を展開します。
注記Custom Flight Recording タブでは、アスタリスクが付いている必須フィールドに入力する必要があります。
Add label をクリックします。
図4.10 Custom Flight Recording タブに表示される Add Label ボタン
- 表示された Key フィールドと Value フィールドに値を入力します。たとえば、レコーディングに関する問題を報告する場合は、Key フィールドに理由を入力し、Value フィールドに問題の種類を入力できます。
Create をクリックして、JFR レコーディングを作成します。レコーディングは、指定されたレコーディングラベルおよびカスタムラベルとともに Active Recordings タブに表示されます。
ヒントArchives メニューから、アーカイブされた JFR レコーディングにアクセスできます。Cryostat アーカイブの場所への JFR レコーディングのアップロード (Cryostat を使用した JFR レコーディングの管理) を参照してください。
例
次の例は、2 つのデフォルトのレコーディングラベル template.name: Profiling および template.type: TARGET と、1 つのカスタムラベル reason:service-outage を示しています。
図4.11 定義済みのレコーディングラベルとカスタムラベルを使用したアクティブなレコーディングの例
4.3.2. JFR レコーディングのラベルの編集 リンクのコピーリンクがクリップボードにコピーされました!
Cryostat Web コンソールで、Recordings メニューに移動して、JFR レコーディングのラベルとそのメタデータを編集できます。アーカイブにアップロードした JFR レコーディングのラベルとメタデータを編集することもできます。
前提条件
- Cryostat Web コンソールにログインしている。
- JFR レコーディングを作成し、このレコーディングにラベルを添付する。
手順
- Cryostat Web コンソールで、Recording メニューをクリックします。
- Active Recordings タブから、JFR レコーディングを見つけて、その横にあるチェックボックスを選択します。
Edit Labels をクリックします。Cryostat Web コンソールで Edit Recording Label ペインが開きます。このペインを使用して、JFR レコーディングのラベルを追加、編集、または削除できます。
ヒント各レコーディングの横にあるチェックボックスを選択すると、複数の JFR レコーディングを選択できます。同じラベルを含むレコーディングを一括編集する場合、または複数のレコーディングに新しい同一のラベルを追加する場合は、Edit Labels ボタンをクリックします。
オプション: Edit Recording Labels ウィンドウから、次のいずれかのアクションを実行できます。
- Add をクリックして、ラベルを作成します。
-
ラベルの横にある
Xをクリックして、ラベルを削除します。 - フィールドの内容を変更して、ラベルを編集します。内容を編集すると、編集したことを示す緑色のチェックマークがフィールドに表示されます。
- Save をクリックします。
オプション: 次の手順を実行して、JFR レコーディングをそのラベルとともにアーカイブできます。
- レコーディングの名前の横にあるチェックボックスを選択します。
Archive ボタンをクリックします。レコーディングは Archived Recordings タブで見つけることができます。
レコーディングをラベル付きでアーカイブすると、後でレコーディングを見つける場合に検索機能を強化できます。Cryostat アーカイブにアップロードした任意のレコーディングにラベルを追加することもできます。
注記Cryostat は、アーカイブされたレコーディングの存続期間中、レコーディングのラベルを保持します。
検証
- Active Recordings タブで、レコーディングの Labels セクションに変更内容が表示されていることを確認します。
改訂日時: 2024-03-06