iobeat

README

iobeat

Welcome to iobeat.

This beat collects IO statistics from /proc/diskstats on Linux and ships them to your configured collectors.

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

Getting Started with Iobeat

Requirements

• Golang 1.7

Init Project

To get running with Iobeat and also install the dependencies, run the following command:

make setup

For further development, check out the beat developer guide.

Build

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

make

Run

To run iobeat with debugging output enabled, run:

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

Test

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

make update

Cleanup

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

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

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.