第3章 JMC Agent プラグイン

手順

1. Cryostat Web コンソールから、Events メニューに移動します。JMC Agent が Cryostat インスタンスに正常に追加された場合は、Event Templates ペインの下に Probe Templates ペインが開きます。

   図3.1 Cryostat Web コンソールのプローブテンプレートタブ

   
   注記

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

2. 希望するテキストエディターを使用して XML 設定ファイルを作成します。Cryostat がアプリケーションで実行するイベントなどの JFR イベント情報でファイルを設定します。

   以下の例は、JFR イベント情報を含むカスタムプローブテンプレート XML ファイルを示しています。このファイルを Cryostat にアップロードすると、Cryostat は Cryostat Agent Plugin Demo Event と呼ばれるカスタム JFR イベントをアプリケーションに追加できます。Cryostat は、JMC Agent の retrieveEventProbes メソッドが呼び出されると JFR イベントを開始します。

   <jfragent>
       <!-- Global configuration options -->
       <config>
      	 <classprefix>__JFREvent</classprefix>
      	 <allowtostring>true</allowtostring>\
      	 <allowconverter>true</allowconverter>
       </config>
      	 <events>
      		 <event id="cryostat.demo.jfr.event9">
          		 <label>Cryostat Agent Plugin Demo Event</label>
          		 <description>Event for the agent plugin demo</description>
          		 <path>io/cryostat/demo/events</path>
          		 <stacktrace>true</stacktrace>
          		 <class>io.cryostat.core.agent.AgentJMXHelper</class>
          		 <method>
              		 <name>retrieveEventProbes</name>
      		 <descriptor>()Ljava/lang/String;</descriptor>
          		 </method>
           	<location>WRAP</location>
       	</event>
   	</events>
   </jfragent>

3. Upload ボタンをクリックして、カスタムイベントテンプレートを Cryostat に追加します。Cryostat Web コンソールで Create Custom Probe Template が開きます。

   図3.2 Cryostat Web コンソールの Create Custom Probe Template ウィンドウ

   
   ヒント

   アップロードしたファイルをこの Template XML フィールドから削除する場合は、Clear ボタンをクリックします。

4. Browse ボタンをクリックして XML ファイルを見つけます。
5. ファイルをアップロードしたら、Submit をクリックします。カスタムプローブテンプレートファイルが Probe Templates テーブルで開きます。
6. プローブテンプレートの横にあるオーバーフローメニューをクリックします。
7. Insert Probes をクリックします。プローブは Probe Templates タブの下に表示され、Live Configuration タブの下のテーブルに表示されます。
8. オプション: Live Configuration タブに移動し、アクティブなプローブごとに、Name、Class などの情報を表示できます。
9. オプション： Live Configuration タブから、Remove All Probes をクリックして、表に記載されているプローブを削除できます。

検証

1. Events メニューから、Event Types タブをクリックします。
2. XML 設定の名前付き JFR イベントがテーブルに一覧表示されていることを確認します。この手順で使用されている例では、Cryostat Agent Plugin Demo Event が表に表示されます。