Welcome to Generatorbeat.
Ensure that this folder is at the following location:
${GOPATH}/github.com/urso
To get running with Generatorbeat, 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 Generatorbeat in the git repository, run the following commands:
git remote set-url origin https://github.com/urso/generatorbeat
git push origin master
For further development, check out the beat developer guide.
To build the binary for Generatorbeat run the command below. This will generate a binary in the same directory with the name generatorbeat.
make
To run Generatorbeat with debugging output enabled, run:
./generatorbeat -c generatorbeat.yml -e -d "*"
To test Generatorbeat, 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 be able to package Generatorbeat the requirements are as follows:
- Docker Environment >= 1.10
- $GOPATH/bin must be part of $PATH:
export PATH=${PATH}:${GOPATH}/bin
To cross-compile and package Generatorbeat 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/generatorbeat.template.json and etc/generatorbeat.asciidoc
make update
To clean Generatorbeat source code, run the following commands:
make fmt
make simplify
To clean up the build directory and generated artifacts, run:
make clean
To clone Generatorbeat from the git repository, run the following commands:
mkdir -p ${GOPATH}/github.com/urso
cd ${GOPATH}/github.com/urso
git clone https://github.com/urso/generatorbeat
For further development, check out the beat developer guide.