why can not get plugin info from /v1/schema

[renshunhang]

I developed a plugin named openai-token-collector and placed it directly at this location: /usr/local/apisix/apisix/plugins/openai-token-collector.lua. My plugin works correctly, but the schema information I retrieved through the interface /v1/schema does not include information about this plugin. What could be the reason for this?

[Baoyuantop]

Is the plugin configured correctly in config.yaml?

[renshunhang]

Please paste well-formatted code and avoid using screenshots, it helps to check the problem better

OK, This is the complete code.Thanks a lot.

local ngx = ngx
local cjson = require("cjson.safe")
local core = require("apisix.core")
local plugin = require("apisix.plugin")

local schema = {
type = "object",
properties = { enable_prometheus = { type = "boolean",default = true } },
}

local plugin_name = "openai-token-collector"
local _M = {
version = 0.1,
priority = 11111,
name = plugin_name,
schema = schema,
metadata_schema = metadata_schema,
}

local metadata_schema = {
type = "object",
properties = {
},
}

function _M.check_schema(conf, schema_type)
return core.schema.check(schema, conf)
end

function _M.body_filter(conf, ctx)
local chunk, eof = ngx.arg[1], ngx.arg[2]
ctx.openai_metrics_buffer = (ctx.openai_metrics_buffer or "") .. chunk
if not eof then
return
end

local ok, response_data = pcall(core.json.decode, ctx.openai_metrics_buffer)
if not ok or type(response_data) ~= "table" then
    core.log.error("Failed to parse JSON response: ", response_data)
    return
end

local prompt_tokens
local completion_tokens
local total_tokens
if response_data.usage then
    prompt_tokens = response_data.usage.prompt_tokens or 0
    completion_tokens = response_data.usage.completion_tokens or 0
    total_tokens = response_data.usage.total_tokens or 0
end

core.log.warn("prompt_tokens:", prompt_tokens)
core.log.warn("completion_tokens:", completion_tokens)
core.log.warn("total_tokens:", total_tokens)

core.ctx.register_var("completion_tokens", function(ctx)
    return completion_tokens
end)

core.ctx.register_var("prompt_tokens", function(ctx)
    return prompt_tokens
end)

core.ctx.register_var("total_tokens", function(ctx)
    return total_tokens
end)

end

function _M.access(conf, ctx)
-- Get the JWT token from the response headers
local headers = ngx.req.get_headers()
local jwt_token = headers["Authorization"]

if jwt_token then
    -- Remove "Bearer " prefix if it exists
    if jwt_token:find("Bearer ") == 1 then
        jwt_token = jwt_token:sub(8)
    end
    local result, err = parse_jwt_without_validation(jwt_token)
    if not result then
        core.log.warn(ngx.ERR, "JWT parse failed: ", err)
    else
        ctx.issuer =result.payload.iss
        core.log.warn("issuer: ", ctx.issuer)
    end
else
    core.log.warn("No JWT token found in response headers.")
end
local issuer = ctx.issuer or "unknown"
core.log.warn("issuer: ", issuer)
core.ctx.register_var("issuer", function(ctx)
    return issuer
end)

end

function _M.rewrite(conf, ctx)
end

function parse_jwt_without_validation(token)
local parts = {}
for part in token:gmatch("[^.]+") do
table.insert(parts, part)
end
if #parts ~= 3 then
return nil, "Invalid JWT format"
end

local function b64_url_decode(input)
    local remainder = #input % 4
    if remainder > 0 then
        input = input .. string.rep("=", 4 - remainder)
    end
    input = input:gsub("-", "+"):gsub("_", "/")
    return ngx.decode_base64(input)
end

local header_json, err = b64_url_decode(parts[1])
if not header_json then
    return nil, "Header decode failed: " .. (err or "")
end

local payload_json, err = b64_url_decode(parts[2])
if not payload_json then
    return nil, "Payload decode failed: " .. (err or "")
end

local header = cjson.decode(header_json)
local payload = cjson.decode(payload_json)

return {
    header = header,
    payload = payload,
    raw = {
        header = parts[1],
        payload = parts[2],
        signature = parts[3]
    }
}

end

function _M.log(conf, ctx)
end

return _M

[Baoyuantop]

1. Launch APISIX with the latest source code
2. Put the above plugin code into the plugin directory and add the plugin information to config.yaml
3. Reload APISIX
4. Request /v1/schema，then see the following snippet in the returned message

"openai-token-collector": {
      "version": 0.1,
      "schema": {
        "type": "object",
        "properties": {
          "enable_prometheus": {
            "default": true,
            "type": "boolean"
          },
          "_meta": {
            "type": "object",
            "properties": {
              "disable": {
                "type": "boolean"
              },
              "error_response": {
                "oneOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "object"
                  }
                ]
              },
              "pre_function": {
                "description": "function to be executed in each phase before execution of plugins. The pre_function will have access to two arguments: `conf` and `ctx`.",
                "type": "string"
              },
              "priority": {
                "description": "priority of plugins by customized order",
                "type": "integer"
              },
              "filter": {
                "description": "filter determines whether the plugin needs to be executed at runtime",
                "type": "array"
              }
            },
            "additionalProperties": false
          }
        },
        "$comment": "this is a mark for our injected plugin schema"
      },
      "priority": 11111
    },

[renshunhang]

1. Launch APISIX with the latest source code
2. Put the above plugin code into the plugin directory and add the plugin information to config.yaml
3. Reload APISIX
4. Request /v1/schema，then see the following snippet in the returned message

"openai-token-collector": {
      "version": 0.1,
      "schema": {
        "type": "object",
        "properties": {
          "enable_prometheus": {
            "default": true,
            "type": "boolean"
          },
          "_meta": {
            "type": "object",
            "properties": {
              "disable": {
                "type": "boolean"
              },
              "error_response": {
                "oneOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "object"
                  }
                ]
              },
              "pre_function": {
                "description": "function to be executed in each phase before execution of plugins. The pre_function will have access to two arguments: `conf` and `ctx`.",
                "type": "string"
              },
              "priority": {
                "description": "priority of plugins by customized order",
                "type": "integer"
              },
              "filter": {
                "description": "filter determines whether the plugin needs to be executed at runtime",
                "type": "array"
              }
            },
            "additionalProperties": false
          }
        },
        "$comment": "this is a mark for our injected plugin schema"
      },
      "priority": 11111
    },

I followed these steps, and it not works, the image version I used is apisix:3.11.0-debian

[Baoyuantop]

Can you write your complete procedure? How to start and how to add custom plugins.

[renshunhang]

Can you write your complete procedure? How to start and how to add custom plugins.

1. Build the image using a Dockerfile and copy the plugin into the image.The contents:
   FROM registry.cmri.cn/kunlun/jt-baseimages/apisix:3.11.0-debian
   COPY openai-token-collector.lua /usr/local/apisix/apisix/plugins/openai-token-collector.lua
   RUN chown -R apisix:apisix /usr/local/apisix/apisix/plugins/openai-token-collector.lua
2. Add the plugin information to config.yaml, I mounted the configmap to the apsix container through Deployment .
   
3. Reload apisix
   kubectl delete pod apisix-3ea41 -n default