Skip to content
A simple Kafka producer north plugin for FogLAMP
Branch: develop
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
include
packages/Debian
.gitignore
CMakeLists.txt
Description
FindFogLAMP.cmake
LICENSE
LICENSE.librdkafka
Package
README.rst
VERSION
foglamp.version
kafka.cpp
make_deb
mkversion
plugin.cpp
requirements.sh

README.rst

FogLAMP "Kafka" C++ North Plugin

This is a simple FogLAMP north plugin for sending data to Apache Kafka.

FogLAMP acts as a Kafka producer, sending reading data to Kafka. This implementation is a simplified producer that sends all data on a single Kafka topic. Each message contains an asset name, timestamp and set of readings values as a JSON document.

Copyright

This plugin buils upon the open source librdkafka library and as such portions of ths work are copyright Magnbus Edenhill.

librdkafka - Apache Kafka C driver library

Copyright (c) 2012-2018, Magnus Edenhill All rights reserved.

Build

The plugin is built on top of the librdkafka library. This must be downloaded, built and installed before the plugin can be built.

$ git clone https://github.com/edenhill/librdkafka.git
$ cd librdkafka
$ ./configure
$ make
$ sudo make install

To build FogLAMP "Kafka" C++ north plugin:

$ mkdir build
$ cd build
$ cmake ..
  • By default the FogLAMP develop package header files and libraries are expected to be located in /usr/include/foglamp and /usr/lib/foglamp
  • If FOGLAMP_ROOT env var is set and no -D options are set, the header files and libraries paths are pulled from the ones under the FOGLAMP_ROOT directory. Please note that you must first run 'make' in the FOGLAMP_ROOT directory.

You may also pass one or more of the following options to cmake to override this default behaviour:

  • FOGLAMP_SRC sets the path of a FogLAMP source tree
  • FOGLAMP_INCLUDE sets the path to FogLAMP header files
  • FOGLAMP_LIB sets the path to FogLAMP libraries
  • FOGLAMP_INSTALL sets the installation path of Random plugin
NOTE:
  • The FOGLAMP_INCLUDE option should point to a location where all the FogLAMP header files have been installed in a single directory.
  • The FOGLAMP_LIB option should point to a location where all the FogLAMP libraries have been installed in a single directory.
  • 'make install' target is defined only when FOGLAMP_INSTALL is set

Examples:

  • no options

    $ cmake ..

  • no options and FOGLAMP_ROOT set

    $ export FOGLAMP_ROOT=/some_foglamp_setup

    $ cmake ..

  • set FOGLAMP_SRC

    $ cmake -DFOGLAMP_SRC=/home/source/develop/FogLAMP ..

  • set FOGLAMP_INCLUDE

    $ cmake -DFOGLAMP_INCLUDE=/dev-package/include ..

  • set FOGLAMP_LIB

    $ cmake -DFOGLAMP_LIB=/home/dev/package/lib ..

  • set FOGLAMP_INSTALL

    $ cmake -DFOGLAMP_INSTALL=/home/source/develop/FogLAMP ..

    $ cmake -DFOGLAMP_INSTALL=/usr/local/foglamp ..

Packaging for 'kafka' north

This repo contains the scripts used to create a foglamp-north-kafka Debian package.

The make_deb script

Run the make_deb command after compiling the plugin:

$ ./make_deb help
make_deb [help|clean|cleanall]
This script is used to create the Debian package of FogLAMP C++ 'kafka' north plugin
Arguments:
 help     - Display this help text
 clean    - Remove all the old versions saved in format .XXXX
 cleanall - Remove all the versions, including the last one
$

Building a Package

Finally, run the make_deb command:

$ ./make_deb
The package root directory is   : /home/ubuntu/source/foglamp-north-kafka
The FogLAMP required version    : >=1.4
The package will be built in    : /home/ubuntu/source/foglamp-north-http-kafka/packages/build
The architecture is set as      : x86_64
The package name is             : foglamp-north-kafka-1.0.0-x86_64

Populating the package and updating version file...Done.
Building the new package...
dpkg-deb: building package 'foglamp-north-kafka' in 'foglamp-north-kafka-1.0.0-x86_64.deb'.
Building Complete.
$

Cleaning the Package Folder

Use the clean option to remove all the old packages and the files used to make the package.

Use the cleanall option to remove all the packages and the files used to make the package.

You can’t perform that action at this time.