3.4. 定义和使用自定义事件 API

流程

1. 在自定义事件类型中，在 Event 类中，使用 @name 注释来命名自定义事件。此名称显示在 JMC 图形用户界面(GUI)中。

   在 Event 类中定义自定义事件类型名称的示例

   @Name(“SampleCustomEvent”)
   public class SampleCustomEvent extends Event {...}

   Copy to Clipboard Toggle word wrap

2. 定义 Event 类及其属性的元数据，如 name、category 和 labels。标签显示客户端的事件类型，如 JMC。

   注意

   大型记录文件可能会导致性能问题，这可能会影响您与文件交互的方式。确保正确定义您需要的事件记录注解数量。定义不必要的注解可能会增加您的记录文件的大小。

   为示例 事件类定义注解示例

   @Name(“SampleCustomEvent”)  

   1

   
   @Label("Sample Custom Event")
   @Category("Sample events")
   @Description("Custom Event to demonstrate the Custom Events API")
   @StackTrace(false) 

   2

   
   public class SampleCustomEvent extends Event {
   
   
       @Label("Method") 

   3

   
       public String method;
   
   
       @Label("Generated Number")
       public int number;
   
   
       @Label("Size")
       @DataAmount 

   4

   
       public int size;
   }

   Copy to Clipboard Toggle word wrap

   1

   详情注解，如 @Name，用于定义 JMC GUI 上如何显示自定义事件的元数据。

   2

   @StackTrace 注释会增加 flight 记录的大小。默认情况下，JFR 不包含为事件创建的位置的 stackTrace。

   3

   @Label 注释定义各个方法的参数，如 HTTP 请求的资源方法。

   4

   @DataAmount 注释包含一个属性，它以字节为单位定义数据量。JMC 会自动以其他单位呈现数据量，如 MB (MB)。

3. 在 事件 类中定义上下文信息。此信息设置自定义事件类型的请求处理行为，以便您可以配置事件类型以收集特定的 JFR 数据。

   定义简单 主 类和事件循环的示例

   public class Main {
   
   	private static int requestsSent;
   
   	public static void main(String[] args) {
       	// Register the custom event
       	FlightRecorder.register(SampleCustomEvent.class);
       	// Do some work to generate the events
       	while (requestsSent <= 1000) {
           	try {
               	eventLoopBody();
               	Thread.sleep(100);
           	} catch (Exception e) {
               	e.printStackTrace();
           	}
       	}
       }
   
   	private static void eventLoopBody() {
       	// Create and begin the event
       	SampleCustomEvent event = new SampleCustomEvent();
       	event.begin();
       	// Generate some data for the event
       	Random r = new Random();
       	int someData = r.nextInt(1000000);
       	// Set the event fields
       	event.method = "eventLoopBody";
       	event.number = someData;
       	event.size = 4;
       	// End the event
       	event.end();
       	event.commit();
       	requestsSent++;
       }

   Copy to Clipboard Toggle word wrap

   在前面的示例中，简单 主 类注册事件，事件循环会填充事件字段，然后发出自定义事件。

4. 在您选择的应用程序中检查事件类型，如 JMC 或 JFR 工具。

   图 3.2. 检查 JMC 中的事件类型示例

   

   View larger image

   

   JFR 记录可以包括不同的事件类型。您可以检查应用程序中的每个事件类型。