Saltbeat is a forwarder for messages from the salt master event bus to logstash or elasticsearch
Go Makefile Python
Latest commit 3c5b234 Jul 8, 2016 @martinhoefling Initial commit

README.md

Saltbeat

Welcome to Saltbeat.

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

Getting Started with Saltbeat

Requirements

Init Project

To get running with Saltbeat, run the following command:

make init

To commit the first version before you modify it, run:

make commit

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 Saltbeat in the git repository, run the following commands:

git remote set-url origin https://github.com/martinhoefling/saltbeat
git push origin master

For further development, check out the beat developer guide.

Build

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

make

Run

To run Saltbeat with debugging output enabled, run:

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

Test

To test Saltbeat, 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/

Package

To be able to package Saltbeat the requirements are as follows:

  • Docker Environment >= 1.10
  • $GOPATH/bin must be part of $PATH: export PATH=${PATH}:${GOPATH}/bin

To cross-compile and package Saltbeat for all supported platforms, run the following commands:

cd dev-tools/packer
make deps
make images
make

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/saltbeat.template.json and etc/saltbeat.asciidoc

make update

Cleanup

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

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

For further development, check out the beat developer guide.