commandbeat

README

Commandbeat

Welcome to Commandbeat.

For users

Get latest Commandbeat from GitHub releases.
Docker image is also available uphy/commandbeat.

See also https://uphy.github.io/commandbeat/

Commercial Use

Commandbeat is free for commercial use. You can use without any limitation.

For developers

Ensure that this folder is at the following location: ${GOPATH}/src/github.com/uphy/commandbeat

Requirements

• Golang 1.7

Init Project

To get running with Commandbeat 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 Commandbeat in the git repository, run the following commands:

git remote set-url origin https://github.com/uphy/commandbeat
git push origin master

For further development, check out the beat developer guide.

Build

To build the binary for Commandbeat run the command below. This will generate a binary in the same directory with the name commandbeat.

make

Run

To run Commandbeat with debugging output enabled, run:

./commandbeat -c commandbeat.yml -e -d "*"

Test

To test Commandbeat, 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 Commandbeat source code, run the following commands:

make fmt
make simplify

To clean up the build directory and generated artifacts, run:

make clean

Clone

To clone Commandbeat from the git repository, run the following commands:

mkdir -p ${GOPATH}/src/github.com/uphy/commandbeat
git clone https://github.com/uphy/commandbeat ${GOPATH}/src/github.com/uphy/commandbeat

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 package

This will fetch and create all images required for the build process. The hole process to finish can take several minutes.