Jolokiabeat

Welcome to Jolokiabeat.

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

Getting Started with Jolokiabeat

Requirements

Golang 1.6.2

Init Project

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

git remote set-url origin https://github.com/neonmori/jolokiabeat
git push origin master

For further development, check out the beat developer guide.

Build

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

make

Run

To run Jolokiabeat with debugging output enabled, run:

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

Test

To test Jolokiabeat, 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/jolokiabeat.template.json and etc/jolokiabeat.asciidoc

make update

Cleanup

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

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