首页
/ Hyperf链路追踪中实现请求过滤的技术方案

Hyperf链路追踪中实现请求过滤的技术方案

2025-06-02 10:17:39作者:秋泉律Samson

概述

在分布式系统开发中,链路追踪是监控和诊断系统性能问题的重要工具。Hyperf框架内置了基于Zipkin的链路追踪功能,但在实际应用中,我们经常需要对某些特定的请求进行过滤,避免不必要的追踪数据干扰分析结果。本文将详细介绍在Hyperf框架中如何实现链路追踪的请求过滤功能。

为什么需要过滤特定请求

在Web应用中,存在一些对系统分析无意义的请求,例如:

  • 浏览器自动请求的favicon.ico图标文件
  • 健康检查接口
  • 静态资源请求
  • 某些高频但业务价值低的API调用

这些请求如果全部记录到链路追踪系统中,不仅会增加存储负担,还会干扰我们对关键业务路径的分析。因此,实现请求过滤功能是优化链路追踪系统的必要手段。

Hyperf中的采样器机制

Hyperf的链路追踪系统基于OpenTracing标准实现,支持通过采样器(Sampler)来控制哪些请求需要被追踪。采样器是实现Zipkin\Sampler接口的类,它决定了是否对当前请求进行采样记录。

框架默认提供了几种采样器:

  • AlwaysSampleSampler:总是采样
  • NeverSampleSampler:从不采样
  • PercentageSampler:按百分比采样

自定义采样器实现请求过滤

要实现基于请求特征的过滤,我们需要创建自定义采样器。以下是实现步骤:

1. 创建自定义采样器类

<?php

namespace App\Tracer\Sampler;

use Hyperf\Context\Context;
use Hyperf\HttpServer\Router\Dispatched;
use Zipkin\Sampler;

class CustomSampler implements Sampler
{
    public function isSampled($traceId): bool
    {
        // 获取当前请求的路径信息
        $dispatched = Context::get(Dispatched::class);
        $path = $dispatched->handler->route ?? '';
        
        // 定义需要过滤的路径
        $excludedPaths = [
            '/favicon.ico',
            '/health',
            // 添加其他需要过滤的路径
        ];
        
        // 如果请求路径在排除列表中,则不采样
        if (in_array($path, $excludedPaths)) {
            return false;
        }
        
        // 默认采样
        return true;
    }
}

2. 配置自定义采样器

在Hyperf的配置文件中启用自定义采样器:

// config/autoload/opentracing.php

return [
    'default' => env('OPENTRACING_DRIVER', 'zipkin'),
    'enable' => [
        'guzzle' => env('OPENTRACING_ENABLE_GUZZLE', false),
        'redis' => env('OPENTRACING_ENABLE_REDIS', false),
        'db' => env('OPENTRACING_ENABLE_DB', false),
        'method' => env('OPENTRACING_ENABLE_METHOD', false),
    ],
    'zipkin' => [
        'app' => [
            'name' => env('APP_NAME', 'skeleton'),
            // IPv4 or IPv6 hostname or IP address
            'ipv4' => '127.0.0.1',
            'ipv6' => null,
            'port' => 9501,
        ],
        'options' => [
            'endpoint_url' => env('ZIPKIN_ENDPOINT_URL', 'http://localhost:9411/api/v2/spans'),
            'timeout' => env('ZIPKIN_TIMEOUT', 1),
        ],
        'sampler' => \App\Tracer\Sampler\CustomSampler::class,
    ],
];

高级过滤策略

除了简单的路径匹配外,我们还可以实现更复杂的过滤逻辑:

1. 基于请求方法的过滤

public function isSampled($traceId): bool
{
    $request = Context::get(\Hyperf\HttpMessage\Server\Request::class);
    $method = $request->getMethod();
    
    // 过滤OPTIONS方法请求
    if ($method === 'OPTIONS') {
        return false;
    }
    
    return true;
}

2. 基于用户代理的过滤

public function isSampled($traceId): bool
{
    $request = Context::get(\Hyperf\HttpMessage\Server\Request::class);
    $userAgent = $request->header('user-agent', '');
    
    // 过滤爬虫请求
    if (strpos($userAgent, 'bot') !== false || 
        strpos($userAgent, 'spider') !== false) {
        return false;
    }
    
    return true;
}

3. 组合多种条件的过滤

public function isSampled($traceId): bool
{
    $request = Context::get(\Hyperf\HttpMessage\Server\Request::class);
    $dispatched = Context::get(Dispatched::class);
    
    $path = $dispatched->handler->route ?? '';
    $method = $request->getMethod();
    
    // 定义过滤规则
    $rules = [
        ['path' => '/favicon.ico', 'method' => null], // 所有方法的favicon请求
        ['path' => '/health', 'method' => 'GET'],      // 仅GET方法的健康检查
        ['path' => '/metrics', 'method' => null],      // 所有监控指标请求
    ];
    
    foreach ($rules as $rule) {
        if ($path === $rule['path'] && 
            ($rule['method'] === null || $method === $rule['method'])) {
            return false;
        }
    }
    
    return true;
}

性能考虑

在实现自定义采样器时,需要注意以下几点以保证性能:

  1. 避免复杂计算:采样器的isSampled方法会在每个请求开始时调用,应保持简单高效
  2. 使用缓存:对于频繁匹配的规则,可以考虑使用缓存优化
  3. 减少依赖注入:尽量使用Context获取请求信息,避免依赖注入带来的开销

测试与验证

实现自定义采样器后,需要进行充分测试:

  1. 验证过滤规则是否按预期工作
  2. 检查被过滤的请求确实没有出现在链路追踪系统中
  3. 确认关键业务请求都被正确记录
  4. 监控系统性能,确保采样器没有引入明显延迟

总结

通过自定义采样器实现链路追踪的请求过滤,可以显著提高追踪数据的质量和分析效率。Hyperf框架的OpenTracing集成提供了灵活的扩展点,开发者可以根据实际业务需求实现各种复杂的过滤策略。合理配置请求过滤不仅能减少存储开销,还能让开发者更专注于分析核心业务路径的性能问题。

登录后查看全文
热门项目推荐

热门内容推荐

最新内容推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
139
1.91 K
kernelkernel
deepin linux kernel
C
22
6
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
273
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
923
551
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
421
392
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
74
64
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8