zkillbeat

README

Zkillbeat

Welcome to Zkillbeat. This beat pulls the zkillboard redis queue and pushes the result into an elasticsearch cluster. To fetch some additional informations (which region a system belongs to), the crest API is called. This results are cached into a local boltDB file.

Getting Started with Zkillbeat

Ensure that this folder is at the following location: ${GOPATH}/src/github.com/hikhvar

Requirements

• Golang 1.7

Init Project

To get running with Zkillbeat and also install the dependencies, run the following command:

make setup

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 Zkillbeat in the git repository, run the following commands:

git remote set-url origin https://github.com/hikhvar/zkillbeat
git push origin master

For further development, check out the beat developer guide.

Build

To build the binary for Zkillbeat run the command below. This will generate a binary in the same directory with the name zkillbeat.

make

Run

To run Zkillbeat with debugging output enabled, run:

./zkillbeat -c zkillbeat.yml -e -d "*"

Test

To test Zkillbeat, 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/

Update

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/zkillbeat.template.json and etc/zkillbeat.asciidoc

make update

Cleanup

To clean Zkillbeat source code, run the following commands:

make fmt
make simplify

To clean up the build directory and generated artifacts, run:

make clean

Clone

To clone Zkillbeat from the git repository, run the following commands:

mkdir -p ${GOPATH}/github.com/hikhvar
cd ${GOPATH}/github.com/hikhvar
git clone https://github.com/hikhvar/zkillbeat

For further development, check out the beat developer guide.

Packaging

The beat frameworks provides tools to crosscompile and package your beat for different platforms. This requires docker and vendoring as described above. To build packages of your beat, run the following command:

make package

This will fetch and create all images required for the build process. The hole process to finish can take several minutes.