spacewander commented on a change in pull request #5831: URL: https://github.com/apache/apisix/pull/5831#discussion_r776539101
########## File path: apisix/plugins/file-logger.lua ########## @@ -0,0 +1,212 @@ +-- +-- Licensed to the Apache Software Foundation (ASF) under one or more +-- contributor license agreements. See the NOTICE file distributed with +-- this work for additional information regarding copyright ownership. +-- The ASF licenses this file to You under the Apache License, Version 2.0 +-- (the "License"); you may not use this file except in compliance with +-- the License. You may obtain a copy of the License at +-- +-- http://www.apache.org/licenses/LICENSE-2.0 +-- +-- Unless required by applicable law or agreed to in writing, software +-- distributed under the License is distributed on an "AS IS" BASIS, +-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +-- See the License for the specific language governing permissions and +-- limitations under the License. +-- +local log_util = require("apisix.utils.log-util") +local core = require("apisix.core") +local plugin = require("apisix.plugin") +local ffi = require("ffi") +local bit = require("bit") + +local C = ffi.C +local ngx = ngx +local pairs = pairs +local load_string = loadstring +local io_open = io.open + +local plugin_name = "file-logger" +local O_CREAT = 00000040 -- create and open Review comment: Why not use Lua's std file library? That one is much simpler. See https://www.tutorialspoint.com/lua/lua_file_io.htm ########## File path: apisix/plugins/file-logger.lua ########## @@ -0,0 +1,212 @@ +-- +-- Licensed to the Apache Software Foundation (ASF) under one or more +-- contributor license agreements. See the NOTICE file distributed with +-- this work for additional information regarding copyright ownership. +-- The ASF licenses this file to You under the Apache License, Version 2.0 +-- (the "License"); you may not use this file except in compliance with +-- the License. You may obtain a copy of the License at +-- +-- http://www.apache.org/licenses/LICENSE-2.0 +-- +-- Unless required by applicable law or agreed to in writing, software +-- distributed under the License is distributed on an "AS IS" BASIS, +-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +-- See the License for the specific language governing permissions and +-- limitations under the License. +-- +local log_util = require("apisix.utils.log-util") +local core = require("apisix.core") +local plugin = require("apisix.plugin") +local ffi = require("ffi") +local bit = require("bit") + +local C = ffi.C +local ngx = ngx +local pairs = pairs +local load_string = loadstring +local io_open = io.open + +local plugin_name = "file-logger" +local O_CREAT = 00000040 -- create and open +local O_APPEND = 00000400 -- add content to the end of +local O_WRONLY = 00000001 -- write only open +local S_IRUSR = 00400 -- user has read permission +local S_IWUSR = 00200 -- user has write permission +local S_IRGRP = 00040 -- group has read permission +local S_IROTH = 00004 -- others have read permission + +local oflags = bit.bor(O_WRONLY, O_CREAT, O_APPEND) +local mode = bit.bor(S_IRUSR, S_IWUSR, S_IRGRP, S_IROTH) +local file_descriptors = {} + +ffi.cdef [[ + int open(const char * filename, int flags, int mode); + int write(int fd, const void * ptr, int numbytes); + int close(int fd); +]] +local schema = { + type = "object", + properties = { + path = { + type = "string", + require = true, + match = [[^[^*&%%\`]+$]], + err = "not a valid filename" + }, + custom_fields_by_lua = { + type = "object", + keys = { + type = "string", + len_min = 1 + }, + values = { + type = "string", + len_min = 1 + } + } + }, + required = {"path"} +} + +local metadata_schema = { + type = "object", + properties = { + log_format = log_util.metadata_schema_log_format + } +} + +local _M = { + version = 0.1, + priority = 399, + name = plugin_name, + schema = schema, + metadata_schema = metadata_schema +} + +function _M.check_schema(conf, schema_type) + if schema_type == core.schema.TYPE_METADATA then + return core.schema.check(metadata_schema, conf) + end + + local ok, err = core.schema.check(schema, conf) + if not ok then + return nil, err + end + return log_util.check_log_schema(conf) +end + + +local function reopen() + local args = ngx.req.get_uri_args() + if args["reopen"] then + local target_pointer, err = io_open('logs/file_pointer', 'r') + if not target_pointer then + core.log.error("failed to open file, error info: " .. err) + else + local pointer = target_pointer:read('*n') + target_pointer:close() + core.log.warn('pointer: ', pointer) + C.close(pointer) + + local reset_pointer = io_open('logs/file_pointer', 'w+') + reset_pointer:write(-1) + reset_pointer:close() + end + end +end + + +local function write_file_data(conf, log_message) + local msg = core.json.encode(log_message) .. "\n" + local fd = file_descriptors[conf.path] + local file = io_open(conf.path, 'r') + local file_pointer = io_open('logs/file_pointer', 'r') + + if file_pointer then + local read_pointer = file_pointer:read('*n') + core.log.warn('read_pointer: ', read_pointer) + file_pointer:close() + if read_pointer < 0 then + C.close(fd) + fd = nil + file_descriptors[conf.path] = nil + end + else + fd = file_descriptors[conf.path] + end + + if not file then + file = io_open(conf.path, 'a+') + file:close() + if fd then + C.close(fd) + fd = nil + file_descriptors[conf.path] = nil + end + else + file:close() + end + + + if not fd then + fd = C.open(conf.path, oflags, mode) + core.log.warn('fd: ', fd) + local write_pointer = io_open('logs/file_pointer', 'w+') + write_pointer:write(fd) + write_pointer:close() + + if fd < 0 then + local err = ffi.errno() + core.log.error("failed to open file: " .. conf.path .. ", error info: " .. err) + + else + file_descriptors[conf.path] = fd + end + end + + C.write(fd, msg, #msg) +end + + +function _M.body_filter(conf, ctx) + log_util.collect_body(conf, ctx) +end + + +function _M.log(conf, ctx) + local metadata = plugin.plugin_metadata(plugin_name) + local entry + + if metadata and metadata.value.log_format + and core.table.nkeys(metadata.value.log_format) > 0 + then + entry = log_util.get_custom_format_log(ctx, metadata.value.log_format) + else + entry = log_util.get_full_log(ngx, conf) + end + + if conf.custom_fields_by_lua Review comment: Look like we don't need to provide `custom_fields_by_lua`, as we already have "log_util.get_custom_format_log". ########## File path: apisix/plugins/file-logger.lua ########## @@ -0,0 +1,212 @@ +-- +-- Licensed to the Apache Software Foundation (ASF) under one or more +-- contributor license agreements. See the NOTICE file distributed with +-- this work for additional information regarding copyright ownership. +-- The ASF licenses this file to You under the Apache License, Version 2.0 +-- (the "License"); you may not use this file except in compliance with +-- the License. You may obtain a copy of the License at +-- +-- http://www.apache.org/licenses/LICENSE-2.0 +-- +-- Unless required by applicable law or agreed to in writing, software +-- distributed under the License is distributed on an "AS IS" BASIS, +-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +-- See the License for the specific language governing permissions and +-- limitations under the License. +-- +local log_util = require("apisix.utils.log-util") +local core = require("apisix.core") +local plugin = require("apisix.plugin") +local ffi = require("ffi") +local bit = require("bit") + Review comment: Please don't use a blank line between localized functions. ########## File path: apisix/plugins/file-logger.lua ########## @@ -0,0 +1,212 @@ +-- +-- Licensed to the Apache Software Foundation (ASF) under one or more +-- contributor license agreements. See the NOTICE file distributed with +-- this work for additional information regarding copyright ownership. +-- The ASF licenses this file to You under the Apache License, Version 2.0 +-- (the "License"); you may not use this file except in compliance with +-- the License. You may obtain a copy of the License at +-- +-- http://www.apache.org/licenses/LICENSE-2.0 +-- +-- Unless required by applicable law or agreed to in writing, software +-- distributed under the License is distributed on an "AS IS" BASIS, +-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +-- See the License for the specific language governing permissions and +-- limitations under the License. +-- +local log_util = require("apisix.utils.log-util") +local core = require("apisix.core") +local plugin = require("apisix.plugin") +local ffi = require("ffi") +local bit = require("bit") + +local C = ffi.C +local ngx = ngx +local pairs = pairs +local load_string = loadstring +local io_open = io.open + +local plugin_name = "file-logger" +local O_CREAT = 00000040 -- create and open +local O_APPEND = 00000400 -- add content to the end of +local O_WRONLY = 00000001 -- write only open +local S_IRUSR = 00400 -- user has read permission +local S_IWUSR = 00200 -- user has write permission +local S_IRGRP = 00040 -- group has read permission +local S_IROTH = 00004 -- others have read permission + +local oflags = bit.bor(O_WRONLY, O_CREAT, O_APPEND) +local mode = bit.bor(S_IRUSR, S_IWUSR, S_IRGRP, S_IROTH) +local file_descriptors = {} + +ffi.cdef [[ + int open(const char * filename, int flags, int mode); + int write(int fd, const void * ptr, int numbytes); + int close(int fd); +]] +local schema = { + type = "object", + properties = { + path = { + type = "string", + require = true, + match = [[^[^*&%%\`]+$]], + err = "not a valid filename" + }, + custom_fields_by_lua = { + type = "object", + keys = { + type = "string", + len_min = 1 + }, + values = { + type = "string", + len_min = 1 + } + } + }, + required = {"path"} +} + +local metadata_schema = { + type = "object", + properties = { + log_format = log_util.metadata_schema_log_format + } +} + +local _M = { + version = 0.1, + priority = 399, + name = plugin_name, + schema = schema, + metadata_schema = metadata_schema +} + +function _M.check_schema(conf, schema_type) + if schema_type == core.schema.TYPE_METADATA then + return core.schema.check(metadata_schema, conf) + end + + local ok, err = core.schema.check(schema, conf) + if not ok then + return nil, err + end + return log_util.check_log_schema(conf) +end + + +local function reopen() + local args = ngx.req.get_uri_args() + if args["reopen"] then + local target_pointer, err = io_open('logs/file_pointer', 'r') + if not target_pointer then + core.log.error("failed to open file, error info: " .. err) + else + local pointer = target_pointer:read('*n') + target_pointer:close() + core.log.warn('pointer: ', pointer) + C.close(pointer) + + local reset_pointer = io_open('logs/file_pointer', 'w+') + reset_pointer:write(-1) + reset_pointer:close() + end + end +end + + +local function write_file_data(conf, log_message) + local msg = core.json.encode(log_message) .. "\n" + local fd = file_descriptors[conf.path] + local file = io_open(conf.path, 'r') + local file_pointer = io_open('logs/file_pointer', 'r') + + if file_pointer then + local read_pointer = file_pointer:read('*n') + core.log.warn('read_pointer: ', read_pointer) + file_pointer:close() + if read_pointer < 0 then + C.close(fd) + fd = nil + file_descriptors[conf.path] = nil + end + else + fd = file_descriptors[conf.path] + end + + if not file then + file = io_open(conf.path, 'a+') + file:close() + if fd then + C.close(fd) + fd = nil + file_descriptors[conf.path] = nil + end + else + file:close() + end + + + if not fd then + fd = C.open(conf.path, oflags, mode) + core.log.warn('fd: ', fd) + local write_pointer = io_open('logs/file_pointer', 'w+') + write_pointer:write(fd) + write_pointer:close() + + if fd < 0 then + local err = ffi.errno() + core.log.error("failed to open file: " .. conf.path .. ", error info: " .. err) + + else + file_descriptors[conf.path] = fd + end + end + + C.write(fd, msg, #msg) +end + + +function _M.body_filter(conf, ctx) + log_util.collect_body(conf, ctx) Review comment: Since the first version of file-logger doesn't support logging response body, we don't need to collect it. ########## File path: apisix/plugins/file-logger.lua ########## @@ -0,0 +1,212 @@ +-- +-- Licensed to the Apache Software Foundation (ASF) under one or more +-- contributor license agreements. See the NOTICE file distributed with +-- this work for additional information regarding copyright ownership. +-- The ASF licenses this file to You under the Apache License, Version 2.0 +-- (the "License"); you may not use this file except in compliance with +-- the License. You may obtain a copy of the License at +-- +-- http://www.apache.org/licenses/LICENSE-2.0 +-- +-- Unless required by applicable law or agreed to in writing, software +-- distributed under the License is distributed on an "AS IS" BASIS, +-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +-- See the License for the specific language governing permissions and +-- limitations under the License. +-- +local log_util = require("apisix.utils.log-util") +local core = require("apisix.core") +local plugin = require("apisix.plugin") +local ffi = require("ffi") +local bit = require("bit") + +local C = ffi.C +local ngx = ngx +local pairs = pairs +local load_string = loadstring +local io_open = io.open + +local plugin_name = "file-logger" +local O_CREAT = 00000040 -- create and open +local O_APPEND = 00000400 -- add content to the end of +local O_WRONLY = 00000001 -- write only open +local S_IRUSR = 00400 -- user has read permission +local S_IWUSR = 00200 -- user has write permission +local S_IRGRP = 00040 -- group has read permission +local S_IROTH = 00004 -- others have read permission + +local oflags = bit.bor(O_WRONLY, O_CREAT, O_APPEND) +local mode = bit.bor(S_IRUSR, S_IWUSR, S_IRGRP, S_IROTH) +local file_descriptors = {} + +ffi.cdef [[ + int open(const char * filename, int flags, int mode); + int write(int fd, const void * ptr, int numbytes); + int close(int fd); +]] +local schema = { + type = "object", + properties = { + path = { + type = "string", + require = true, + match = [[^[^*&%%\`]+$]], + err = "not a valid filename" + }, + custom_fields_by_lua = { + type = "object", + keys = { + type = "string", + len_min = 1 + }, + values = { + type = "string", + len_min = 1 + } + } + }, + required = {"path"} +} + +local metadata_schema = { + type = "object", + properties = { + log_format = log_util.metadata_schema_log_format + } +} + +local _M = { + version = 0.1, + priority = 399, + name = plugin_name, + schema = schema, + metadata_schema = metadata_schema +} + Review comment: Please use two blank lines to separate each section (localized functions, define module-level variables, define functions, return _M) ########## File path: apisix/plugins/file-logger.lua ########## @@ -0,0 +1,212 @@ +-- +-- Licensed to the Apache Software Foundation (ASF) under one or more +-- contributor license agreements. See the NOTICE file distributed with +-- this work for additional information regarding copyright ownership. +-- The ASF licenses this file to You under the Apache License, Version 2.0 +-- (the "License"); you may not use this file except in compliance with +-- the License. You may obtain a copy of the License at +-- +-- http://www.apache.org/licenses/LICENSE-2.0 +-- +-- Unless required by applicable law or agreed to in writing, software +-- distributed under the License is distributed on an "AS IS" BASIS, +-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +-- See the License for the specific language governing permissions and +-- limitations under the License. +-- +local log_util = require("apisix.utils.log-util") +local core = require("apisix.core") +local plugin = require("apisix.plugin") +local ffi = require("ffi") +local bit = require("bit") + +local C = ffi.C +local ngx = ngx +local pairs = pairs +local load_string = loadstring +local io_open = io.open + +local plugin_name = "file-logger" +local O_CREAT = 00000040 -- create and open +local O_APPEND = 00000400 -- add content to the end of +local O_WRONLY = 00000001 -- write only open +local S_IRUSR = 00400 -- user has read permission +local S_IWUSR = 00200 -- user has write permission +local S_IRGRP = 00040 -- group has read permission +local S_IROTH = 00004 -- others have read permission + +local oflags = bit.bor(O_WRONLY, O_CREAT, O_APPEND) +local mode = bit.bor(S_IRUSR, S_IWUSR, S_IRGRP, S_IROTH) +local file_descriptors = {} + +ffi.cdef [[ + int open(const char * filename, int flags, int mode); + int write(int fd, const void * ptr, int numbytes); + int close(int fd); +]] +local schema = { + type = "object", + properties = { + path = { + type = "string", + require = true, + match = [[^[^*&%%\`]+$]], + err = "not a valid filename" + }, + custom_fields_by_lua = { + type = "object", + keys = { + type = "string", + len_min = 1 + }, + values = { + type = "string", + len_min = 1 + } + } + }, + required = {"path"} +} + +local metadata_schema = { + type = "object", + properties = { + log_format = log_util.metadata_schema_log_format + } +} + +local _M = { + version = 0.1, + priority = 399, + name = plugin_name, + schema = schema, + metadata_schema = metadata_schema +} + +function _M.check_schema(conf, schema_type) + if schema_type == core.schema.TYPE_METADATA then + return core.schema.check(metadata_schema, conf) + end + + local ok, err = core.schema.check(schema, conf) + if not ok then + return nil, err + end + return log_util.check_log_schema(conf) +end + + +local function reopen() + local args = ngx.req.get_uri_args() + if args["reopen"] then + local target_pointer, err = io_open('logs/file_pointer', 'r') + if not target_pointer then + core.log.error("failed to open file, error info: " .. err) + else + local pointer = target_pointer:read('*n') + target_pointer:close() + core.log.warn('pointer: ', pointer) + C.close(pointer) + + local reset_pointer = io_open('logs/file_pointer', 'w+') + reset_pointer:write(-1) + reset_pointer:close() + end + end +end + + +local function write_file_data(conf, log_message) + local msg = core.json.encode(log_message) .. "\n" + local fd = file_descriptors[conf.path] + local file = io_open(conf.path, 'r') + local file_pointer = io_open('logs/file_pointer', 'r') + + if file_pointer then + local read_pointer = file_pointer:read('*n') + core.log.warn('read_pointer: ', read_pointer) + file_pointer:close() + if read_pointer < 0 then + C.close(fd) + fd = nil + file_descriptors[conf.path] = nil + end + else + fd = file_descriptors[conf.path] + end + + if not file then + file = io_open(conf.path, 'a+') + file:close() + if fd then + C.close(fd) + fd = nil + file_descriptors[conf.path] = nil + end + else + file:close() + end + + + if not fd then + fd = C.open(conf.path, oflags, mode) + core.log.warn('fd: ', fd) + local write_pointer = io_open('logs/file_pointer', 'w+') + write_pointer:write(fd) + write_pointer:close() + + if fd < 0 then + local err = ffi.errno() + core.log.error("failed to open file: " .. conf.path .. ", error info: " .. err) + + else + file_descriptors[conf.path] = fd + end + end + + C.write(fd, msg, #msg) +end + + +function _M.body_filter(conf, ctx) + log_util.collect_body(conf, ctx) +end + + +function _M.log(conf, ctx) + local metadata = plugin.plugin_metadata(plugin_name) + local entry + + if metadata and metadata.value.log_format + and core.table.nkeys(metadata.value.log_format) > 0 + then + entry = log_util.get_custom_format_log(ctx, metadata.value.log_format) + else + entry = log_util.get_full_log(ngx, conf) + end + + if conf.custom_fields_by_lua + and core.table.nkeys(conf.custom_fields_by_lua) > 0 + then + local set_log_fields_value = entry + for key, expression in pairs(conf.custom_fields_by_lua) do + set_log_fields_value[key] = load_string(expression)() + end + write_file_data(conf, set_log_fields_value) + else + write_file_data(conf, entry) + end +end + + +function _M.control_api() + return { + { + methods = {"GET"}, + uris = {"/plugin/file-logger/reopen"}, Review comment: ```suggestion uris = {"/v1/plugin/file-logger/reopen"}, ``` would be better ########## File path: apisix/plugins/file-logger.lua ########## @@ -0,0 +1,212 @@ +-- +-- Licensed to the Apache Software Foundation (ASF) under one or more +-- contributor license agreements. See the NOTICE file distributed with +-- this work for additional information regarding copyright ownership. +-- The ASF licenses this file to You under the Apache License, Version 2.0 +-- (the "License"); you may not use this file except in compliance with +-- the License. You may obtain a copy of the License at +-- +-- http://www.apache.org/licenses/LICENSE-2.0 +-- +-- Unless required by applicable law or agreed to in writing, software +-- distributed under the License is distributed on an "AS IS" BASIS, +-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +-- See the License for the specific language governing permissions and +-- limitations under the License. +-- +local log_util = require("apisix.utils.log-util") +local core = require("apisix.core") +local plugin = require("apisix.plugin") +local ffi = require("ffi") +local bit = require("bit") + +local C = ffi.C +local ngx = ngx +local pairs = pairs +local load_string = loadstring +local io_open = io.open + Review comment: Better to use two blank lines after localized functions. ########## File path: apisix/plugins/file-logger.lua ########## @@ -0,0 +1,212 @@ +-- +-- Licensed to the Apache Software Foundation (ASF) under one or more +-- contributor license agreements. See the NOTICE file distributed with +-- this work for additional information regarding copyright ownership. +-- The ASF licenses this file to You under the Apache License, Version 2.0 +-- (the "License"); you may not use this file except in compliance with +-- the License. You may obtain a copy of the License at +-- +-- http://www.apache.org/licenses/LICENSE-2.0 +-- +-- Unless required by applicable law or agreed to in writing, software +-- distributed under the License is distributed on an "AS IS" BASIS, +-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +-- See the License for the specific language governing permissions and +-- limitations under the License. +-- +local log_util = require("apisix.utils.log-util") +local core = require("apisix.core") +local plugin = require("apisix.plugin") +local ffi = require("ffi") +local bit = require("bit") + +local C = ffi.C +local ngx = ngx +local pairs = pairs +local load_string = loadstring +local io_open = io.open + +local plugin_name = "file-logger" +local O_CREAT = 00000040 -- create and open +local O_APPEND = 00000400 -- add content to the end of +local O_WRONLY = 00000001 -- write only open +local S_IRUSR = 00400 -- user has read permission +local S_IWUSR = 00200 -- user has write permission +local S_IRGRP = 00040 -- group has read permission +local S_IROTH = 00004 -- others have read permission + +local oflags = bit.bor(O_WRONLY, O_CREAT, O_APPEND) +local mode = bit.bor(S_IRUSR, S_IWUSR, S_IRGRP, S_IROTH) +local file_descriptors = {} + +ffi.cdef [[ + int open(const char * filename, int flags, int mode); + int write(int fd, const void * ptr, int numbytes); + int close(int fd); +]] +local schema = { + type = "object", + properties = { + path = { + type = "string", + require = true, Review comment: This is not a valid JSON schema syntax. Please take a look at https://github.com/apache/apisix/blob/master/apisix/schema_def.lua ########## File path: apisix/plugins/file-logger.lua ########## @@ -0,0 +1,212 @@ +-- +-- Licensed to the Apache Software Foundation (ASF) under one or more +-- contributor license agreements. See the NOTICE file distributed with +-- this work for additional information regarding copyright ownership. +-- The ASF licenses this file to You under the Apache License, Version 2.0 +-- (the "License"); you may not use this file except in compliance with +-- the License. You may obtain a copy of the License at +-- +-- http://www.apache.org/licenses/LICENSE-2.0 +-- +-- Unless required by applicable law or agreed to in writing, software +-- distributed under the License is distributed on an "AS IS" BASIS, +-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +-- See the License for the specific language governing permissions and +-- limitations under the License. +-- +local log_util = require("apisix.utils.log-util") +local core = require("apisix.core") +local plugin = require("apisix.plugin") +local ffi = require("ffi") +local bit = require("bit") + +local C = ffi.C +local ngx = ngx +local pairs = pairs +local load_string = loadstring +local io_open = io.open + +local plugin_name = "file-logger" +local O_CREAT = 00000040 -- create and open +local O_APPEND = 00000400 -- add content to the end of +local O_WRONLY = 00000001 -- write only open +local S_IRUSR = 00400 -- user has read permission +local S_IWUSR = 00200 -- user has write permission +local S_IRGRP = 00040 -- group has read permission +local S_IROTH = 00004 -- others have read permission + +local oflags = bit.bor(O_WRONLY, O_CREAT, O_APPEND) +local mode = bit.bor(S_IRUSR, S_IWUSR, S_IRGRP, S_IROTH) +local file_descriptors = {} + +ffi.cdef [[ + int open(const char * filename, int flags, int mode); + int write(int fd, const void * ptr, int numbytes); + int close(int fd); +]] +local schema = { + type = "object", + properties = { + path = { + type = "string", + require = true, + match = [[^[^*&%%\`]+$]], + err = "not a valid filename" + }, + custom_fields_by_lua = { + type = "object", + keys = { + type = "string", + len_min = 1 + }, + values = { + type = "string", + len_min = 1 + } + } + }, + required = {"path"} +} + +local metadata_schema = { + type = "object", + properties = { + log_format = log_util.metadata_schema_log_format + } +} + +local _M = { + version = 0.1, + priority = 399, + name = plugin_name, + schema = schema, + metadata_schema = metadata_schema +} + +function _M.check_schema(conf, schema_type) + if schema_type == core.schema.TYPE_METADATA then + return core.schema.check(metadata_schema, conf) + end + + local ok, err = core.schema.check(schema, conf) + if not ok then + return nil, err + end + return log_util.check_log_schema(conf) +end + + +local function reopen() + local args = ngx.req.get_uri_args() + if args["reopen"] then + local target_pointer, err = io_open('logs/file_pointer', 'r') + if not target_pointer then + core.log.error("failed to open file, error info: " .. err) + else + local pointer = target_pointer:read('*n') + target_pointer:close() + core.log.warn('pointer: ', pointer) + C.close(pointer) + + local reset_pointer = io_open('logs/file_pointer', 'w+') + reset_pointer:write(-1) + reset_pointer:close() + end + end +end + + +local function write_file_data(conf, log_message) + local msg = core.json.encode(log_message) .. "\n" + local fd = file_descriptors[conf.path] + local file = io_open(conf.path, 'r') + local file_pointer = io_open('logs/file_pointer', 'r') + + if file_pointer then + local read_pointer = file_pointer:read('*n') + core.log.warn('read_pointer: ', read_pointer) + file_pointer:close() + if read_pointer < 0 then + C.close(fd) + fd = nil + file_descriptors[conf.path] = nil + end + else + fd = file_descriptors[conf.path] + end + + if not file then + file = io_open(conf.path, 'a+') + file:close() + if fd then + C.close(fd) + fd = nil + file_descriptors[conf.path] = nil + end + else + file:close() + end + + + if not fd then + fd = C.open(conf.path, oflags, mode) + core.log.warn('fd: ', fd) + local write_pointer = io_open('logs/file_pointer', 'w+') + write_pointer:write(fd) + write_pointer:close() + + if fd < 0 then + local err = ffi.errno() + core.log.error("failed to open file: " .. conf.path .. ", error info: " .. err) + + else + file_descriptors[conf.path] = fd + end + end + + C.write(fd, msg, #msg) +end + + +function _M.body_filter(conf, ctx) + log_util.collect_body(conf, ctx) +end + + +function _M.log(conf, ctx) + local metadata = plugin.plugin_metadata(plugin_name) + local entry + + if metadata and metadata.value.log_format + and core.table.nkeys(metadata.value.log_format) > 0 + then + entry = log_util.get_custom_format_log(ctx, metadata.value.log_format) + else + entry = log_util.get_full_log(ngx, conf) + end + + if conf.custom_fields_by_lua + and core.table.nkeys(conf.custom_fields_by_lua) > 0 + then + local set_log_fields_value = entry + for key, expression in pairs(conf.custom_fields_by_lua) do + set_log_fields_value[key] = load_string(expression)() + end + write_file_data(conf, set_log_fields_value) + else + write_file_data(conf, entry) + end +end + + +function _M.control_api() + return { + { + methods = {"GET"}, Review comment: What about using `PUT`? We already use it in the reload: https://github.com/apache/apisix/blob/master/docs/en/latest/architecture-design/plugin.md#hot-reload -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
