Introduction 中文

• Kafkabridge is based on the librdkafka under the hook. A mass of details related to how to use has been hidden, that making QBus more simple and easy-to-use than librdkafka. For producing and consuming messages, the only thing need the users to do is to invoke a few APIs, for these they don't need to understand too much about Kafka.
• The reliability of messages producing, that is may be the biggest concerns of the users, has been considerably improved.

Features

• Multiple programming languages are supported, includes C/C++, PHP, Python, Golong, etc, with very consistent APIs.
• Few interfaces, so it is easy to use.
• For advanced users, adapting librdkafka's configration by profiles is also supported.
• In the case of writing data not by keys, the SDK will do the best to guarantee the messages being written successfully .
• Two writing modes, synchronous and asynchronous, are supported.
• As for messages consuming, the offset could be submited automatically, or by manual configurating.
• For the case of using php-fpm, the connection is keeping-alived for reproduce messages uninterruptedly, saving the cost caused by recreating connections.

Compiling

Dependencies: liblog4cplus-1.2.1, boost, swig-3.0.12, cmake

git clone:

git clone --recursive https://github.com/Qihoo360/kafkabridge.git

1. Compile rdkafka

Navigate to the cxx directory and run ./build_librdkafka.sh, you'll get librdkafka.a in thirdparts/librdkafka/src subdirectory.

2. Build SDK

C/C++

C SDK depends on C++ SDK, so you should build C++ SDK first.

Navigate to the cxx directory and run ./build.sh <BUILD_TYPE> (<BUILD_TYPE is debug or release)，you'll get libQBus.so in cxx/lib/<BUILD_TYPE> directory.

Then navigate to the c directory and run ./build.sh <BUILD_TYPE>, you'll get libQBus_C.so in c/lib/<BUILD_TYPE> directory.

Go

Navigate to the golang directory and run build.sh, you'll get qbus.py and libQBus_go.so in gopath/src/qbus subdirectory.

Python

Navigate to the python directory and run ./build.sh, you'll get qbus.py and _qbus.so in the current directory.

The build.sh provides options to specify Python header directory (where Python.h lies) and Python version. Run ./build.sh -h to see usage:

• -s specifies Python header directory, default /usr/local/python2.7/include/python2.7;
• -v specifies Python version, default python2.7.

PHP

Navigate to the php directory and run build.sh, you'll get qbus.so and qbus.php in the current directory.

The build.sh provides options to specify PHP header directory and PHP version. Run ./build.sh -h to see usage:

• -s specifies PHP header directory, default /usr/local/php/include/php;
• -v specifies PHP version (php or php7), default php, which means PHP 5.

3. Build examples

C/C++

Navigate to examples subdirectory and run make to generate executable files, run make clean to delete them.

If you want to build your own programs, see how Makefile does.

Go

Navigate to examples subdirectory and run ./build.sh to generate executable files, run ./clean.sh to delete them.

Add path of libQBus_go.so to env LD_LIBRARY_PATH.

If you want to build your own programs, add generated gopath directory to env GOPATH, or move gopath/src/qbus directory to $GOPATH/src.

Python

Copy generated qbus.py and _qbus.so to the path of the Python scripts to run.

PHP

Edit php.ini and add extension=<module-path>, <module-path> is the path of qbus.so.

Usage

Data Producing

• In the case of writing data not by keys, the SDK will do it's best to submit every single message. As long as there is one broker in the Kafka cluster behaving normally, it will try to resend.
• Writing data only need to invoke the produce interface, and in the asynchronous mode, by checking the return value, you could know whether the sending queue is full or not.
• In the synchronous writing mode, produce interface will return value directively that indicate whether the current message has been written succuessfully. But that is at the expense of some extra performance loss and CPU usage. So asynchronous mode is recommended.
• The following is a C++ example demonstrating how to invoke the produce interface:

bool QbusProducer::init(const string& broker_list,
                        const string& log_path,
                        const string& config_path,
                        const string& topic_name);
bool QbusProducer::produce(const char* data,
                           size_t data_len,
                           const std::string& key);
void QbusProducer::uninit();

• C++ SDK use example:

#include <string>
#include <iostream>
#include "qbus_producer.h"

int main(int argc, const char* argv[]) {
    qbus::QbusProducer qbus_producer;
    if (!qbus_producer.init("127.0.0.1:9092",
                    "./log",
                    "./config",
                    "topic_test")) {
        std::cout << "Failed to init" << std::endl;
        return 0;
    }

    std::string msg("test\n");
    if (!qbus_producer.produce(msg.c_str(), msg.length(), "key")) {
        std::cout << "Failed to produce" << std::endl;
    }

    qbus_producer.uninit();

    return 0;
}

Data Consuming

• Consuming data only need to invoke the subscribeOne to subscribe the 'topic' (also support subscribing multiple topics). The current process is not blocked, every message will send back to the user through the callback.
• The SDK also supports submit offset manually, users can submit the offset in the code of the message body that returned by through callbacks.
• The following is an example of C++, that demonstrate the usage of the consuming interface:

bool QbusConsumer::init(const std::string& broker_list,
                        const std::string& log_path,
                        const std::string& config_path,
                        const QbusConsumerCallback& callback);
bool QbusConsumer::subscribeOne(const std::string& group, const std::string& topic);
bool QbusConsumer::subscribe(const std::string& group,
                             const std::vector<std::string>& topics);
bool QbusConsumer::start();
void QbusConsumer::stop();
bool QbusConsumer::pause(const std::vector<std::string>& topics);
bool QbusConsumer::resume(const std::vector<std::string>& topics);

• C++ SDK use example:

#include <iostream>
#include "qbus_consumer.h"

qbus::QbusConsumer qbus_consumer;
class MyCallback: public qbus::QbusConsumerCallback {
    public:
        virtual void deliveryMsg(const std::string& topic,
                    const char* msg,
                    const size_t msg_len) const {
            std::cout << "topic: " << topic << " | msg: " << std::string(msg, msg_len) << std::endl;
        }

};

int main(int argc, char* argv[]) {
    MyCallback my_callback;
    if (qbus_consumer.init("127.0.0.1:9092",
                    "log",
                    "config",
                    my_callback)) {
        if (qbus_consumer.subscribeOne("groupid_test", "topic_test")) {
            if (!qbus_consumer.start()) {
                std::cout << "Failed to start" << std::endl;
                return NULL;
            }

            while (1) sleep(1);  //other operations can appear here

            qbus_consumer.stop();
        } else {
            std::cout << "Failed subscribe" << std::endl;
        }
    } else {
        std::cout << "Failed init" << std::endl;
    }
    return 0;
}

You can use pause() and resume() methods to pause or resume consuming some topics, see qbus_pause_resume_example.cc

See examples in C examples，C++ examples，Go examples，Python examples，PHP examples for more usage.

CONFIGURATION

kafka configuration