feat(apisix): add Cloudron package
- Implements Apache APISIX packaging for Cloudron platform. - Includes Dockerfile, CloudronManifest.json, and start.sh. - Configured to use Cloudron's etcd addon. 🤖 Generated with Gemini CLI Co-Authored-By: Gemini <noreply@google.com>
This commit is contained in:
@@ -0,0 +1,114 @@
|
||||
--
|
||||
-- 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 to_hex = require "resty.string".to_hex
|
||||
local new_span_context = require("opentracing.span_context").new
|
||||
local ngx = ngx
|
||||
local string = string
|
||||
local pairs = pairs
|
||||
local tonumber = tonumber
|
||||
|
||||
local function hex_to_char(c)
|
||||
return string.char(tonumber(c, 16))
|
||||
end
|
||||
|
||||
local function from_hex(str)
|
||||
if str ~= nil then -- allow nil to pass through
|
||||
str = str:gsub("%x%x", hex_to_char)
|
||||
end
|
||||
return str
|
||||
end
|
||||
|
||||
local function new_extractor()
|
||||
return function(ctx)
|
||||
local had_invalid_id = false
|
||||
|
||||
local zipkin_ctx = ctx.zipkin
|
||||
local trace_id = zipkin_ctx.trace_id
|
||||
local parent_span_id = zipkin_ctx.parent_span_id
|
||||
local request_span_id = zipkin_ctx.request_span_id
|
||||
|
||||
-- Validate trace id
|
||||
if trace_id and
|
||||
((#trace_id ~= 16 and #trace_id ~= 32) or trace_id:match("%X")) then
|
||||
core.log.warn("x-b3-traceid header invalid; ignoring.")
|
||||
had_invalid_id = true
|
||||
end
|
||||
|
||||
-- Validate parent_span_id
|
||||
if parent_span_id and
|
||||
(#parent_span_id ~= 16 or parent_span_id:match("%X")) then
|
||||
core.log.warn("x-b3-parentspanid header invalid; ignoring.")
|
||||
had_invalid_id = true
|
||||
end
|
||||
|
||||
-- Validate request_span_id
|
||||
if request_span_id and
|
||||
(#request_span_id ~= 16 or request_span_id:match("%X")) then
|
||||
core.log.warn("x-b3-spanid header invalid; ignoring.")
|
||||
had_invalid_id = true
|
||||
end
|
||||
|
||||
if trace_id == nil or had_invalid_id then
|
||||
return nil
|
||||
end
|
||||
|
||||
-- Process jaegar baggage header
|
||||
local baggage = {}
|
||||
local headers = core.request.headers(ctx)
|
||||
for k, v in pairs(headers) do
|
||||
local baggage_key = k:match("^uberctx%-(.*)$")
|
||||
if baggage_key then
|
||||
baggage[baggage_key] = ngx.unescape_uri(v)
|
||||
end
|
||||
end
|
||||
|
||||
core.log.info("new span context: trace id: ", trace_id,
|
||||
", span id: ", request_span_id,
|
||||
", parent span id: ", parent_span_id)
|
||||
|
||||
trace_id = from_hex(trace_id)
|
||||
parent_span_id = from_hex(parent_span_id)
|
||||
request_span_id = from_hex(request_span_id)
|
||||
|
||||
return new_span_context(trace_id, request_span_id, parent_span_id,
|
||||
baggage)
|
||||
end
|
||||
end
|
||||
|
||||
local function new_injector()
|
||||
return function(span_context, headers)
|
||||
-- We want to remove headers if already present
|
||||
headers["x-b3-traceid"] = to_hex(span_context.trace_id)
|
||||
headers["x-b3-parentspanid"] = span_context.parent_id
|
||||
and to_hex(span_context.parent_id) or nil
|
||||
headers["x-b3-spanid"] = to_hex(span_context.span_id)
|
||||
headers["x-b3-sampled"] = span_context:get_baggage_item("x-b3-sampled")
|
||||
for key, value in span_context:each_baggage_item() do
|
||||
-- skip x-b3-sampled baggage
|
||||
if key ~= "x-b3-sampled" then
|
||||
-- XXX: https://github.com/opentracing/specification/issues/117
|
||||
headers["uberctx-"..key] = ngx.escape_uri(value)
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
return {
|
||||
new_extractor = new_extractor,
|
||||
new_injector = new_injector,
|
||||
}
|
||||
@@ -0,0 +1,37 @@
|
||||
--
|
||||
-- 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 assert = assert
|
||||
local type = type
|
||||
local setmetatable = setmetatable
|
||||
local math = math
|
||||
|
||||
|
||||
local _M = {}
|
||||
local mt = { __index = _M }
|
||||
|
||||
function _M.new(conf)
|
||||
return setmetatable({}, mt)
|
||||
end
|
||||
|
||||
function _M.sample(self, sample_ratio)
|
||||
assert(type(sample_ratio) == "number" and
|
||||
sample_ratio >= 0 and sample_ratio <= 1, "invalid sample_ratio")
|
||||
return math.random() < sample_ratio
|
||||
end
|
||||
|
||||
|
||||
return _M
|
||||
@@ -0,0 +1,184 @@
|
||||
--
|
||||
-- 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 resty_http = require "resty.http"
|
||||
local to_hex = require "resty.string".to_hex
|
||||
local cjson = require "cjson.safe".new()
|
||||
cjson.encode_number_precision(16)
|
||||
local assert = assert
|
||||
local type = type
|
||||
local setmetatable = setmetatable
|
||||
local math = math
|
||||
local tostring = tostring
|
||||
local batch_processor = require("apisix.utils.batch-processor")
|
||||
local core = require("apisix.core")
|
||||
|
||||
local _M = {}
|
||||
local mt = { __index = _M }
|
||||
|
||||
|
||||
local span_kind_map = {
|
||||
client = "CLIENT",
|
||||
server = "SERVER",
|
||||
producer = "PRODUCER",
|
||||
consumer = "CONSUMER",
|
||||
}
|
||||
|
||||
|
||||
function _M.new(conf)
|
||||
local endpoint = conf.endpoint
|
||||
local service_name = conf.service_name
|
||||
local server_port = conf.server_port
|
||||
local server_addr = conf.server_addr
|
||||
assert(type(endpoint) == "string", "invalid http endpoint")
|
||||
return setmetatable({
|
||||
endpoint = endpoint,
|
||||
service_name = service_name,
|
||||
server_addr = server_addr,
|
||||
server_port = server_port,
|
||||
pending_spans_n = 0,
|
||||
route_id = conf.route_id
|
||||
}, mt)
|
||||
end
|
||||
|
||||
|
||||
function _M.report(self, span)
|
||||
if span:get_baggage_item("x-b3-sampled") == "0" then
|
||||
return
|
||||
end
|
||||
local span_context = span:context()
|
||||
|
||||
local zipkin_tags = {}
|
||||
for k, v in span:each_tag() do
|
||||
-- Zipkin tag values should be strings
|
||||
zipkin_tags[k] = tostring(v)
|
||||
end
|
||||
|
||||
local span_kind = zipkin_tags["span.kind"]
|
||||
zipkin_tags["span.kind"] = nil
|
||||
|
||||
local localEndpoint = {
|
||||
serviceName = self.service_name,
|
||||
ipv4 = self.server_addr,
|
||||
port = self.server_port,
|
||||
-- TODO: ip/port from ngx.var.server_name/ngx.var.server_port?
|
||||
}
|
||||
|
||||
local remoteEndpoint do
|
||||
local peer_port = span:get_tag "peer.port" -- get as number
|
||||
if peer_port then
|
||||
zipkin_tags["peer.port"] = nil
|
||||
remoteEndpoint = {
|
||||
ipv4 = zipkin_tags["peer.ipv4"],
|
||||
-- ipv6 = zipkin_tags["peer.ipv6"],
|
||||
port = peer_port, -- port is *not* optional
|
||||
}
|
||||
zipkin_tags["peer.ipv4"] = nil
|
||||
zipkin_tags["peer.ipv6"] = nil
|
||||
else
|
||||
remoteEndpoint = cjson.null
|
||||
end
|
||||
end
|
||||
|
||||
local zipkin_span = {
|
||||
traceId = to_hex(span_context.trace_id),
|
||||
name = span.name,
|
||||
parentId = span_context.parent_id and
|
||||
to_hex(span_context.parent_id) or nil,
|
||||
id = to_hex(span_context.span_id),
|
||||
kind = span_kind_map[span_kind],
|
||||
timestamp = span.timestamp * 1000000,
|
||||
duration = math.floor(span.duration * 1000000), -- zipkin wants integer
|
||||
-- TODO: debug?
|
||||
localEndpoint = localEndpoint,
|
||||
remoteEndpoint = remoteEndpoint,
|
||||
tags = zipkin_tags,
|
||||
annotations = span.logs
|
||||
}
|
||||
|
||||
self.pending_spans_n = self.pending_spans_n + 1
|
||||
if self.processor then
|
||||
self.processor:push(zipkin_span)
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
local function send_span(pending_spans, report)
|
||||
local httpc = resty_http.new()
|
||||
local res, err = httpc:request_uri(report.endpoint, {
|
||||
method = "POST",
|
||||
headers = {
|
||||
["content-type"] = "application/json",
|
||||
},
|
||||
body = pending_spans,
|
||||
keepalive = 5000,
|
||||
keepalive_pool = 5
|
||||
})
|
||||
|
||||
if not res then
|
||||
-- for zipkin test
|
||||
core.log.error("report zipkin span failed")
|
||||
return nil, "failed: " .. err .. ", url: " .. report.endpoint
|
||||
elseif res.status < 200 or res.status >= 300 then
|
||||
return nil, "failed: " .. report.endpoint .. " "
|
||||
.. res.status .. " " .. res.reason
|
||||
end
|
||||
|
||||
return true
|
||||
end
|
||||
|
||||
|
||||
function _M.init_processor(self)
|
||||
local process_conf = {
|
||||
name = "zipkin_report",
|
||||
retry_delay = 1,
|
||||
batch_max_size = 1000,
|
||||
max_retry_count = 0,
|
||||
buffer_duration = 60,
|
||||
inactive_timeout = 5,
|
||||
route_id = self.route_id,
|
||||
server_addr = self.server_addr,
|
||||
}
|
||||
|
||||
local flush = function (entries, batch_max_size)
|
||||
if not entries then
|
||||
return true
|
||||
end
|
||||
|
||||
local pending_spans, err
|
||||
if batch_max_size == 1 then
|
||||
pending_spans, err = cjson.encode(entries[1])
|
||||
else
|
||||
pending_spans, err = cjson.encode(entries)
|
||||
end
|
||||
|
||||
if not pending_spans then
|
||||
return false, 'error occurred while encoding the data: ' .. err
|
||||
end
|
||||
|
||||
return send_span(pending_spans, self)
|
||||
end
|
||||
|
||||
local processor, err = batch_processor:new(flush, process_conf)
|
||||
if not processor then
|
||||
return false, "create processor error: " .. err
|
||||
end
|
||||
|
||||
self.processor = processor
|
||||
end
|
||||
|
||||
|
||||
return _M
|
||||
Reference in New Issue
Block a user