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