Welcome to Databeat, an elastic beat to gather data from SQL data sources and feed it to elasticsearch.
Ensure that this folder is at the following location:
${GOPATH}/github.com/bhazard/databeat
- Golang 1.7
To get running with Databeat and also install the dependencies, run the following command:
make setup
For further development, check out the beat developer guide.
To build the binary for Databeat run the command below. This will generate a binary in the same directory with the name databeat.
make
To run Databeat with debugging output enabled, run:
./databeat -c databeat.yml -e -d "*"
To test Databeat, 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 etc/fields.yml
.
To generate etc/databeat.template.json and etc/databeat.asciidoc
make update
To clean Databeat source code, run the following commands:
make fmt
To clean up the build directory and generated artifacts, run:
make clean
To clone Databeat from the git repository, run the following commands:
mkdir -p ${GOPATH}/github.com/bhazard/databeat
cd ${GOPATH}/github.com/bhazard/databeat
git clone https://github.com/bhazard/databeat
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 hole process to finish can take several minutes.