Welcome to Nutbeat.
Ensure that this folder is at the following location:
${GOPATH}/src/github.com/bpfoster/nutbeat
- Golang 1.7
To get running with Nutbeat 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 Nutbeat in the git repository, run the following commands:
git remote set-url origin https://github.com/bpfoster/nutbeat
git push origin master
For further development, check out the beat developer guide.
To build the binary for Nutbeat run the command below. This will generate a binary in the same directory with the name nutbeat.
make
To run Nutbeat with debugging output enabled, run:
./nutbeat -c nutbeat.yml -e -d "*"
To test Nutbeat, 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/
Each beat has a template for the mapping in elasticsearch and a documentation for the fields
which is automatically generated based on fields.yml by running the following command.
make update
To clean Nutbeat source code, run the following command:
make fmt
To clean up the build directory and generated artifacts, run:
make clean
To clone Nutbeat from the git repository, run the following commands:
mkdir -p ${GOPATH}/src/github.com/bpfoster/nutbeat
git clone https://github.com/bpfoster/nutbeat ${GOPATH}/src/github.com/bpfoster/nutbeat
For further development, check out the beat developer guide.
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 release
This will fetch and create all images required for the build process. The whole process to finish can take several minutes.