网站首页 > 厂商资讯 > deepflow >

如何设置Skywalking上报请求参数的过滤规则？

随着微服务架构的普及，分布式系统的性能监控和问题排查变得越来越重要。Skywalking 作为一款优秀的开源APM（Application Performance Management）工具，能够帮助我们实时监控应用性能，定位问题。在Skywalking中，我们可以通过设置上报请求参数的过滤规则，对敏感信息进行脱敏处理，确保数据安全。本文将详细介绍如何设置Skywalking上报请求参数的过滤规则。

一、了解Skywalking上报请求参数的过滤规则

Skywalking的上报请求参数过滤规则，主要是指对上报的数据进行脱敏处理，避免敏感信息泄露。在Skywalking中，我们可以通过以下几种方式设置过滤规则：

正则表达式匹配：通过正则表达式匹配敏感信息，并进行脱敏处理。
关键字匹配：通过关键字匹配敏感信息，并进行脱敏处理。
自定义脱敏函数：自定义脱敏函数，对敏感信息进行脱敏处理。

二、设置Skywalking上报请求参数的过滤规则

以下以Skywalking 6.3.0版本为例，介绍如何设置上报请求参数的过滤规则。

配置文件设置

在Skywalking的配置文件agent.config中，添加以下配置：

# 开启参数脱敏功能

sw.permitted-param-filter.enabled=true



# 正则表达式匹配

sw.permitted-param-filter.patterns=^password$,^password_confirmation$,^credit_card_number$



# 关键字匹配

sw.permitted-param-filter.keywords=password,credit_card_number



# 自定义脱敏函数

sw.permitted-param-filter.functions=customDesensitizeFunction

正则表达式匹配

在sw.permitted-param-filter.patterns配置中，通过正则表达式匹配敏感信息。例如，以上配置中，将匹配以password或credit_card_number开头的参数进行脱敏处理。

关键字匹配

在sw.permitted-param-filter.keywords配置中，通过关键字匹配敏感信息。例如，以上配置中，将匹配password和credit_card_number关键字进行脱敏处理。

自定义脱敏函数

在sw.permitted-param-filter.functions配置中，自定义脱敏函数。以下是一个简单的自定义脱敏函数示例：

public class CustomDesensitizeFunction implements IParamFilterFunction {

    @Override

    public String desensitize(String value) {

        // 对敏感信息进行脱敏处理，例如：将电话号码中间四位替换为星号

        return value.replaceAll("(\\d{3})\\d{4}(\\d{4})", "$1$2");

    }

}

三、案例分析

以下是一个使用Skywalking上报请求参数过滤规则的案例：

假设有一个用户登录接口，参数中包含用户名和密码。为了保护用户隐私，我们需要对密码进行脱敏处理。

接口代码

public class LoginController {

    @PostMapping("/login")

    public ResponseEntity login(@RequestParam("username") String username,

                                   @RequestParam("password") String password) {

        // 登录逻辑...

        return ResponseEntity.ok().build();

    }

}

设置过滤规则

在agent.config文件中，添加以下配置：

# 正则表达式匹配

sw.permitted-param-filter.patterns=^password$



# 关键字匹配

sw.permitted-param-filter.keywords=password

结果

当请求登录接口时，Skywalking会自动对密码参数进行脱敏处理，上报的数据如下：

{

    "username": "user123",

    "password": ""

}

通过以上设置，我们成功地对敏感信息进行了脱敏处理，确保了数据安全。

四、总结

在Skywalking中，设置上报请求参数的过滤规则，可以帮助我们保护敏感信息，确保数据安全。通过正则表达式匹配、关键字匹配和自定义脱敏函数，我们可以灵活地设置过滤规则，满足不同的需求。在实际应用中，合理配置Skywalking的过滤规则，有助于提高系统性能监控的准确性和安全性。