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