跳到主要内容

Data Mask 配置选项

data-mask 插件在日志记录时移除或替换请求头、请求体和 URL 查询参数中的敏感信息,以提升数据隐私与安全性。 配置涵盖插件参数。

参数​

请参阅插件通用配置,了解所有插件通用的配置选项。

  • request

    array[object]


    屏蔽请求中敏感信息的动作数组。

    • type

      string

      必填

      有效值:

      query、header 或 body

      应屏蔽敏感信息的位置。

    • body_format

      string

      有效值:

      json 或 urlencoded

      请求体的编码。当 type 为 body 时需要。

    • name

      string

      必填


      包含敏感数据的信息字段名称。对于 JSON 体,你可以使用 JSONPath 语法。

    • action

      string

      必填

      有效值:

      regex、replace 或 remove

      屏蔽敏感数据的动作。

    • regex

      string


      用于匹配敏感数据的正则表达式。当 action 为 regex 时需要。

    • value

      string


      用于替换敏感数据的值。当 action 为 regex 或 replace 时需要。

  • max_body_size

    integer

    默认值:1048576


    插件会进行脱敏处理的、位于内存中的 JSON 请求体的最大字节数。如果 JSON 请求体超过此值,则跳过 JSON 请求体规则;查询参数、请求头和 URL 编码请求体规则不受此设置影响。

  • max_req_post_args

    integer

    默认值:100

    有效值:

    大于或等于 0

    当 body_format 设置为 urlencoded 且对请求体数据进行脱敏时,最多解析的 URL 编码表单字段数。