第3章 イベントテンプレート
Cryostat には、デフォルトのイベントテンプレートが含まれています。これを使用すると、ターゲット JVM のパフォーマンスをモニターするための JFR レコーディングをすばやく作成できます。
3.1. カスタムイベントテンプレートの使用
JDK Flight Recorder (JFR) レコーディングの作成時に、以下のいずれかのデフォルトイベントテンプレートを選択できます。
- 一定期間、または明示的に停止されるまで、ターゲット Java 仮想マシン (JVM) の基本的なデータを収集する継続テンプレート。
- 一定期間、または明示的に停止されるまで、ターゲット Java 仮想マシン (JVM) の詳細なデータを収集するプロファイリングテンプレート。
どちらかのデフォルトイベントテンプレートを使用して、ターゲット JVM のパフォーマンスをモニターするための JFR レコーディングを迅速に作成できます。どちらのイベントテンプレートも、必要に応じて後で編集できます。たとえば、デフォルトイベントテンプレートにはアプリケーション固有のカスタムイベントが含まれないため、これらのカスタムイベントをカスタムテンプレートに追加する必要があります。
Cryostat は ALL
meta-template もサポートします。これを使用すると、JFR はターゲット JVM のすべてのイベントタイプをモニターできます。各イベントタイプにはデフォルト値があります。ALL
meta-template には XML 定義が含まれないため、ALL
meta-template の XML ファイルをダウンロードすることはできません。
前提条件
- Installed Operators オプションを使用して、Cryostat 3.0 を Red Hat OpenShift にインストールした。
- Red Hat OpenShift プロジェクトに Cryostat インスタンスを作成した。
手順
- Cryostat インスタンスの Dashboard パネルで、ドロップダウンリストから Target JVM を選択します。
オプション: Topology パネルで、Add to view アイコンを選択してターゲット JVM を定義できます。アイコンを選択すると、カスタムターゲット接続 URL を定義するためのウィンドウが開きます。
- Connection URL フィールドに、JVM の Java Management Extension (JMX) エンドポイントの URL を入力します。
- オプション: Alias フィールドに、JMX Service URL のエイリアスを入力します。
Create をクリックします。
図3.1 Create Target ダイアログボックス
Cryostat Web コンソールのナビゲーションメニューから、Events をクリックします。Web コンソールで Authentication Required ダイアログが開く場合があります。プロンプトが表示されたら、Authentication Required ダイアログボックスに Username と Password を入力し、Save をクリックしてターゲット JVM に認証情報を提供します。
注記選択したターゲット JMX で、JMX 接続に対して SSL 証明書が有効な場合は、プロンプトが表示されたら証明書を追加する必要があります。
Cryostat は、ターゲット JVM アプリケーションの認証情報を暗号化し、Red Hat OpenShift の永続ボリューム要求 (PVC) に格納されているデータベースに保存できます。
- Event Templates タブで、リストされたイベントテンプレートを見つけ、その他のオプションメニューを選択します。
その他のオプションメニューから、Download をクリックします。オペレーティングシステムの設定に応じて、ファイル保存ダイアログが開きます。ファイルを任意の場所に保存します。
図3.2 イベントテンプレートのその他のオプションメニューの例
デフォルトのファイルエディターでファイルを開き、必要に応じてファイルを編集します。設定の変更を保持するには、ファイルを保存する必要があります。
注記後の段階でファイルの特定に役立つ
description
およびprovider
属性に値を追加できます。Events メニューから Event Templates タブに移動し、Upload アイコンをクリックします。Cryostat Web コンソールで Create Custom Event Template 開きます。
図3.3 Create Custom Event Template ウィンドウ
- Upload をクリックし、デフォルトのファイルエディターを使用して、1 つ以上の設定済みイベントテンプレートファイルを Cryostat Web コンソールにアップロードします。ファイルを Template XML ウィンドウにドラッグアンドドロップすることもできます。
- Submit ボタンをクリックします。Cryostat Web コンソールで Event Templates タブが開き、カスタムイベントテンプレートが表示されます。
オプション: イベントテンプレートを作成すると、次のいずれかのオプションを選択し、テンプレートを使用して JFR レコーディングを作成できます。
- Automated Rules メニューから Create をクリックし、Template リストからイベントテンプレートを選択します。
- Events メニューから、リストされたイベントテンプレートを見つけ、その他のオプションメニューから Create Recording を選択します。
- Recordings メニューの Active Recordings タブで、Create をクリックします。