Welcome to Earthquakebeat.
Ensure that this folder is at the following location:
${GOPATH}/src/github.com/radoondas/earthquakebeat
- Golang 1.12
To clone Earthquakebeat from the git repository, run the following commands:
mkdir -p ${GOPATH}/src/github.com/<github-user>/earthquakebeat
git clone https://github.com/radoondas/earthquakebeat ${GOPATH}/src/github.com/<github-user>/earthquakebeat
To build the binary for Earthquakebeat run the command below. This will generate a binary in the same directory with the name earthquakebeat.
make
To run Earthquakebeat with debugging output enabled, run:
./earthquakebeat -c earthquakebeat.yml -e -d "*"
To test Earthquakebeat, 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 Earthquakebeat source code, run the following commands:
make fmt
make simplify
To clean up the build directory and generated artifacts, run:
make clean
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:
mage package
This will fetch and create all images required for the build process. The whole process to finish can take several minutes.