Switch branches/tags
Nothing to show
Find file History
Pull request Compare This branch is 13 commits ahead of COMU:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
_meta
beater
config
docs
logs
tests/system
vendor/github.com/elastic/beats
.gitignore
.travis.yml
CONTRIBUTING.md
LICENSE
Makefile
README.md
main.go
main_test.go
membeat.full.yml
membeat.template-es2x.json
membeat.template.json
membeat.yml

README.md

Membeat

Welcome to Membeat.

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

Getting Started with Membeat

Requirements

Init Project

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

git remote set-url origin https://github.com/berfinsari/membeat
git push origin master

For further development, check out the beat developer guide.

Build

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

make

Run

To run Membeat with debugging output enabled, run:

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

Test

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

make update

Cleanup

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

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

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.