Welcome to Springbeat.
Important Notes:
/metrics
and /health
. We'll add more endpoints as we gospring-boot-starter-actuator
dependency <dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
Ensure that this folder is at the following location:
${GOPATH}/github.com/consulthys
To get running with Springbeat, 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 Springbeat in the git repository, run the following commands:
git remote set-url origin https://github.com/consulthys/springbeat
git push origin master
For further development, check out the beat developer guide.
To build the binary for Springbeat run the command below. This will generate a binary in the same directory with the name springbeat.
make
To run Springbeat with debugging output enabled, run:
./springbeat -c springbeat.yml -e -d "*"
To test Springbeat, 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 Springbeat the requirements are as follows:
export PATH=${PATH}:${GOPATH}/bin
To cross-compile and package Springbeat 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/springbeat.template.json and etc/springbeat.asciidoc
make update
To clean Springbeat source code, run the following commands:
make fmt
make simplify
To clean up the build directory and generated artifacts, run:
make clean
To clone Springbeat from the git repository, run the following commands:
mkdir -p ${GOPATH}/github.com/consulthys
cd ${GOPATH}/github.com/consulthys
git clone https://github.com/consulthys/springbeat
For further development, check out the beat developer guide.