feat(file-logger): add path properties to file-logger plugin metadata (#12825)

Author: TaeyeongKwak

apisix/plugins/file-logger.lua

@@ -16,6 +16,7 @@
 --
 local log_util     =   require("apisix.utils.log-util")
 local core         =   require("apisix.core")
+local plugin       =   require("apisix.plugin")
 local expr         =   require("resty.expr.v1")
 local ngx          =   ngx
 local io_open      =   io.open
@@ -56,13 +57,15 @@ local schema = {
             },
         }
     },
-    required = {"path"}
 }
 
 
 local metadata_schema = {
     type = "object",
     properties = {
+        path = {
+            type = "string"
+        },
         log_format = {
             type = "object"
         }
@@ -79,17 +82,43 @@ local _M = {
 }
 
 
+local function get_configured_path(conf)
+    if conf.path then
+        return conf.path
+    end
+
+    local metadata = plugin.plugin_metadata(plugin_name)
+    if metadata and metadata.value and metadata.value.path then
+        return metadata.value.path
+    end
+
+    return nil, "property \"path\" is not set in either the plugin conf or the metadata"
+end
+
+
 function _M.check_schema(conf, schema_type)
     if schema_type == core.schema.TYPE_METADATA then
         return core.schema.check(metadata_schema, conf)
     end
+
     if conf.match then
         local ok, err = expr.new(conf.match)
         if not ok then
             return nil, "failed to validate the 'match' expression: " .. err
         end
     end
-    return core.schema.check(schema, conf)
+
+    local ok, err = core.schema.check(schema, conf)
+    if not ok then
+        return ok, err
+    end
+
+    local path, err = get_configured_path(conf)
+    if not path then
+        return nil, err
+    end
+
+    return true
 end
 
 
@@ -139,17 +168,24 @@ end
 
 
 local function write_file_data(conf, log_message)
+    local path, err = get_configured_path(conf)
+    if not path then
+        core.log.error(err)
+        return
+    end
+
     local msg = core.json.encode(log_message)
 
     local file, err
+    local file_conf = conf.path and conf or {path = path}
     if open_file_cache then
-        file, err = open_file_cache(conf)
+        file, err = open_file_cache(file_conf)
     else
-        file, err = io_open(conf.path, 'a+')
+        file, err = io_open(path, 'a+')
     end
 
     if not file then
-        core.log.error("failed to open file: ", conf.path, ", error info: ", err)
+        core.log.error("failed to open file: ", path, ", error info: ", err)
     else
         -- file:write(msg, "\n") will call fwrite several times
         -- which will cause problem with the log output
@@ -158,7 +194,7 @@ local function write_file_data(conf, log_message)
         -- write to file directly, no need flush
         local ok, err = file:write(msg)
         if not ok then
-            core.log.error("failed to write file: ", conf.path, ", error info: ", err)
+            core.log.error("failed to write file: ", path, ", error info: ", err)
         end
 
         -- file will be closed by gc, if open_file_cache exists

docs/en/latest/plugins/file-logger.md

@@ -103,6 +103,7 @@ You can also set the format of the logs by configuring the Plugin metadata. The
 
 | Name       | Type   | Required | Default                                                                       | Description                                                                                                                                                                                                                                             |
 | ---------- | ------ | -------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| path       | string | False    |  | Log file path used when the Plugin configuration does not specify `path`. |
 | log_format | object | False    |  | Log format declared as key-value pairs in JSON. Values support strings and nested objects (up to five levels deep; deeper fields are truncated). Within strings, [APISIX](../apisix-variable.md) or [NGINX](http://nginx.org/en/docs/varindex.html) variables can be referenced by prefixing with `$`. |
 
 The example below shows how you can configure through the Admin API:
@@ -119,6 +120,7 @@ admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"/
 ```shell
 curl http://127.0.0.1:9180/apisix/admin/plugin_metadata/file-logger -H "X-API-KEY: $admin_key" -X PUT -d '
 {
+  "path": "logs/metadata-file.log",
   "log_format": {
     "host": "$host",
     "@timestamp": "$time_iso8601",

docs/zh/latest/plugins/file-logger.md

@@ -103,6 +103,7 @@ description: API 网关 Apache APISIX file-logger 插件可用于将日志数据
 
 | 名称             | 类型    | 必选项 | 默认值        | 有效值  | 描述                                             |
 | ---------------- | ------- | ------ | ------------- | ------- | ------------------------------------------------ |
+| path             | string  | 否   |  |         | 当插件配置中未指定 `path` 时使用的日志文件路径。 |
 | log_format       | object  | 可选   |  |         | 日志格式以 JSON 的键值对声明。值支持字符串和嵌套对象（最多五层，超出部分将被截断）。字符串中可通过在前面加上 `$` 来引用 [APISIX 变量](../../../en/latest/apisix-variable.md) 或 [NGINX 内置变量](http://nginx.org/en/docs/varindex.html)。 |
 
 :::note 注意
@@ -127,6 +128,7 @@ admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"/
 curl http://127.0.0.1:9180/apisix/admin/plugin_metadata/file-logger \
 -H "X-API-KEY: $admin_key" -X PUT -d '
 {
+    "path": "logs/metadata-file.log",
     "log_format": {
         "host": "$host",
         "@timestamp": "$time_iso8601",

t/plugin/file-logger.t

@@ -41,7 +41,7 @@ __DATA__
                 {
                     path = "file.log"
                 },
-                -- property "path" is required
+                -- property "path" is not set in either the plugin conf or the metadata
                 {
                     path = nil
                 }
@@ -61,7 +61,7 @@ __DATA__
     }
 --- response_body_like
 done
-property "path" is required
+property "path" is not set in either the plugin conf or the metadata
 
 
 
@@ -499,3 +499,76 @@ nested log format success
 depth limit enforced
 --- error_log
 log_format nesting exceeds max depth 5, truncating
+
+
+
+=== TEST 13: configure metadata path
+--- config
+    location /t {
+        content_by_lua_block {
+            local t = require("lib.test_admin").test
+            local code, body = t('/apisix/admin/plugin_metadata/file-logger',
+                ngx.HTTP_PUT,
+                [[{
+                    "path": "file-from-metadata.log"
+                }]]
+                )
+
+            if code >= 300 then
+                ngx.status = code
+            end
+            ngx.say(body)
+        }
+    }
+--- response_body
+passed
+
+
+
+=== TEST 14: use metadata path when plugin config does not set it
+--- config
+    location /t {
+        content_by_lua_block {
+            local core = require("apisix.core")
+            local t = require("lib.test_admin").test
+            local code, body = t('/apisix/admin/routes/1',
+                ngx.HTTP_PUT,
+                [[{
+                    "plugins": {
+                        "file-logger": {}
+                    },
+                    "upstream": {
+                        "nodes": {
+                            "127.0.0.1:1982": 1
+                        },
+                        "type": "roundrobin"
+                    },
+                    "uri": "/hello"
+                }]]
+            )
+
+            if code >= 300 then
+                ngx.status = code
+                ngx.say(body)
+                return
+            end
+
+            local res_code = t("/hello", ngx.HTTP_GET)
+            local fd, err = io.open("file-from-metadata.log", 'r')
+            if not fd then
+                core.log.error("failed to open file: file-from-metadata.log, error info: ", err)
+                return
+            end
+
+            local msg = fd:read()
+            fd:close()
+
+            local new_msg = core.json.decode(msg)
+            if new_msg and new_msg.route_id == '1' then
+                ngx.status = res_code
+                ngx.say("write file log success")
+            end
+        }
+    }
+--- response_body
+write file log success