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/05/16 03:16:18 UTC
[GitHub] [apisix] tzssangglass commented on a diff in pull request #7032: feat(pubsub): support kafka
tzssangglass commented on code in PR #7032:
URL: https://github.com/apache/apisix/pull/7032#discussion_r873291901
##########
docs/en/latest/pubsub/kafka.md:
##########
@@ -0,0 +1,94 @@
+---
+title: Apache Kafka
+keywords:
+ - APISIX
+ - PubSub
+ - Kafka
+description: This document contains information about the Apache APISIX kafka pubsub scenario.
+---
+
+<!--
+#
+# 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.
+#
+-->
+
+## Connect to Apache Kafka
+
+Connecting to Apache Kafka in Apache APISIX is very simple.
+
+Currently we provide a simpler way to integrate by combining two APIs, ListOffsets and Fetch, to quickly implement the ability to pull Kafka messages, but do not support Apache Kafka's consumer group feature for now, and cannot be managed by Kafka for offsets.
Review Comment:
```suggestion
Currently, we provide a simpler way to integrate by combining two APIs, ListOffsets and Fetch, to quickly implement the ability to pull Kafka messages. Still, they do not support Apache Kafka's consumer group feature for now and cannot be managed for offsets by Apache Kafka.
```
##########
apisix/pubsub/kafka.lua:
##########
@@ -0,0 +1,137 @@
+--
+-- 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 bconsumer = require("resty.kafka.basic-consumer")
+local ffi = require("ffi")
+local C = ffi.C
+local tostring = tostring
+local type = type
+local ipairs = ipairs
+local str_sub = string.sub
+
+ffi.cdef[[
+ int64_t atoll(const char *num);
+]]
+
+
+local _M = {}
+
+
+-- Handles the conversion of 64-bit integers in the lua-protobuf.
+--
+-- Because of the limitations of luajit, we cannot use native 64-bit
+-- numbers, so pb decode converts int64 to a string in #xxx format
+-- to avoid loss of precision, by this function, we convert this
+-- string to int64 cdata numbers.
+local function pb_convert_to_int64(src)
+ if type(src) == "string" then
+ -- the format is #1234, so there is a small minimum length of 2
+ if #src < 2 then
+ return 0
+ end
+ return C.atoll(ffi.cast("char *", src) + 1)
+ else
+ return src
+ end
+end
+
+
+-- Takes over requests of type kafka upstream in the http_access phase.
+function _M.access(api_ctx)
+ local pubsub, err = core.pubsub.new()
+ if not pubsub then
+ core.log.error("failed to initialize pubsub module, err: ", err)
+ core.response.exit(400)
Review Comment:
502 is better? Here it looks more like an error related to upstream.
##########
apisix/pubsub/kafka.lua:
##########
@@ -0,0 +1,137 @@
+--
+-- 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 bconsumer = require("resty.kafka.basic-consumer")
+local ffi = require("ffi")
+local C = ffi.C
+local tostring = tostring
+local type = type
+local ipairs = ipairs
+local str_sub = string.sub
+
+ffi.cdef[[
+ int64_t atoll(const char *num);
+]]
+
+
+local _M = {}
+
+
+-- Handles the conversion of 64-bit integers in the lua-protobuf.
+--
+-- Because of the limitations of luajit, we cannot use native 64-bit
+-- numbers, so pb decode converts int64 to a string in #xxx format
+-- to avoid loss of precision, by this function, we convert this
+-- string to int64 cdata numbers.
+local function pb_convert_to_int64(src)
+ if type(src) == "string" then
+ -- the format is #1234, so there is a small minimum length of 2
+ if #src < 2 then
+ return 0
+ end
+ return C.atoll(ffi.cast("char *", src) + 1)
+ else
+ return src
+ end
+end
+
+
+-- Takes over requests of type kafka upstream in the http_access phase.
+function _M.access(api_ctx)
+ local pubsub, err = core.pubsub.new()
+ if not pubsub then
+ core.log.error("failed to initialize pubsub module, err: ", err)
+ core.response.exit(400)
+ return
+ end
+
+ local up_nodes = api_ctx.matched_upstream.nodes
+
+ -- kafka client broker-related configuration
+ local broker_list = {}
+ for i, node in ipairs(up_nodes) do
+ broker_list[i] = {
+ host = node.host,
+ port = node.port,
+ }
+ end
+
+ local client_config = {refresh_interval = 30 * 60 * 1000}
+
+ -- load and create the consumer instance when it is determined
+ -- that the websocket connection was created successfully
+ local consumer = bconsumer:new(broker_list, client_config)
Review Comment:
should we check if `consumer` created success?
##########
apisix/pubsub/kafka.lua:
##########
@@ -0,0 +1,137 @@
+--
+-- 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 bconsumer = require("resty.kafka.basic-consumer")
+local ffi = require("ffi")
+local C = ffi.C
+local tostring = tostring
+local type = type
+local ipairs = ipairs
+local str_sub = string.sub
+
+ffi.cdef[[
+ int64_t atoll(const char *num);
+]]
+
+
+local _M = {}
+
+
+-- Handles the conversion of 64-bit integers in the lua-protobuf.
+--
+-- Because of the limitations of luajit, we cannot use native 64-bit
+-- numbers, so pb decode converts int64 to a string in #xxx format
+-- to avoid loss of precision, by this function, we convert this
+-- string to int64 cdata numbers.
+local function pb_convert_to_int64(src)
+ if type(src) == "string" then
+ -- the format is #1234, so there is a small minimum length of 2
+ if #src < 2 then
+ return 0
+ end
+ return C.atoll(ffi.cast("char *", src) + 1)
+ else
+ return src
+ end
+end
+
+
+-- Takes over requests of type kafka upstream in the http_access phase.
+function _M.access(api_ctx)
+ local pubsub, err = core.pubsub.new()
+ if not pubsub then
+ core.log.error("failed to initialize pubsub module, err: ", err)
+ core.response.exit(400)
+ return
+ end
+
+ local up_nodes = api_ctx.matched_upstream.nodes
+
+ -- kafka client broker-related configuration
+ local broker_list = {}
+ for i, node in ipairs(up_nodes) do
+ broker_list[i] = {
+ host = node.host,
+ port = node.port,
+ }
+ end
+
+ local client_config = {refresh_interval = 30 * 60 * 1000}
Review Comment:
If this is a fixed configuration, can it be placed at module level, otherwise a table will be created every time.
--
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