Name

lua-resty-kafka - Lua kafka client driver for the ngx_lua based on the cosocket API

Table of Contents

• Name
• Status
• Description
• Synopsis
• Modules
  • resty.kafka.produce
    • Methods
      • new
      • add
      • worker
• Installation
• TODO
• Author
• Copyright and License
• See Also

Status

This library is still under early development and is still experimental.

Description

This Lua library is a Kafka client driver for the ngx_lua nginx module:

http://wiki.nginx.org/HttpLuaModule

This Lua library takes advantage of ngx_lua's cosocket API, which ensures 100% nonblocking behavior.

Only LuaJIT supported (--with-luajit).

Synopsis

    server {
        location /test {
            content_by_lua_block {
                requirei "mymodule"("Hello World!")
            }

        }
    }

mymodule.lua

local kafka_produce = require "kafka.produce"

local kafka = kafka_produce.new{
	topic = "test",
	broker_list = {
		{ host = "127.0.0.1", port = 9292 }
	}
}

return function(data)
	kafka:add(data)
end

Back to TOC

Modules

resty.kafka.produce

To load this module, just do this

    local produce = require "resty.kafka.produce"

Back to TOC

Methods

new

`syntax: p = produce.new(config)

Back to TOC

add

syntax: ok, err = p:add(data)

Back to TOC

worker

`syntax: require "resty.kafka.produce".worker(config)

if kafka_queue shm is defined, the worker(s) running this will be responsible for sending data to the kafka server(s)

Back to TOC

Installation

You need to configure the lua_package_path directive to add the path of your lua-resty-kafka source tree to ngx_lua's LUA_PATH search path, as in

    # nginx.conf
    http {
        lua_package_path "/path/to/lua-resty-kafka/lib/?.lua;;";
        ...
    }

Back to TOC

TODO

1. Better documentation

Back to TOC

Author

Bjørnar Ness (bjne) [email protected].

Back to TOC

Copyright and License

This module is licensed under the BSD license.

Copyright (C) 2019-2019, by Bjørnar Ness (bjne) [email protected].

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Back to TOC

See Also

• the ngx_lua module: http://wiki.nginx.org/HttpLuaModule
• the kafka protocol: https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol

Back to TOC