帮助手册

使用 Java 注解进行自定义插桩

通过 Java 注解,APM Insight 提供了一种更便捷的方式来对应用程序的类和方法进行自定义插桩。使用 Java 注解可以为事务定义自定义名称,并指定自定义组件。

说明

此功能从代理版本 2.2 起可用。

Java 代理的配置步骤

  1. 作为前提条件,需要从您的 Site24x7 账户下载 apminsight-javaagent.zip,其中包含代理 jar 及其关联文件,以及 apminsight-javaagent-api.jar
  2. apminsight-javaagent-api.jar 文件添加到项目的构建路径中,并确保该文件与应用程序的其他库一起导出。
  3. Java 代理 API 库提供了两个注解,可在应用程序中用于追踪自定义类和方法的性能。
  • @ApmTracker:可用于任意类和方法,被标注的类和方法将被插桩并包含在追踪记录中。
  • @ApmRootTracker: 只能用于方法,适用于可能作为事务(后台)入口点的方法。

@ApmTracker

属性:

  • component - 可选属性

为被注解的类/方法定义自定义组件。

  • name - 可选属性

被注解元素的自定义名称,该名称将被添加到实际方法名称的前面。
可通过使用以 '$' 为前缀的参数索引(从 1 开始)将方法参数用于自定义名称。 

 

 

已插桩的方法及其自定义名称可在追踪记录(Traces)中查看。

 

 

@ApmRootTracker

属性

  • component - 可选属性

为被注解的方法定义自定义组件。

  • name - 可选属性

被注解元素的自定义名称,该名称将被添加到实际方法名称的前面。
可通过使用以 '$' 为前缀的参数索引(从 1 开始)将方法参数用于自定义名称。

  • txnName - 必填

定义后台事务的名称,仅当该方法是事务的入口点时有效;否则将被作为通用方法追踪并添加到追踪记录中。

 

 

事务的命名将根据属性 txnName 指定的值确定。

 

 

 

 

本文档对您有帮助吗?

您愿意帮助我们改进文档吗?请告诉我们哪些方面可以做得更好。


很抱歉本文档未能让您满意。我们希望了解可以从哪些方面改进您的体验。


感谢您抽出时间分享反馈。我们将利用您的反馈来改进在线帮助资源。

短链接已复制!