osbeat

Osbeat

Welcome to Osbeat.

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

Getting Started with Osbeat

Requirements

• Golang 1.7

Init Project

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

git remote set-url origin https://github.com/swlee3306/osbeat
git push origin master

For further development, check out the beat developer guide.

Build

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

make

Run

To run Osbeat with debugging output enabled, run:

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

Test

To test Osbeat, 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 etc/fields.yml. To generate etc/osbeat.template.json and etc/osbeat.asciidoc

make update

Cleanup

To clean Osbeat 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 Osbeat from the git repository, run the following commands:

mkdir -p ${GOPATH}/github.com/swlee3306
cd ${GOPATH}/github.com/swlee3306
git clone https://github.com/swlee3306/osbeat

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.

osbeat