You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2022/12/08 07:16:29 UTC
[GitHub] [apisix] spacewander commented on a diff in pull request #8400: feat: add inspect plugin
spacewander commented on code in PR #8400:
URL: https://github.com/apache/apisix/pull/8400#discussion_r1042950949
##########
Makefile:
##########
@@ -294,6 +294,9 @@ install: runtime
$(ENV_INSTALL) -d $(ENV_INST_LUADIR)/apisix/http
$(ENV_INSTALL) apisix/http/*.lua $(ENV_INST_LUADIR)/apisix/http/
+ $(ENV_INSTALL) -d $(ENV_INST_LUADIR)/apisix/inspect
+ $(ENV_INSTALL) apisix/inspect/*.lua $(ENV_INST_LUADIR)/apisix/inspect/
Review Comment:
Please add the directory in alphabetical order
##########
apisix/inspect/init.lua:
##########
@@ -0,0 +1,134 @@
+--
+-- 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 core = require("apisix.core")
+local dbg = require("apisix.inspect.dbg")
+local lfs = require("lfs")
+local cjson = require("cjson")
+local io = io
+local table_insert = table.insert
+local pcall = pcall
+local ipairs = ipairs
+local os = os
+local ngx = ngx
+local loadstring = loadstring
+
+local _M = {}
+
+local last_modified = 0
+
+local stop = false
+
+local running = false
+
+local last_report_time = 0
+
+local REPORT_INTERVAL = 30 -- secs
+
+local function is_file_exists(file)
+ local f = io.open(file, "r")
+ if f then
+ io.close(f)
+ return true
+ else
+ return false
+ end
+end
+
+local function run_lua_file(file)
+ local f, err = io.open(file, "rb")
+ if not f then
+ return false, err
+ end
+ local code = f:read("*all")
+ f:close()
+ local func, err = loadstring(code)
+ if not func then
+ return false, err
+ end
+ func()
+ return true
+end
+
+local function setup_hooks(file)
+ if is_file_exists(file) then
+ dbg.unset_all()
+ local _, err = pcall(run_lua_file, file)
+ local hooks = {}
+ for _, hook in ipairs(dbg.hooks()) do
+ table_insert(hooks, hook.key)
+ end
+ core.log.info("set hooks: err=", err, ", hooks=", cjson.encode(hooks))
+ end
+end
+
+local function reload_hooks(premature, delay, file)
+ if premature or stop then
+ stop = false
+ running = false
+ return
+ end
+
+ local time, err = lfs.attributes(file, 'modification')
+ if err then
+ if last_modified ~= 0 then
+ core.log.info(err, ", disable all hooks")
+ dbg.unset_all()
+ last_modified = 0
+ end
+ elseif time ~= last_modified then
+ setup_hooks(file)
+ last_modified = time
+ else
+ local ts = os.time()
+ if ts - last_report_time >= REPORT_INTERVAL then
+ local hooks = {}
+ for _, hook in ipairs(dbg.hooks()) do
+ table_insert(hooks, hook.key)
+ end
+ core.log.info("alive hooks: ", cjson.encode(hooks))
Review Comment:
We can use core.json?
##########
apisix/inspect/init.lua:
##########
@@ -0,0 +1,134 @@
+--
+-- 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 core = require("apisix.core")
+local dbg = require("apisix.inspect.dbg")
+local lfs = require("lfs")
+local cjson = require("cjson")
+local io = io
+local table_insert = table.insert
+local pcall = pcall
+local ipairs = ipairs
+local os = os
+local ngx = ngx
+local loadstring = loadstring
+
+local _M = {}
+
+local last_modified = 0
+
+local stop = false
+
+local running = false
+
+local last_report_time = 0
+
+local REPORT_INTERVAL = 30 -- secs
+
+local function is_file_exists(file)
+ local f = io.open(file, "r")
+ if f then
+ io.close(f)
+ return true
+ else
+ return false
+ end
+end
+
+local function run_lua_file(file)
+ local f, err = io.open(file, "rb")
+ if not f then
+ return false, err
+ end
+ local code = f:read("*all")
Review Comment:
Let's do some err check?
##########
apisix/inspect/dbg.lua:
##########
@@ -0,0 +1,153 @@
+--
+-- 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 core = require("apisix.core")
+local string_format = string.format
+local debug = debug
+local ipairs = ipairs
+local pcall = pcall
+local table_insert = table.insert
+local jit = jit
+
+local _M = {}
+
+local hooks = {}
+
+function _M.getname(n)
+ if n.what == "C" then
+ return n.name
+ end
+ local lc = string_format("%s:%d", n.short_src, n.currentline)
+ if n.what ~= "main" and n.namewhat ~= "" then
+ return string_format("%s (%s)", lc, n.name)
+ else
+ return lc
+ end
+end
+
+local function hook(evt, arg)
+ local level = 2
+ local finfo = debug.getinfo(level, "nSlf")
+ local key = finfo.source .. "#" .. arg
+
+ local hooks2 = {}
+ for _, hook in ipairs(hooks) do
+ if key:sub(-#hook.key) == hook.key then
+ local filter_func = hook.filter_func
+ local info = {finfo = finfo, uv = {}, vals = {}}
+
+ -- upvalues
+ local i = 1
+ while true do
+ local name, value = debug.getupvalue(finfo.func, i)
+ if name == nil then break end
+ if name:sub(1, 1) ~= "(" then
+ info.uv[name] = value
+ end
+ i = i + 1
+ end
+
+ -- local values
+ local i = 1
+ while true do
+ local name, value = debug.getlocal(level, i)
+ if not name then break end
+ if name:sub(1, 1) ~= "(" then
+ info.vals[name] = value
+ end
+ i = i + 1
+ end
+
+ local r1, r2_or_err = pcall(filter_func, info)
+ if not r1 then
+ core.log.error("inspect: pcall filter_func:", r2_or_err)
Review Comment:
We can put a goto continue here?
##########
apisix/inspect/init.lua:
##########
@@ -0,0 +1,134 @@
+--
+-- 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 core = require("apisix.core")
+local dbg = require("apisix.inspect.dbg")
+local lfs = require("lfs")
+local cjson = require("cjson")
+local io = io
+local table_insert = table.insert
+local pcall = pcall
+local ipairs = ipairs
+local os = os
+local ngx = ngx
+local loadstring = loadstring
+
+local _M = {}
+
+local last_modified = 0
+
+local stop = false
+
+local running = false
+
+local last_report_time = 0
+
+local REPORT_INTERVAL = 30 -- secs
+
+local function is_file_exists(file)
Review Comment:
We can use common library, like https://github.com/apache/apisix/blob/5822eca9a28ff7b92dc7fc0431281eb62dd60ba8/apisix/cli/ops.lua#L474
##########
apisix/plugins/inspect.lua:
##########
@@ -0,0 +1,62 @@
+--
+-- 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 core = require("apisix.core")
+local plugin = require("apisix.plugin")
+local inspect = require("apisix.inspect")
+local ngx = ngx
+
+
+local plugin_name = "inspect"
+
+
+local schema = {
+ type = "object",
+ properties = {},
+}
+
+
+local _M = {
+ version = 0.1,
+ priority = 200,
+ name = plugin_name,
+ schema = schema,
+}
+
+
+function _M.check_schema(conf, schema_type)
+ return core.schema.check(schema, conf)
+end
+
+
+function _M.init()
+ local attr = plugin.plugin_attr(plugin_name)
Review Comment:
As @tokers asked, could you use plugin metadata instead?
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org