Welcome to Davidbeat.
Ensure that this folder is at the following location:
${GOPATH}/github.com/jerrac
To get running with Davidbeat, 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 Davidbeat in the git repository, run the following commands:
git remote set-url origin https://github.com/jerrac/davidbeat
git push origin master
For further development, check out the beat developer guide.
To build the binary for Davidbeat run the command below. This will generate a binary in the same directory with the name davidbeat.
make
To run Davidbeat with debugging output enabled, run:
./davidbeat -c davidbeat.yml -e -d "*"
To test Davidbeat, 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 Davidbeat 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/davidbeat.template.json and etc/davidbeat.asciidoc
make update
To clean Davidbeat source code, run the following commands:
make fmt
make simplify
To clean up the build directory and generated artifacts, run:
make clean
To clone Davidbeat from the git repository, run the following commands:
mkdir -p ${GOPATH}/github.com/jerrac
cd ${GOPATH}/github.com/jerrac
git clone https://github.com/jerrac/davidbeat
For further development, check out the beat developer guide.