通用的底層埋點都是怎麼做的？

猿天地發表於2020-10-21

想要在程式裡監控資料庫的操作耗時，想要在底層框架中自動傳遞鏈路跟蹤資訊，這些需求經常會碰到，特別是在構建基礎框架的時候。

核心目標只有一個，那就是在底層封裝好，不用上層使用人員關心。今天跟大家聊聊常用的底層擴充套件埋點方式是怎麼處理的。

框架自帶擴充套件點

如果你使用的框架在設計的時候，就預留了擴充套件點就很方便了。比如 Mybatis 的攔截器，我們可以在攔截器中對 Sql 進行監控，改寫。

比如阿里的 Sentinel 框架，可以通過 SPI 來擴充套件 Slot，調整編排順序，新增自定義的 Slot 來實現限流告警等。

開源框架的質量參差不齊，有在早期設計比較好的，留足了各種擴充套件點，方便使用者。也有一些沒有考慮那麼全面，導致你在使用的時候需要進行擴充套件，發現找不到擴充套件點，對於框架本身沒有提供擴充套件點的場景，請接著看下面。

修改原始碼

如果框架沒有擴充套件點，最直接的方式就是修改開源框架的原始碼來擴充套件自己想要的功能，通常的做法就是克隆原始碼到自己的私有倉庫中，然後修改，測試，重新打包使用。

像我們之前用了 XXL-JOB 做任務排程，也是修改了某些程式碼，在介面上擴充套件了監控通知的配置資訊，預設是隻支援郵箱，可以擴充套件出手機，釘釘等。

修改原始碼不好的點在於需要跟原框架的版本進行對齊，如果不對齊，隨便改都沒事。不對齊意味著修復了某些 bug 和新增了某些功能，就無法使用了。要對齊，就需要不斷的將新版本的程式碼合併到你自己的分支上。

還有很多公司，就是基於開源的版本，構建了公司內部自己的版本，後續直接就是跟著內部的使用需求去擴充套件和維護了，不會跟社群的版本進行同步，如果你們有專門的團隊去做這件事情，也是一種方式。

同名檔案覆蓋

改原始碼的方式需要經常同步新版本的程式碼，有的時候往往只想修改某一個類而已，比如對底層的某些操作進行埋點監控，如果框架本身沒有提供擴充套件點的話只能改原始碼來實現。

其實還有個投機取巧的方式，就是在專案中建立一個跟你要修改的一模一樣的類，包名+類目都一樣，方法名也一樣，方法的實現你可以改。這樣就能覆蓋 jar 包中的類了，還是跟類載入順序有關係，先載入你自己定義的。

這樣的方式好處在於不用經常去同步新版本的程式碼，如果你用的框架版本升級了，只要包名和類名不變，你這個覆蓋的只是那個類而已，新增的功能和修復的 bug 都不會有影響。

切面攔截

切面在做很多統一處理的時候非常有用，同樣在做底層埋點的場景也適用。

比如我們要對專案中 Mongodb 的所有操作都進行埋點監控，可以修改 MongoDB 的驅動原始碼，可以建立同名檔案進行覆蓋，方式有很多種，找到一個合適，又能實現需求的最重要。

以 Spring 中操作 Mongodb 來說明，在 Spring Data Mongodb 中會 MongoTemplate 來操作 Mongodb。最簡單的方式就是直接對 MongoTemplate 類進行埋點，這樣所有的操作都可以監控起來。

用切面直接切到 MongoTemplate 的所有方法上，然後進行埋點，就很簡單了。

@Aspect
public class MongoTemplateAspect {
    @Pointcut("execution(* org.springframework.data.mongodb.core.MongoTemplate.*(..))")
    public void pointcut() {}
    @Around("pointcut()")
    public Object around(final ProceedingJoinPoint pjp) throws Throwable {
        String callMethod = pjp.getSignature().getDeclaringType().getSimpleName() + "." + pjp.getSignature().getName();
        Map<String, Object> data = new HashMap<>();
        data.put("params", JsonUtils.toJson(pjp.getArgs()));
        return CatTransactionManager.newTransaction(() -> {
            try {
                return pjp.proceed();
            } catch (Throwable throwable) {
                throw new RuntimeException(throwable);
            }
        }, "Mongo", callMethod, data);
    }
}

又比如，你還想監控 Redis 相關的，Redis 用的也是跟 Spring 整合的框架，那麼也有 RedisTemplate 這個類，同樣也可以用切面來實現。

基於 Template 類來埋點，相對比較上層，如果還想在底層一點進行監控，也就是 Connection 這層，Template 裡面的操作都是基於 Connection 來實現的。

同樣我們可以用切面來替換 Connection 相關的實現，比如可以用切面切到獲取 Connection 的方法，然後替換 Connection 的物件為具備埋點監控的物件。

@Aspect
public class RedisAspect {
    @Pointcut("target(org.springframework.data.redis.connection.RedisConnectionFactory)")
    public void connectionFactory() {}
    @Pointcut("execution(org.springframework.data.redis.connection.RedisConnection *.getConnection(..))")
    public void getConnection() {}
    @Pointcut("execution(org.springframework.data.redis.connection.RedisClusterConnection *.getClusterConnection(..))")
    public void getClusterConnection() {}
    @Around("getConnection() && connectionFactory()")
    public Object aroundGetConnection(final ProceedingJoinPoint pjp) throws Throwable {
        RedisConnection connection = (RedisConnection) pjp.proceed();
        return new CatMonitorRedisConnection(connection);
    }
    @Around("getClusterConnection() && connectionFactory()")
    public Object aroundGetClusterConnection(final ProceedingJoinPoint pjp) throws Throwable {
        RedisClusterConnection clusterConnection = (RedisClusterConnection) pjp.proceed();
        return new CatMonitorRedisClusterConnection(clusterConnection);
    }
}

CatMonitorRedisConnection 中對原生的 RedisConnection 做了增強，也不會影響原有的 RedisConnection 的功能。

public class CatMonitorRedisConnection implements RedisConnection {
    private final RedisConnection connection;
    private CatMonitorHelper catMonitorHelper;
    public CatMonitorRedisConnection(RedisConnection connection) {
        this.connection = connection;
        this.catMonitorHelper = new CatMonitorHelper();
    }

    @Override
    public byte[] get(byte[] key) {
        return catMonitorHelper.execute(RedisCommand.GET, key, () -> connection.get(key));
    }
}

Java Agent

Java Agent 可以在執行期將已經載入的類的位元組碼進行變更，可以加入我們需要進行監控的程式碼邏輯。無需對原有程式碼進行改造，零侵入性。

在非常多優秀的開源框架中都看到了 Java Agent 的應用，像 APM 框架 SkyWalking，非同步傳遞上下文 transmittable-thread-local 等。

Java Agent 相對其他的方式來說，還是有一定的門檻，畢竟不是日常開發中經常會用到的技術點。如果想了解這種擴充套件方式，可以看看一些已經用了的開源框架的原始碼，就知道大概怎麼使用了。下面貼一段 transmittable-thread-local 中對執行緒池進行擴充套件的程式碼吧，主要就是利用了 javassist 操作位元組碼。

try {
final CtMethod afterExecute = clazz.getDeclaredMethod("afterExecute", new CtClass[]{runnableClass, throwableClass});
// unwrap runnable if IsAutoWrapper
String code = "$1 = com.alibaba.ttl.threadpool.agent.internal.transformlet.impl.Utils.unwrapIfIsAutoWrapper($1);";
logger.info("insert code before method " + signatureOfMethod(afterExecute) + " of class " + afterExecute.getDeclaringClass().getName() + ": " + code);
afterExecute.insertBefore(code);
modified = true;
} catch (NotFoundException e) {
// clazz does not override afterExecute method, do nothing.
}

關於作者：尹吉歡，簡單的技術愛好者，《Spring Cloud 微服務-全棧技術與案例解析》, 《Spring Cloud 微服務 入門 實戰與進階》作者, 公眾號猿天地發起人。

我整理了一份很全的學習資料，感興趣的可以微信搜尋「猿天地」，回覆關鍵字 「學習資料」獲取我整理好了的 Spring Cloud，Spring Cloud Alibaba，Sharding-JDBC 分庫分表，任務排程框架 XXL-JOB，MongoDB，爬蟲等相關資料。

相關文章