第 3 章 JMC 代理插件

流程

1. 从 Cryostat Web 控制台，进入 Events 菜单。如果 JMC Agent 成功添加到 Cryostat 实例中，则在 Event Templates 窗格下打开一个 Probe Templates 窗格。

   图 3.1. Cryostat web 控制台中的探测模板标签页

   
   注意

   在 web 控制台中可能会打开一个身份验证所需的 对话框。若有提示，在 Authentication Required 对话框中输入您的 Username 和 Password，然后单击 Save 将您的 JMX 凭证提供给目标 JVM。

2. 使用您的首选文本编辑器创建 XML 配置文件。使用 JFR 事件信息填充该文件，如在应用上必须执行哪些事件 Cryostat。

   以下示例显示了包含 JFR 事件信息的自定义探测模板 XML 文件。将文件上传到 Cryostat 时，Cryostat 可以向应用程序添加名为 Cryostat Agent Plugin Demo Event 的自定义 JFR 事件。当调用 JMC Agent 的 retrieveEventProbes 方法时，Cryostat 会启动 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。Create Custom Probe Template 在 Cryostat web 控制台中打开。

   图 3.2. Cryostat Web 控制台中的 Create Custom Probe Template 窗口

   
   提示

   如果要从此模板 XML 字段删除上传的文件，请单击 Clear 按钮。

4. 点 Browse 按钮找到您的 XML 文件。
5. 上传文件后，单击 Submit。自定义探测模板文件会在 Probe Templates 表中打开。
6. 点探测模板旁的 overflow 菜单。
7. 点 Insert Probes。探测器显示在探测 模板 选项卡下的表中，以及 Live Configuration 选项卡下的表。
8. 可选： 使用 Live Configuration 选项卡，您可以在其中查看每个活跃探测的名称、类 等信息。
9. 可选： 在 Live Configuration 选项卡中，您可以点击 Remove All Probes 删除表中列出的探测。

验证

1. 在 Events 菜单中点 Event Types 选项卡。
2. 检查您的 XML 配置中的命名 JFR 事件是否在表中列出。对于此流程中使用的示例，表格中会显示 Cryostat Agent Plugin Demo Event。