首頁 > 軟體

基於Java Agent的premain方式實現方法耗時監控問題

2022-10-22 14:00:21

Java Agent是依附於java應用程式並能對其位元組碼做相關更改的一項技術,它也是一個Jar包,但並不能獨立執行,有點像寄生蟲的感覺。當今的許多開源工具尤其是監控和診斷工具,很多都是基於Java Agent來實現的,如最近阿里剛開源的Arthas。一個Java Agent既可以在程式執行前載入(premain方式), 又可以在程式執行後載入(attach方式)。本文通過實現一個對Java方法耗時監控的Agent來讓大家瞭解一下Java Agent的premain方式具體應用。

首先給出測試類,如下所示,該類的程式碼很簡單,最終要達到的目的就是在不修改這段程式碼的情況下,能夠知道執行這段程式時每個方法的具體耗時,也就是實現一個Java方法耗時監控的Agent。

MyAgentTest.java

public class MyAgentTest {
    public static void main(String[] args) throws InterruptedException {
        MyAgentTest mat = new MyAgentTest();
        mat.test();
        Thread.sleep((long)(Math.random() * 10));//隨機暫停0-10ms
    }

    public void test() throws InterruptedException {
        System.out.println("I'm TestAgent");
        Thread.sleep((long)(Math.random() * 100));//隨機暫停0-100ms
    }
}

接下來就是要建立一個名為myagent的工程,專案結構如下:

myagent
├── pom.xml
├── src
│   └── main
│       ├── java
│       │   └── test
│       │       ├── MyAgent.java
│       │       └── MyTransformer.java
│       └── resources
│           └── META-INF
│               └── MANIFEST.MF

從上面可以看到,專案中主要檔案只有兩個java類和一個MANIFEST.MF,所以Java Agent其實也並沒有那麼神祕。

先看看pom.xml這個檔案,因為位元組碼的相關操作要依賴於javassist這個包,所以要新增相關依賴。在預設情況下,用maven進行打包時會覆蓋掉我們自己的MANIFEST.MF,以及不會引進依賴的jar包,所以在build中要引進maven-assembly-plugin外掛並新增相關設定。

pom.xml

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>com.hebh.me</groupId>
  <artifactId>demo-myagent</artifactId>
  <version>1.0-SNAPSHOT</version>
  <packaging>jar</packaging>

  <name>demo-myagent Maven Webapp</name>
  <url>http://www.example.com</url>

  <dependencies>
    <dependency>
      <groupId>javassist</groupId>
      <artifactId>javassist</artifactId>
      <version>3.12.1.GA</version>
    </dependency>
  </dependencies>

  <build>
    <finalName>myagent</finalName>
    <plugins>
      <plugin>
        <artifactId>maven-assembly-plugin</artifactId>
        <configuration>
          <archive>
            <!--避免MANIFEST.MF被覆蓋-->
            <manifestFile>src/main/resources/META-INF/MANIFEST.MF</manifestFile>
          </archive>
          <descriptorRefs>
            <!--打包時加入依賴-->
            <descriptorRef>jar-with-dependencies</descriptorRef>
          </descriptorRefs>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

接下來就是最重要MyAgent類,而premain(String args, Instrumentation inst)這個方法是關鍵,也是Agent的入口, 在方法裡我們直接列印"Hi, I'm agent!"文字並新增一個自己實現的位元組碼轉換器。

MyAgent.java

package test;

import java.lang.instrument.Instrumentation;
public class MyAgent {
    public static void premain(String args, Instrumentation inst){
        System.out.println("Hi, I'm agent!");
        inst.addTransformer(new MyTransformer());
    }
}

然後看看這個位元組碼轉換器的具體實現,首先是要實現ClassFileTransformer介面,然後實現介面中的transform方法,jdk中原始碼對該介面的說明如下

An agent provides an implementation of this interface in order to transform class files. The transformation occurs before the class is defined by the JVM

翻譯過來也就是我們可以通過實現該介面來在虛擬機器器載入類之前對位元組碼進行相關更改。

對於該方法的說明文字比較多,在這裡我們只需要知道該方法傳入類的所有相關資訊,然後返回一個修改後的類的位元組碼。要達到對方法耗時的監控最核心的程式碼在在這個方法裡面,如下,首先過濾我們不關注的類,複製關注類的原方法並在執行之前獲取時間戳,執行後再次獲取時間戳,兩者取差值即為方法耗時,為一直觀顯示我們直接新增相關列印程式碼。

MyTransformer.java

package test;

import java.lang.instrument.ClassFileTransformer;
import java.security.ProtectionDomain;

import javassist.ClassPool;
import javassist.CtClass;
import javassist.CtMethod;
import javassist.CtNewMethod;

/**
 * 檢測方法的執行時間
 */
public class MyTransformer implements ClassFileTransformer {

    final static String prefix = "nlong startTime = System.currentTimeMillis();n";
    final static String postfix = "nlong endTime = System.currentTimeMillis();n";

    @Override
    public byte[] transform(ClassLoader loader, String className, Class<?> classBeingRedefined,
                            ProtectionDomain protectionDomain, byte[] classfileBuffer){
        //java自帶的方法不進行處理
        if(className.startsWith("java") || className.startsWith("sun")){
            return null;
        }
        className = className.replace("/", ".");
        CtClass ctclass = null;
        try {
            ctclass = ClassPool.getDefault().get(className);// 使用全稱,用於取得位元組碼類<使用javassist>
            for(CtMethod ctMethod : ctclass.getDeclaredMethods()){
                String methodName = ctMethod.getName();
                String newMethodName = methodName + "$old";// 新定義一個方法叫做比如sayHello$old
                ctMethod.setName(newMethodName);// 將原來的方法名字修改

                // 建立新的方法,複製原來的方法,名字為原來的名字
                CtMethod newMethod = CtNewMethod.copy(ctMethod, methodName, ctclass, null);

                // 構建新的方法體
                StringBuilder bodyStr = new StringBuilder();
                bodyStr.append("{");
                bodyStr.append("System.out.println("==============Enter Method: " + className + "." + methodName + " ==============");");
                bodyStr.append(prefix);
                bodyStr.append(newMethodName + "($$);n");// 呼叫原有程式碼,類似於method();($$)表示所有的引數
                bodyStr.append(postfix);
                bodyStr.append("System.out.println("==============Exit Method: " + className + "." + methodName + " Cost:" +(endTime - startTime) +"ms " + "===");");
                bodyStr.append("}");

                newMethod.setBody(bodyStr.toString());// 替換新方法
                ctclass.addMethod(newMethod);// 增加新方法
            }
            return ctclass.toBytecode();
        } catch (Exception e) {
            e.printStackTrace();
        }
        return null;
    }
}

最後也是非常重要並且容易出錯的地方就是在resources資料夾下面建立META-INF資料夾,然後定義MANIFEST.MF檔案,通過Premain-Class屬性來指定Agent的入口,需要注意的是冒號後面必須要有一個空格,並且最後要空出一行。

MANIFEST.MF

Manifest-Version: 1.0
Created-By: 0.0.1 (Demo Inc.)
Premain-Class: test.MyAgent

到此為止我們就已經完成了myagent工程的所有程式碼,為了使用它就必須將其打包為jar檔案,用如下命令:

mvn assembly:assembly

執行mvn命令後就可以在專案的target目錄下看到生成的myagent-jar-with-dependencies.jar檔案。

然後編譯在最開始用來測試的類:

javac MyAgentTest.java

編譯後就生成了.class檔案,為了方便,我們把.class檔案放到和myagent-jar-with-dependencies.jar同一個目錄。

如果不使用我們的agent直接執行java命令,效果如下:

如果在javaagent引數中加上agent,效果如下:

首先在執行所有方法前,會執行MyAgent的premain方法。並且可以直觀看到,MyAgentTest在執行時首先是進入main方法,然後再是test方法,執行完test方法邏輯後退出test方法,最後退出main方法,不僅能看到每個方法的最終耗時也能看到方法執行的軌跡。

到此這篇關於基於Java Agent的premain方式實現方法耗時監控的文章就介紹到這了,更多相關Java Agent方法耗時監控內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com!


IT145.com E-mail:sddin#qq.com