Dockerbeat is an open source project and we love to receive contribution from the community!
You can contribute to Dockerbeat by many ways:
- write documentation, tutorial, blog posts
- submit bug reports, new github issues for bugs or new features
- implement new feature
Dockerbeat is based on the Libbeat, an open source project managed by Elastic.
Dockerbeat development environment is similar to other beats. Please read the official Beats CONTRIBUTING file
Ensure that this folder is at the following location:
${GOPATH}/github.com/ingensi
To build the binary for Dockerbeat run the command below. This will generate a binary in the same directory with the name dockerbeat.
make
To run Dockerbeat with debugging output enabled, run:
./dockerbeat -c dockerbeat.yml -e -d "*"
To test Dockerbeat, 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 Dockerbeat the requirements are as follows:
- Docker Environment >= 1.10
- $GOPATH/bin must be part of $PATH:
export PATH=${PATH}:${GOPATH}/bin
To cross-compile and package Dockerbeat 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/dockerbeat.template.json, etc/dockerbeat.asciidoc and dockerbeat.yml configuration file
make update
To ensure updating dockerbeat-docker.yml
make fullupdate
To clean Dockerbeat source code, run the following commands:
make fmt
make simplify
To clean up the build directory and generated artifacts, run:
make clean
To clone Dockerbeat from the git repository, run the following commands:
mkdir -p ${GOPATH}/github.com/ingensi
cd ${GOPATH}/github.com/ingensi
git clone https://github.com/ingensi/dockerbeat
For further development, check out the beat developer guide.