Apache APISIX 文件日志插件中 match 属性的正确使用方式

Apache APISIX 作为一款高性能的云原生 API 网关，其文件日志插件(file-logger)是常用的日志记录工具之一。在实际使用过程中，开发者可能会遇到关于 match 属性配置的困惑，本文将详细介绍其正确用法。

match 属性的数据结构

在 APISIX 3.10.0 版本中，file-logger 插件的 match 属性需要采用三层嵌套数组的结构：

"match": [
  [
    [
      "arg_name",
      "==",
      "jack"
    ]
  ]
]

这种设计允许开发者构建复杂的条件匹配规则，用于过滤需要记录的请求日志。

常见错误配置分析

1. 单层数组配置：

   "match": [
     ["arg_name", "==", "jack"]
   ]
   

   这种配置会导致运行时错误："attempt to index local 'expr' (a nil value)"

2. 文档示例中的对象配置：

   "match": {
     {
       { "arg_name","==","jack" }
     }
   }
   

   这种配置会直接导致 JSON 解析错误："Expected object key string but found T_OBJ_BEGIN"

正确配置原则

1. 最外层是数组，表示可以包含多个条件组
2. 第二层数组表示逻辑"或"关系，满足其中任一条件组即可
3. 最内层数组表示单个条件表达式，包含三个元素：变量名、操作符和比较值

高级用法示例

多个条件组合：

"match": [
  [
    ["arg_name", "==", "jack"],
    ["http_user_agent", "~=", "Chrome"]
  ],
  [
    ["request_time", ">", "1.5"]
  ]
]

这个配置表示：

• 当请求参数 name 等于 jack 或 User-Agent 包含 Chrome 时记录日志
• 或者当请求时间超过 1.5 秒时记录日志

最佳实践建议

1. 对于生产环境，建议先在测试环境验证 match 规则的准确性
2. 复杂的匹配条件可以拆分为多个简单的条件组合
3. 定期检查日志文件，确保匹配规则按预期工作
4. 考虑性能影响，避免过于复杂的匹配条件

通过正确理解和使用 match 属性，开发者可以精确控制文件日志的记录条件，既满足业务需求又避免产生过多冗余日志。