Welcome to Kafkabeat.
Ensure that this folder is at the following location:
${GOPATH}/github.com/kafkabeat
To get running with Kafkabeat, run the following command:
make init
To commit the first version before you modify it, run:
make commit
It will create a clean git history for each major step. Note that you can always rewrite the history if you wish before pushing your changes.
To push Kafkabeat in the git repository, run the following commands:
git remote set-url origin https://github.com/gingerwizard/kafkabeat
git push origin master
For further development, check out the beat developer guide.
To build the binary for Kafkabeat run the command below. This will generate a binary in the same directory with the name kafkabeat.
make
To run Kafkabeat with debugging output enabled, run:
./kafkabeat -c kafkabeat.yml -e -d "*"
To test Kafkabeat, run the following command:
make testsuite
alternatively:
make unit-tests
make system-tests
make integration-tests
make coverage-report
The test coverage is reported in the folder ./build/coverage/
To cross-compile and package Kafkabeat for all supported platforms, run the following commands:
cd dev-tools/packer
make deps
make images
make
Each beat has a template for the mapping in elasticsearch and a documentation for the fields
which is automatically generated based on etc/fields.yml.
To generate etc/kafkabeat.template.json and etc/kafkabeat.asciidoc
make update
To clean Kafkabeat source code, run the following commands:
make fmt
make simplify
To clean up the build directory and generated artifacts, run:
make clean
To clone Kafkabeat from the git repository, run the following commands:
mkdir -p ${GOPATH}/github.com/kafkabeat
cd ${GOPATH}/github.com/kafkabeat
git clone https://github.com/npredey/kafkabeat
For further development, check out the beat developer guide.